Interface CreateGatewayRateLimitRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreControlRequest.Builder, Buildable, CopyableBuilder<CreateGatewayRateLimitRequest.Builder,CreateGatewayRateLimitRequest>, SdkBuilder<CreateGatewayRateLimitRequest.Builder,CreateGatewayRateLimitRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateGatewayRateLimitRequest
@Mutable @NotThreadSafe public static interface CreateGatewayRateLimitRequest.Builder extends BedrockAgentCoreControlRequest.Builder, SdkPojo, CopyableBuilder<CreateGatewayRateLimitRequest.Builder,CreateGatewayRateLimitRequest>

  • Method Details

    • gatewayIdentifier

      CreateGatewayRateLimitRequest.Builder gatewayIdentifier(String gatewayIdentifier)

      The unique identifier of the gateway to create the rate limit for.

      Parameters:
      gatewayIdentifier - The unique identifier of the gateway to create the rate limit for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateGatewayRateLimitRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rateLimitId

      CreateGatewayRateLimitRequest.Builder rateLimitId(String rateLimitId)

      An optional customer-defined identifier for the rate limit. If not provided, the system generates one.

      Parameters:
      rateLimitId - An optional customer-defined identifier for the rate limit. If not provided, the system generates one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateGatewayRateLimitRequest.Builder description(String description)

      An optional human-readable description for this rate limit. If not provided, the rate limit is created without a description.

      Parameters:
      description - An optional human-readable description for this rate limit. If not provided, the rate limit is created without a description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensionKeys

      CreateGatewayRateLimitRequest.Builder dimensionKeys(Collection<String> dimensionKeys)

      The ordered list of dimension key names that define the scope of this rate limit. Must be unique per gateway—no two rate limits can share the same dimension keys.

      Parameters:
      dimensionKeys - The ordered list of dimension key names that define the scope of this rate limit. Must be unique per gateway—no two rate limits can share the same dimension keys.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensionKeys

      CreateGatewayRateLimitRequest.Builder dimensionKeys(String... dimensionKeys)

      The ordered list of dimension key names that define the scope of this rate limit. Must be unique per gateway—no two rate limits can share the same dimension keys.

      Parameters:
      dimensionKeys - The ordered list of dimension key names that define the scope of this rate limit. Must be unique per gateway—no two rate limits can share the same dimension keys.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entries

      CreateGatewayRateLimitRequest.Builder entries(Collection<LimitEntry> entries)

      The rule entries that map dimension values to rate configurations.

      Parameters:
      entries - The rule entries that map dimension values to rate configurations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entries

      CreateGatewayRateLimitRequest.Builder entries(LimitEntry... entries)

      The rule entries that map dimension values to rate configurations.

      Parameters:
      entries - The rule entries that map dimension values to rate configurations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entries

      CreateGatewayRateLimitRequest.Builder entries(Consumer<LimitEntry.Builder>... entries)

      The rule entries that map dimension values to rate configurations.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to entries(List<LimitEntry>).

      Parameters:
      entries - a consumer that will call methods on LimitEntry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateGatewayRateLimitRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateGatewayRateLimitRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.