software.amazon.awssdk.services.apigateway.model

Class Deployment

java.lang.Object

software.amazon.awssdk.services.apigateway.model.Deployment

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Deployment.Builder,Deployment>

@Generated(value="software.amazon.awssdk:codegen")
public final class Deployment
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Deployment.Builder,Deployment>

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.

To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource ( /restapis/{restapi_id}/deployments/{deployment_id}).

RestApi, Deployments, Stage, AWS CLI, AWS SDKs

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Deployment.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 Deployment.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() Returns true if the ApiSummary property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	id() The identifier for the deployment resource.
List<SdkField<?>>	sdkFields()
static Class<? extends Deployment.Builder>	serializableBuilderClass()
Deployment.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

Returns true if the ApiSummary property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasApiSummary() to see if a value was sent in this field.

Returns:

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

toBuilder

public Deployment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Deployment.Builder,Deployment>

builder

public static Deployment.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo