software.amazon.awssdk.services.apigateway.model

Class GetDeploymentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>

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

Requests API Gateway to get information about a Deployment resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDeploymentRequest.Builder

Method Summary

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEmbed() For responses, this returns true if the service returned a value for the Embed property.
int	hashCode()
String	restApiId() The string identifier of the associated RestApi.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDeploymentRequest.Builder>	serializableBuilderClass()
GetDeploymentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

restApiId

public final String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

deploymentId

public final String deploymentId()

The identifier of the Deployment resource to get information about.

Returns:

The identifier of the Deployment resource to get information about.

hasEmbed

public final boolean hasEmbed()

For responses, this returns true if the service returned a value for the Embed property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

embed

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEmbed() method.

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

Specified by:

toBuilder in interface ToCopyableBuilder<GetDeploymentRequest.Builder,GetDeploymentRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static GetDeploymentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDeploymentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo