software.amazon.awssdk.services.apigateway.model

Class CreateDeploymentResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

software.amazon.awssdk.services.apigateway.model.CreateDeploymentResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeploymentResponse.Builder,CreateDeploymentResponse>

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

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDeploymentResponse.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,Map<String,MethodSnapshot>>	apiSummary() A summary of the RestApi at the date and time that the deployment resource was created.
static CreateDeploymentResponse.Builder	builder()
Instant	createdDate() The date and time that the deployment resource was created.
String	description() The description for the deployment resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasApiSummary() For responses, this returns true if the service returned a value for the ApiSummary property.
int	hashCode()
String	id() The identifier for the deployment resource.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeploymentResponse.Builder>	serializableBuilderClass()
CreateDeploymentResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

id

public final String id()

The identifier for the deployment resource.

Returns:

The identifier for the deployment resource.

description

public final String description()

The description for the deployment resource.

Returns:

The description for the deployment resource.

createdDate

public final Instant createdDate()

The date and time that the deployment resource was created.

Returns:

The date and time that the deployment resource was created.

hasApiSummary

public final boolean hasApiSummary()

For responses, this returns true if the service returned a value for the ApiSummary 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.

apiSummary

public final Map<String,Map<String,MethodSnapshot>> apiSummary()

A summary of the RestApi at the date and time that the deployment resource was created.

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 hasApiSummary() method.

Returns:

A summary of the RestApi at the date and time that the deployment resource was created.

toBuilder

public CreateDeploymentResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDeploymentResponse.Builder,CreateDeploymentResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateDeploymentResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo