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

Interface UsagePlan.Builder

    • Method Detail

      • id

        UsagePlan.Builder id​(String id)

        The identifier of a UsagePlan resource.

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

      • name

        UsagePlan.Builder name​(String name)

        The name of a usage plan.

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

      • description

        UsagePlan.Builder description​(String description)

        The description of a usage plan.

        Parameters:
        description - The description of a usage plan.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • apiStages

        UsagePlan.Builder apiStages​(Collection<ApiStage> apiStages)

        The associated API stages of a usage plan.

        Parameters:
        apiStages - The associated API stages of a usage plan.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • apiStages

        UsagePlan.Builder apiStages​(ApiStage... apiStages)

        The associated API stages of a usage plan.

        Parameters:
        apiStages - The associated API stages of a usage plan.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • apiStages

        UsagePlan.Builder apiStages​(Consumer<ApiStage.Builder>... apiStages)

        The associated API stages of a usage plan.

        This is a convenience method that creates an instance of the ApiStage.Builder avoiding the need to create one manually via ApiStage.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #apiStages(List).

        Parameters:
        apiStages - a consumer that will call methods on ApiStage.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #apiStages(java.util.Collection)

      • throttle

        UsagePlan.Builder throttle​(ThrottleSettings throttle)

        A map containing method level throttling information for API stage in a usage plan.

        Parameters:
        throttle - A map containing method level throttling information for API stage in a usage plan.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • quota

        UsagePlan.Builder quota​(QuotaSettings quota)

        The target maximum number of permitted requests per a given unit time interval.

        Parameters:
        quota - The target maximum number of permitted requests per a given unit time interval.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • productCode

        UsagePlan.Builder productCode​(String productCode)

        The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

        Parameters:
        productCode - The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        UsagePlan.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.