software.amazon.awssdk.services.apigateway.model

Interface GetResourceRequest.Builder

All Superinterfaces:

ApiGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<GetResourceRequest.Builder,GetResourceRequest>, SdkBuilder<GetResourceRequest.Builder,GetResourceRequest>, SdkRequest.Builder

Enclosing class:

GetResourceRequest

public static interface GetResourceRequest.Builder
extends ApiGatewayRequest.Builder, CopyableBuilder<GetResourceRequest.Builder,GetResourceRequest>

Method Summary

Modifier and Type	Method and Description
GetResourceRequest.Builder	embed(Collection<String> embed) A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response.
GetResourceRequest.Builder	embed(String... embed) A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response.
GetResourceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetResourceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetResourceRequest.Builder	resourceId(String resourceId) The identifier for the Resource resource.
GetResourceRequest.Builder	restApiId(String restApiId) 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

Method Detail

restApiId

GetResourceRequest.Builder restApiId(String 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.

resourceId

GetResourceRequest.Builder resourceId(String resourceId)

The identifier for the Resource resource.

Parameters:

resourceId - The identifier for the Resource resource.

Returns:

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

embed

GetResourceRequest.Builder embed(Collection<String> embed)

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Parameters:

embed - A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Returns:

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

embed

GetResourceRequest.Builder embed(String... embed)

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Parameters:

embed - A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Returns:

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

overrideConfiguration

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

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