Package software.amazon.awssdk.services.apigateway.model

Class PutRestApiResponse

    • Method Detail

      • id

        public final String id()

        The API's identifier. This identifier is unique across all of your APIs in API Gateway.

        Returns:
        The API's identifier. This identifier is unique across all of your APIs in API Gateway.

      • name

        public final String name()

        The API's name.

        Returns:
        The API's name.

      • description

        public final String description()

        The API's description.

        Returns:
        The API's description.

      • createdDate

        public final Instant createdDate()

        The timestamp when the API was created.

        Returns:
        The timestamp when the API was created.

      • version

        public final String version()

        A version identifier for the API.

        Returns:
        A version identifier for the API.

      • hasWarnings

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

      • warnings

        public final List<String> warnings()

        The warning messages reported when failonwarnings is turned on during API import.

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

        Returns:
        The warning messages reported when failonwarnings is turned on during API import.

      • 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 RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

        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 RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

      • minimumCompressionSize

        public final Integer minimumCompressionSize()

        A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

        Returns:
        A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

      • apiKeySource

        public final ApiKeySourceType apiKeySource()

        The source of the API key for metering requests according to a usage plan. Valid values are: > HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

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

        Returns:
        The source of the API key for metering requests according to a usage plan. Valid values are: > HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
        See Also:
        ApiKeySourceType

      • apiKeySourceAsString

        public final String apiKeySourceAsString()

        The source of the API key for metering requests according to a usage plan. Valid values are: > HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

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

        Returns:
        The source of the API key for metering requests according to a usage plan. Valid values are: > HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
        See Also:
        ApiKeySourceType

      • endpointConfiguration

        public final EndpointConfiguration endpointConfiguration()

        The endpoint configuration of this RestApi showing the endpoint types of the API.

        Returns:
        The endpoint configuration of this RestApi showing the endpoint types of the API.

      • policy

        public final String policy()

        A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

        Returns:
        A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

      • 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()

        The collection of tags. Each tag element is associated with a given resource.

        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 collection of tags. Each tag element is associated with a given resource.

      • disableExecuteApiEndpoint

        public final Boolean disableExecuteApiEndpoint()

        Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

        Returns:
        Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

      • rootResourceId

        public final String rootResourceId()

        The API's root resource ID.

        Returns:
        The API's root resource ID.

      • 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