Class CreateProductResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateProductResponse.Builder,CreateProductResponse>

@Generated("software.amazon.awssdk:codegen") public final class CreateProductResponse extends ApiPortalResponse implements ToCopyableBuilder<CreateProductResponse.Builder,CreateProductResponse>
  • Method Details

    • productId

      public final String productId()

      The identifier of the product.

      Returns:
      The identifier of the product.
    • productArn

      public final String productArn()

      The ARN of the product.

      Returns:
      The ARN of the product.
    • displayName

      public final String displayName()

      The name of the product, from 1 to 255 characters.

      Returns:
      The name of the product, from 1 to 255 characters.
    • displayOrder

      public final DisplayOrder displayOrder()

      The order of the product's pages and API page sections in the portal navigation.

      Returns:
      The order of the product's pages and API page sections in the portal navigation.
    • description

      public final String description()

      A description of the product, up to 1024 characters.

      Returns:
      A description of the product, up to 1024 characters.
    • updatedAt

      public final Instant updatedAt()

      When the resource was last updated.

      Returns:
      When the resource was last updated.
    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.
    • tags

      public final Map<String,String> tags()
      Returns the value of the Tags property for this object.

      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 hasTags() method.

      Returns:
      The value of the Tags property for this object.
    • apiSelectionConfiguration

      public final ApiSelectionConfiguration apiSelectionConfiguration()

      How Managed APIs are selected for the product.

      Returns:
      How Managed APIs are selected for the product.
    • status

      public final ProductStatus status()
      Returns the value of the Status property for this object.

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

      Returns:
      The value of the Status property for this object.
      See Also:
    • statusAsString

      public final String statusAsString()
      Returns the value of the Status property for this object.

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

      Returns:
      The value of the Status property for this object.
      See Also:
    • failureReason

      public final ProductFailureReason failureReason()
      Returns the value of the FailureReason property for this object.

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

      Returns:
      The value of the FailureReason property for this object.
      See Also:
    • failureReasonAsString

      public final String failureReasonAsString()
      Returns the value of the FailureReason property for this object.

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

      Returns:
      The value of the FailureReason property for this object.
      See Also:
    • toBuilder

      public CreateProductResponse.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<CreateProductResponse.Builder,CreateProductResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

      public static CreateProductResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CreateProductResponse.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse
    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.