Class AwsApiGatewayRestApiDetails

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

Contains information about a REST API in version 1 of Amazon API Gateway.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the REST API.

      Returns:
      The identifier of the REST API.

    • name

      public final String name()

      The name of the REST API.

      Returns:
      The name of the REST API.

    • description

      public final String description()

      A description of the REST API.

      Returns:
      A description of the REST API.

    • createdDate

      public final String createdDate()

      Indicates when the API was created.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Returns:
      Indicates when the API was created.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

    • version

      public final String version()

      The version identifier for the REST API.

      Returns:
      The version identifier for the REST API.

    • hasBinaryMediaTypes

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

    • binaryMediaTypes

      public final List<String> binaryMediaTypes()

      The list of binary media types supported by the REST API.

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

      Returns:
      The list of binary media types supported by the REST API.

    • minimumCompressionSize

      public final Integer minimumCompressionSize()

      The minimum size in bytes of a payload before compression is enabled.

      If null, then compression is disabled.

      If 0, then all payloads are compressed.

      Returns:
      The minimum size in bytes of a payload before compression is enabled.

      If null, then compression is disabled.

      If 0, then all payloads are compressed.

    • apiKeySource

      public final String apiKeySource()

      The source of the API key for metering requests according to a usage plan.

      HEADER indicates whether to read the API key from the X-API-Key header of a request.

      AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

      Returns:
      The source of the API key for metering requests according to a usage plan.

      HEADER indicates whether to read the API key from the X-API-Key header of a request.

      AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

    • endpointConfiguration

      public final AwsApiGatewayEndpointConfiguration endpointConfiguration()

      The endpoint configuration of the REST API.

      Returns:
      The endpoint configuration of the REST API.

    • toBuilder

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

    • builder

      public static AwsApiGatewayRestApiDetails.Builder builder()

    • serializableBuilderClass

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