com.amazonaws.services.apigateway.model

Class GetResourceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.GetResourceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Request to list information about a resource.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetResourceRequest()

Method Summary

Modifier and Type	Method and Description
GetResourceRequest	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 to retrieve the specified resources embedded in the returned Resource representation in the response.
String	getResourceId() The identifier for the Resource resource.
String	getRestApiId() The string identifier of the associated RestApi.
int	hashCode()
void	setEmbed(Collection<String> embed) A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response.
void	setResourceId(String resourceId) The identifier for the Resource resource.
void	setRestApiId(String restApiId) The string identifier of the associated RestApi.
String	toString() Returns a string representation of this object.
GetResourceRequest	withEmbed(Collection<String> embed) A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response.
GetResourceRequest	withEmbed(String... embed) A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response.
GetResourceRequest	withResourceId(String resourceId) The identifier for the Resource resource.
GetResourceRequest	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

GetResourceRequest

public GetResourceRequest()

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

setResourceId

public void setResourceId(String resourceId)

The identifier for the Resource resource.

Parameters:

resourceId - The identifier for the Resource resource.

getResourceId

public String getResourceId()

The identifier for the Resource resource.

Returns:

The identifier for the Resource resource.

withResourceId

public GetResourceRequest withResourceId(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.

getEmbed

public List<String> getEmbed()

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:

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.

setEmbed

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

withEmbed

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

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

withEmbed

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

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 GetResourceRequest 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()