software.amazon.awssdk.services.apigateway.model

Interface GetUsageRequest.Builder

All Superinterfaces:

ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<GetUsageRequest.Builder,GetUsageRequest>, SdkBuilder<GetUsageRequest.Builder,GetUsageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetUsageRequest

public static interface GetUsageRequest.Builder
extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<GetUsageRequest.Builder,GetUsageRequest>

Method Summary

Modifier and Type	Method and Description
GetUsageRequest.Builder	endDate(String endDate) [Required] The ending date (e.g., 2016-12-31) of the usage data.
GetUsageRequest.Builder	keyId(String keyId) The Id of the API key associated with the resultant usage data.
GetUsageRequest.Builder	limit(Integer limit) The maximum number of returned results per page.
GetUsageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetUsageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetUsageRequest.Builder	position(String position) The current pagination position in the paged result set.
GetUsageRequest.Builder	startDate(String startDate) [Required] The starting date (e.g., 2016-01-01) of the usage data.
GetUsageRequest.Builder	usagePlanId(String usagePlanId) [Required] The Id of the usage plan associated with the usage data.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

usagePlanId

GetUsageRequest.Builder usagePlanId(String usagePlanId)

[Required] The Id of the usage plan associated with the usage data.

Parameters:

usagePlanId - [Required] The Id of the usage plan associated with the usage data.

Returns:

Returns a reference to this object so that method calls can be chained together.

keyId

GetUsageRequest.Builder keyId(String keyId)

The Id of the API key associated with the resultant usage data.

Parameters:

keyId - The Id of the API key associated with the resultant usage data.

Returns:

Returns a reference to this object so that method calls can be chained together.

startDate

GetUsageRequest.Builder startDate(String startDate)

[Required] The starting date (e.g., 2016-01-01) of the usage data.

Parameters:

startDate - [Required] The starting date (e.g., 2016-01-01) of the usage data.

Returns:

Returns a reference to this object so that method calls can be chained together.

endDate

GetUsageRequest.Builder endDate(String endDate)

[Required] The ending date (e.g., 2016-12-31) of the usage data.

Parameters:

endDate - [Required] The ending date (e.g., 2016-12-31) of the usage data.

Returns:

Returns a reference to this object so that method calls can be chained together.

position

GetUsageRequest.Builder position(String position)

The current pagination position in the paged result set.

Parameters:

position - The current pagination position in the paged result set.

Returns:

Returns a reference to this object so that method calls can be chained together.

limit

GetUsageRequest.Builder limit(Integer limit)

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Parameters:

limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

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

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