Interface GetResourcesRequest.Builder
- All Superinterfaces:
ApiGatewayRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<GetResourcesRequest.Builder,
,GetResourcesRequest> SdkBuilder<GetResourcesRequest.Builder,
,GetResourcesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetResourcesRequest
-
Method Summary
Modifier and TypeMethodDescriptionA query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.embed
(Collection<String> embed) A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.The maximum number of returned results per page.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The current pagination position in the paged result set.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.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
restApiId
The string identifier of the associated RestApi.
- Parameters:
restApiId
- The string identifier of the associated RestApi.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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. Thisembed
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
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. Thisembed
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-