Package software.amazon.awssdk.services.apigateway.model

Interface GetResourcesRequest.Builder

All Superinterfaces:

CopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>, SdkBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

Enclosing class:

GetResourcesRequest

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

Method Summary

Modifier and Type	Method	Description
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	embed(Collection<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	position(String position)	The current pagination position in the paged result set.
GetResourcesRequest.Builder	restApiId(String restApiId)	The RestApi identifier for the Resource.

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

copy

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

apply, build

Method Detail

restApiId

GetResourcesRequest.Builder restApiId(String restApiId)

The RestApi identifier for the Resource.

Parameters:

restApiId - The RestApi identifier for the Resource.

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 value is 25 by default and could be between 1 - 500.

Parameters:

limit - The maximum number of returned results per page. The value is 25 by default and could be between 1 - 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.

NOTE: This method appends the values to the existing list (if any). Use #setEmbed(java.util.Collection) or #withEmbed(java.util.Collection) if you want to override the existing values.

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.