@Generated(value="software.amazon.awssdk:codegen") public final class GetDeploymentRequest extends ApiGatewayRequest implements ToCopyableBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>
Requests Amazon API Gateway to get information about a Deployment resource.
Modifier and Type | Class and Description |
---|---|
static interface |
GetDeploymentRequest.Builder |
Modifier and Type | Method and 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
restApiId()
The string identifier of the associated RestApi.
|
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() |
overrideConfiguration
copy
public String restApiId()
The string identifier of the associated RestApi.
public String deploymentId()
The identifier of the Deployment resource to get information about.
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
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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
.public GetDeploymentRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>
toBuilder
in class ApiGatewayRequest
public static GetDeploymentRequest.Builder builder()
public static Class<? extends GetDeploymentRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.