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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The identifier for the deployment resource.
List<SdkField<?>>	sdkFields()
static Class<? extends Deployment.Builder>	serializableBuilderClass()
Deployment.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public String id()

The identifier for the deployment resource.

Returns:

The identifier for the deployment resource.

description

public String description()

The description for the deployment resource.

Returns:

The description for the deployment resource.

createdDate

public Instant createdDate()

The date and time that the deployment resource was created.

Returns:

The date and time that the deployment resource was created.

apiSummary

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

Returns:

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

toBuilder

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

Returns:

a builder for type T

builder

public static Deployment.Builder builder()

serializableBuilderClass

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

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.