JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.apigateway.model

Class GetRestApiResult

    • Constructor Detail

      • GetRestApiResult

        public GetRestApiResult()
    • Method Detail

      • setId

        public void setId(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.
      • getId

        public String getId()

        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.
      • withId

        public GetRestApiResult withId(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.
      • setName

        public void setName(String name)

        The API's name.

        Parameters:
        name - The API's name.
      • getName

        public String getName()

        The API's name.

        Returns:
        The API's name.
      • withName

        public GetRestApiResult withName(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.
      • setDescription

        public void setDescription(String description)

        The API's description.

        Parameters:
        description - The API's description.
      • getDescription

        public String getDescription()

        The API's description.

        Returns:
        The API's description.
      • withDescription

        public GetRestApiResult withDescription(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.
      • setCreatedDate

        public void setCreatedDate(Date createdDate)

        The timestamp when the API was created.

        Parameters:
        createdDate - The timestamp when the API was created.
      • getCreatedDate

        public Date getCreatedDate()

        The timestamp when the API was created.

        Returns:
        The timestamp when the API was created.
      • withCreatedDate

        public GetRestApiResult withCreatedDate(Date 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.
      • setVersion

        public void setVersion(String version)

        A version identifier for the API.

        Parameters:
        version - A version identifier for the API.
      • getVersion

        public String getVersion()

        A version identifier for the API.

        Returns:
        A version identifier for the API.
      • withVersion

        public GetRestApiResult withVersion(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.
      • getWarnings

        public List<String> getWarnings()

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

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

        public void setWarnings(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.
      • withWarnings

        public GetRestApiResult withWarnings(String... warnings)

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

        NOTE: This method appends the values to the existing list (if any). Use setWarnings(java.util.Collection) or withWarnings(java.util.Collection) if you want to override the existing values.

        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.
      • withWarnings

        public GetRestApiResult withWarnings(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.
      • getBinaryMediaTypes

        public List<String> getBinaryMediaTypes()

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

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

        public void setBinaryMediaTypes(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.
      • withBinaryMediaTypes

        public GetRestApiResult withBinaryMediaTypes(String... binaryMediaTypes)

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

        NOTE: This method appends the values to the existing list (if any). Use setBinaryMediaTypes(java.util.Collection) or withBinaryMediaTypes(java.util.Collection) if you want to override the existing values.

        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.
      • withBinaryMediaTypes

        public GetRestApiResult withBinaryMediaTypes(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.
      • setMinimumCompressionSize

        public void setMinimumCompressionSize(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.
      • getMinimumCompressionSize

        public Integer getMinimumCompressionSize()

        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.
      • withMinimumCompressionSize

        public GetRestApiResult withMinimumCompressionSize(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.
      • setApiKeySource

        public void setApiKeySource(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.
        See Also:
        ApiKeySourceType
      • getApiKeySource

        public String getApiKeySource()

        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:
        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
      • withApiKeySource

        public GetRestApiResult withApiKeySource(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
      • withApiKeySource

        public GetRestApiResult withApiKeySource(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
      • setEndpointConfiguration

        public void setEndpointConfiguration(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.
      • getEndpointConfiguration

        public EndpointConfiguration getEndpointConfiguration()

        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.
      • withEndpointConfiguration

        public GetRestApiResult withEndpointConfiguration(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.
      • setPolicy

        public void setPolicy(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.
      • getPolicy

        public String getPolicy()

        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.
      • withPolicy

        public GetRestApiResult withPolicy(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.
      • getTags

        public Map<String,String> getTags()

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

        Returns:
        The collection of tags. Each tag element is associated with a given resource.
      • setTags

        public void setTags(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.
      • withTags

        public GetRestApiResult withTags(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.
      • clearTagsEntries

        public GetRestApiResult clearTagsEntries()
        Removes all the entries added into Tags.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDisableExecuteApiEndpoint

        public void setDisableExecuteApiEndpoint(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.
      • getDisableExecuteApiEndpoint

        public Boolean getDisableExecuteApiEndpoint()

        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.
      • withDisableExecuteApiEndpoint

        public GetRestApiResult withDisableExecuteApiEndpoint(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.
      • isDisableExecuteApiEndpoint

        public Boolean isDisableExecuteApiEndpoint()

        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.
      • setRootResourceId

        public void setRootResourceId(String rootResourceId)

        The API's root resource ID.

        Parameters:
        rootResourceId - The API's root resource ID.
      • getRootResourceId

        public String getRootResourceId()

        The API's root resource ID.

        Returns:
        The API's root resource ID.
      • withRootResourceId

        public GetRestApiResult withRootResourceId(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.
      • toString

        public 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
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /