Package software.amazon.awssdk.services.securityhub.model

Interface AwsApiGatewayRestApiDetails.Builder

    • Method Detail

      • id

        AwsApiGatewayRestApiDetails.Builder id​(String id)

        The identifier of the REST API.

        Parameters:
        id - The identifier of the REST API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        AwsApiGatewayRestApiDetails.Builder name​(String name)

        The name of the REST API.

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

      • description

        AwsApiGatewayRestApiDetails.Builder description​(String description)

        A description of the REST API.

        Parameters:
        description - A description of the REST API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdDate

        AwsApiGatewayRestApiDetails.Builder createdDate​(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)

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

      • version

        AwsApiGatewayRestApiDetails.Builder version​(String version)

        The version identifier for the REST API.

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

      • binaryMediaTypes

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

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

        Parameters:
        binaryMediaTypes - The list of binary media types supported by the REST API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • binaryMediaTypes

        AwsApiGatewayRestApiDetails.Builder binaryMediaTypes​(String... binaryMediaTypes)

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

        Parameters:
        binaryMediaTypes - The list of binary media types supported by the REST API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • minimumCompressionSize

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

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

      • apiKeySource

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

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

      • endpointConfiguration

        AwsApiGatewayRestApiDetails.Builder endpointConfiguration​(AwsApiGatewayEndpointConfiguration endpointConfiguration)

        The endpoint configuration of the REST API.

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