Class ApiGatewayApiAsset

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

The API Gateway API that is the asset.

See Also:

  • Method Details

    • apiDescription

      public final String apiDescription()

      The API description of the API asset.

      Returns:
      The API description of the API asset.

    • apiEndpoint

      public final String apiEndpoint()

      The API endpoint of the API asset.

      Returns:
      The API endpoint of the API asset.

    • apiId

      public final String apiId()

      The unique identifier of the API asset.

      Returns:
      The unique identifier of the API asset.

    • apiKey

      public final String apiKey()

      The API key of the API asset.

      Returns:
      The API key of the API asset.

    • apiName

      public final String apiName()

      The API name of the API asset.

      Returns:
      The API name of the API asset.

    • apiSpecificationDownloadUrl

      public final String apiSpecificationDownloadUrl()

      The download URL of the API specification of the API asset.

      Returns:
      The download URL of the API specification of the API asset.

    • apiSpecificationDownloadUrlExpiresAt

      public final Instant apiSpecificationDownloadUrlExpiresAt()

      The date and time that the upload URL expires, in ISO 8601 format.

      Returns:
      The date and time that the upload URL expires, in ISO 8601 format.

    • protocolType

      public final ProtocolType protocolType()

      The protocol type of the API asset.

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

      Returns:
      The protocol type of the API asset.
      See Also:

    • protocolTypeAsString

      public final String protocolTypeAsString()

      The protocol type of the API asset.

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

      Returns:
      The protocol type of the API asset.
      See Also:

    • stage

      public final String stage()

      The stage of the API asset.

      Returns:
      The stage of the API asset.

    • toBuilder

      public ApiGatewayApiAsset.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<ApiGatewayApiAsset.Builder,ApiGatewayApiAsset>
      Returns:
      a builder for type T

    • builder

      public static ApiGatewayApiAsset.Builder builder()

    • serializableBuilderClass

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