com.amazonaws.services.apigateway.model

Class GetDeploymentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.GetDeploymentsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Requests API Gateway to get information about a Deployments collection.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetDeploymentsRequest()

Method Summary

Modifier and Type	Method and Description
GetDeploymentsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getLimit() The maximum number of returned results per page.
String	getPosition() The current pagination position in the paged result set.
String	getRestApiId() [Required] The string identifier of the associated RestApi.
int	hashCode()
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) [Required] The string identifier of the associated RestApi.
String	toString() Returns a string representation of this object.
GetDeploymentsRequest	withLimit(Integer limit) The maximum number of returned results per page.
GetDeploymentsRequest	withPosition(String position) The current pagination position in the paged result set.
GetDeploymentsRequest	withRestApiId(String restApiId) [Required] 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

GetDeploymentsRequest

public GetDeploymentsRequest()

Method Detail

setRestApiId

public void setRestApiId(String restApiId)

[Required] The string identifier of the associated RestApi.

Parameters:

restApiId - [Required] The string identifier of the associated RestApi.

getRestApiId

public String getRestApiId()

[Required] The string identifier of the associated RestApi.

Returns:

[Required] The string identifier of the associated RestApi.

withRestApiId

public GetDeploymentsRequest withRestApiId(String restApiId)

[Required] The string identifier of the associated RestApi.

Parameters:

restApiId - [Required] 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 GetDeploymentsRequest 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 GetDeploymentsRequest 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.

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