com.amazonaws.services.apigateway.model

Class GetResourcesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.GetResourcesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetResourcesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Request to list information about a collection of resources.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetResourcesRequest()

Method Summary

Modifier and Type	Method and Description
GetResourcesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getEmbed() A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
Integer	getLimit() The maximum number of returned results per page.
String	getPosition() The current pagination position in the paged result set.
String	getRestApiId() The string identifier of the associated RestApi.
int	hashCode()
void	setEmbed(Collection<String> embed) A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
void	setLimit(Integer limit) The maximum number of returned results per page.
void	setPosition(String position) The current pagination position in the paged result set.
void	setRestApiId(String restApiId) The string identifier of the associated RestApi.
String	toString() Returns a string representation of this object.
GetResourcesRequest	withEmbed(Collection<String> embed) A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
GetResourcesRequest	withEmbed(String... embed) A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
GetResourcesRequest	withLimit(Integer limit) The maximum number of returned results per page.
GetResourcesRequest	withPosition(String position) The current pagination position in the paged result set.
GetResourcesRequest	withRestApiId(String restApiId) The string identifier of the associated RestApi.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetResourcesRequest

public GetResourcesRequest()

Method Detail

setRestApiId

public void setRestApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

getRestApiId

public String getRestApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

withRestApiId

public GetResourcesRequest withRestApiId(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.

setPosition

public void setPosition(String position)

The current pagination position in the paged result set.

Parameters:

position - The current pagination position in the paged result set.

getPosition

public String getPosition()

The current pagination position in the paged result set.

Returns:

The current pagination position in the paged result set.

withPosition

public GetResourcesRequest withPosition(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.

setLimit

public void setLimit(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.

getLimit

public Integer getLimit()

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

withLimit

public GetResourcesRequest withLimit(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.

getEmbed

public List<String> getEmbed()

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.

setEmbed

public void setEmbed(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.

withEmbed

public GetResourcesRequest withEmbed(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.

withEmbed

public GetResourcesRequest withEmbed(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetResourcesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()