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

Interface GetRestApiResponse.Builder

    • Method Detail

      • id

        GetRestApiResponse.Builder id​(String id)

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

        Parameters:
        id - The API's identifier. This identifier is unique across all of your APIs in API Gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        GetRestApiResponse.Builder name​(String name)

        The API's name.

        Parameters:
        name - The API's name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        GetRestApiResponse.Builder description​(String description)

        The API's description.

        Parameters:
        description - The API's description.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdDate

        GetRestApiResponse.Builder createdDate​(Instant createdDate)

        The timestamp when the API was created.

        Parameters:
        createdDate - The timestamp when the API was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • version

        GetRestApiResponse.Builder version​(String version)

        A version identifier for the API.

        Parameters:
        version - A version identifier for the API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • warnings

        GetRestApiResponse.Builder warnings​(Collection<String> warnings)

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

        Parameters:
        warnings - The warning messages reported when failonwarnings is turned on during API import.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • warnings

        GetRestApiResponse.Builder warnings​(String... warnings)

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

        Parameters:
        warnings - The warning messages reported when failonwarnings is turned on during API import.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • binaryMediaTypes

        GetRestApiResponse.Builder binaryMediaTypes​(Collection<String> binaryMediaTypes)

        The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

        Parameters:
        binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • binaryMediaTypes

        GetRestApiResponse.Builder binaryMediaTypes​(String... binaryMediaTypes)

        The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

        Parameters:
        binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • minimumCompressionSize

        GetRestApiResponse.Builder minimumCompressionSize​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • apiKeySource

        GetRestApiResponse.Builder apiKeySource​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ApiKeySourceType, ApiKeySourceType

      • apiKeySource

        GetRestApiResponse.Builder apiKeySource​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ApiKeySourceType, ApiKeySourceType

      • endpointConfiguration

        GetRestApiResponse.Builder endpointConfiguration​(EndpointConfiguration endpointConfiguration)

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

        Parameters:
        endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • policy

        GetRestApiResponse.Builder policy​(String policy)

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

        Parameters:
        policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        GetRestApiResponse.Builder tags​(Map<String,​String> tags)

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

        Parameters:
        tags - The collection of tags. Each tag element is associated with a given resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • disableExecuteApiEndpoint

        GetRestApiResponse.Builder disableExecuteApiEndpoint​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • rootResourceId

        GetRestApiResponse.Builder rootResourceId​(String rootResourceId)

        The API's root resource ID.

        Parameters:
        rootResourceId - The API's root resource ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.