software.amazon.awssdk.services.apigateway.model

Interface GetResourcesRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetResourcesRequest

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

Method Summary

Modifier and Type	Method and Description
GetResourcesRequest.Builder	embed(Collection<String> embed) A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
GetResourcesRequest.Builder	embed(String... embed) A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
GetResourcesRequest.Builder	limit(Integer limit) The maximum number of returned results per page.
GetResourcesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetResourcesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetResourcesRequest.Builder	position(String position) The current pagination position in the paged result set.
GetResourcesRequest.Builder	restApiId(String restApiId) [Required] The string identifier of the associated RestApi.

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

restApiId

GetResourcesRequest.Builder restApiId(String restApiId)

[Required] The string identifier of the associated RestApi.

Parameters:

restApiId - [Required] The string identifier of the associated RestApi.

Returns:

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

position

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

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

embed

GetResourcesRequest.Builder embed(Collection<String> embed)

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Parameters:

embed - A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Returns:

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

embed

GetResourcesRequest.Builder embed(String... embed)

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Parameters:

embed - A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Returns:

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

overrideConfiguration

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

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