com.amazonaws.services.apigateway.model

Class GetDeploymentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.GetDeploymentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Requests API Gateway to get information about a Deployment resource.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetDeploymentRequest()

Method Summary

Modifier and Type	Method and Description
GetDeploymentRequest	clone()
boolean	equals(Object obj)
String	getDeploymentId() [Required] The identifier of the Deployment resource to get information about.
List<String>	getEmbed() A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response.
String	getRestApiId() [Required] The string identifier of the associated RestApi.
int	hashCode()
void	setDeploymentId(String deploymentId) [Required] The identifier of the Deployment resource to get information about.
void	setEmbed(Collection<String> embed) A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response.
void	setRestApiId(String restApiId) [Required] The string identifier of the associated RestApi.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetDeploymentRequest	withDeploymentId(String deploymentId) [Required] The identifier of the Deployment resource to get information about.
GetDeploymentRequest	withEmbed(Collection<String> embed) A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response.
GetDeploymentRequest	withEmbed(String... embed) A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response.
GetDeploymentRequest	withRestApiId(String restApiId) [Required] The string identifier of the associated RestApi.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetDeploymentRequest

public GetDeploymentRequest()

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

setDeploymentId

public void setDeploymentId(String deploymentId)

[Required] The identifier of the Deployment resource to get information about.

Parameters:

deploymentId - [Required] The identifier of the Deployment resource to get information about.

getDeploymentId

public String getDeploymentId()

[Required] The identifier of the Deployment resource to get information about.

Returns:

[Required] The identifier of the Deployment resource to get information about.

withDeploymentId

public GetDeploymentRequest withDeploymentId(String deploymentId)

[Required] The identifier of the Deployment resource to get information about.

Parameters:

deploymentId - [Required] The identifier of the Deployment resource to get information about.

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 embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Returns:

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

setEmbed

public void setEmbed(Collection<String> embed)

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Parameters:

embed - A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

withEmbed

public GetDeploymentRequest withEmbed(String... embed)

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

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 embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Returns:

Returns a reference to this object so that method calls can be chained together.

withEmbed

public GetDeploymentRequest withEmbed(Collection<String> embed)

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Parameters:

embed - A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

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; useful for testing and debugging.

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 GetDeploymentRequest clone()

Overrides:

clone in class AmazonWebServiceRequest