Class ApiFulfillmentOption

java.lang.Object
software.amazon.awssdk.services.marketplacediscovery.model.ApiFulfillmentOption
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ApiFulfillmentOption.Builder,ApiFulfillmentOption>
@Generated("software.amazon.awssdk:codegen") public final class ApiFulfillmentOption extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApiFulfillmentOption.Builder,ApiFulfillmentOption>

Describes an API-based fulfillment option, where the product is accessed through an API integration.

See Also:

  • Method Details

    • fulfillmentOptionId

      public final String fulfillmentOptionId()

      The unique identifier of the fulfillment option.

      Returns:
      The unique identifier of the fulfillment option.

    • fulfillmentOptionType

      public final FulfillmentOptionType fulfillmentOptionType()

      The category of the fulfillment option.

      If the service returns an enum value that is not available in the current SDK version, fulfillmentOptionType will return FulfillmentOptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fulfillmentOptionTypeAsString().

      Returns:
      The category of the fulfillment option.
      See Also:

    • fulfillmentOptionTypeAsString

      public final String fulfillmentOptionTypeAsString()

      The category of the fulfillment option.

      If the service returns an enum value that is not available in the current SDK version, fulfillmentOptionType will return FulfillmentOptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fulfillmentOptionTypeAsString().

      Returns:
      The category of the fulfillment option.
      See Also:

    • fulfillmentOptionDisplayName

      public final String fulfillmentOptionDisplayName()

      A human-readable name for the fulfillment option type.

      Returns:
      A human-readable name for the fulfillment option type.

    • usageInstructions

      public final String usageInstructions()

      Instructions on how to integrate with and use this API.

      Returns:
      Instructions on how to integrate with and use this API.

    • hasAwsSupportedServices

      public final boolean hasAwsSupportedServices()
      For responses, this returns true if the service returned a value for the AwsSupportedServices property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • awsSupportedServices

      public final List<AwsSupportedService> awsSupportedServices()

      The AWS services supported by this API integration.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAwsSupportedServices() method.

      Returns:
      The AWS services supported by this API integration.

    • toBuilder

      public ApiFulfillmentOption.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ApiFulfillmentOption.Builder,ApiFulfillmentOption>
      Returns:
      a builder for type T

    • builder

      public static ApiFulfillmentOption.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ApiFulfillmentOption.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.