Class ProductApiPageSummaryNoBody

java.lang.Object
software.amazon.awssdk.services.apiportal.model.ProductApiPageSummaryNoBody
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProductApiPageSummaryNoBody.Builder,ProductApiPageSummaryNoBody>

@Generated("software.amazon.awssdk:codegen") public final class ProductApiPageSummaryNoBody extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProductApiPageSummaryNoBody.Builder,ProductApiPageSummaryNoBody>

A summary of an API page, without its body.

See Also:
  • Method Details

    • productApiPageId

      public final String productApiPageId()

      The identifier of the API page.

      Returns:
      The identifier of the API page.
    • productApiPageArn

      public final String productApiPageArn()

      The ARN of the API page.

      Returns:
      The ARN of the API page.
    • apiId

      public final ApiId apiId()

      The API the page documents.

      Returns:
      The API the page documents.
    • operationName

      public final String operationName()

      The operation name shown as the page title.

      Returns:
      The operation name shown as the page title.
    • apiUrl

      public final String apiUrl()

      The invoke URL shown on the page and used by Try-It.

      Returns:
      The invoke URL shown on the page and used by Try-It.
    • tryItState

      public final TryItState tryItState()

      Whether Try-It is enabled on the page.

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

      Returns:
      Whether Try-It is enabled on the page.
      See Also:
    • tryItStateAsString

      public final String tryItStateAsString()

      Whether Try-It is enabled on the page.

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

      Returns:
      Whether Try-It is enabled on the page.
      See Also:
    • updatedAt

      public final Instant updatedAt()

      When the resource was last updated.

      Returns:
      When the resource was last updated.
    • status

      public final Status status()

      The status of the page content: IN_PROGRESS while it is generated, then AVAILABLE or FAILED.

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

      Returns:
      The status of the page content: IN_PROGRESS while it is generated, then AVAILABLE or FAILED.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the page content: IN_PROGRESS while it is generated, then AVAILABLE or FAILED.

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

      Returns:
      The status of the page content: IN_PROGRESS while it is generated, then AVAILABLE or FAILED.
      See Also:
    • statusException

      public final ProductApiPageStatusException statusException()
      Returns the value of the StatusException property for this object.
      Returns:
      The value of the StatusException property for this object.
    • 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<ProductApiPageSummaryNoBody.Builder,ProductApiPageSummaryNoBody>
      Returns:
      a builder for type T
    • builder

      public static ProductApiPageSummaryNoBody.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ProductApiPageSummaryNoBody.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.