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

Class GetDeploymentRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.GetDeploymentRequest

All Implemented Interfaces:

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

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

Requests Amazon API Gateway to get information about a Deployment resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDeploymentRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GetDeploymentRequest.Builder	builder()
String	deploymentId()	The identifier of the Deployment resource to get information about.
List<String>	embed()	A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response.
boolean	equals(Object obj)
int	hashCode()
String	restApiId()	The identifier of the RestApi resource for the Deployment resource to get information about.
static Class<? extends GetDeploymentRequest.Builder>	serializableBuilderClass()
GetDeploymentRequest.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 identifier of the RestApi resource for the Deployment resource to get information about.

Returns:

The identifier of the RestApi resource for the Deployment resource to get information about.

deploymentId

public String deploymentId()

The identifier of the Deployment resource to get information about.

Returns:

The identifier of the Deployment resource to get information about.

embed

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

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.

toBuilder

public GetDeploymentRequest.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<GetDeploymentRequest.Builder,GetDeploymentRequest>

Returns:

a builder for type T

builder

public static GetDeploymentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDeploymentRequest.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