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

Class GetResourcesRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.GetResourcesRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

@Generated("software.amazon.awssdk:codegen")
public class GetResourcesRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

Request to list information about a collection of resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetResourcesRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GetResourcesRequest.Builder	builder()
List<String>	embed()	A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
boolean	equals(Object obj)
int	hashCode()
Integer	limit()	The maximum number of returned results per page.
String	position()	The current pagination position in the paged result set.
String	restApiId()	The RestApi identifier for the Resource.
static Class<? extends GetResourcesRequest.Builder>	serializableBuilderClass()
GetResourcesRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

restApiId

public String restApiId()

The RestApi identifier for the Resource.

Returns:

The RestApi identifier for the Resource.

position

public String position()

The current pagination position in the paged result set.

Returns:

The current pagination position in the paged result set.

limit

public Integer limit()

The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

Returns:

The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

embed

public List<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.

Returns:

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.

toBuilder

public GetResourcesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

Returns:

a builder for type T

builder

public static GetResourcesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetResourcesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object