software.amazon.awssdk.services.apigateway.model

Class CreateDeploymentRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

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

Requests API Gateway to create a Deployment resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDeploymentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDeploymentRequest.Builder	builder()
Boolean	cacheClusterEnabled() Enables a cache cluster for the Stage resource specified in the input.
String	cacheClusterSize() The stage's cache capacity in GB.
DeploymentCanarySettings	canarySettings() The input configuration for the canary deployment when the deployment is a canary release deployment.
String	description() The description for the Deployment resource to create.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVariables() For responses, this returns true if the service returned a value for the Variables property.
String	restApiId() The string identifier of the associated RestApi.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeploymentRequest.Builder>	serializableBuilderClass()
String	stageDescription() The description of the Stage resource for the Deployment resource to create.
String	stageName() The name of the Stage resource for the Deployment resource to create.
CreateDeploymentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	tracingEnabled() Specifies whether active tracing with X-ray is enabled for the Stage.
Map<String,String>	variables() A map that defines the stage variables for the Stage resource that is associated with the new deployment.

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.

stageName

public final String stageName()

The name of the Stage resource for the Deployment resource to create.

Returns:

The name of the Stage resource for the Deployment resource to create.

stageDescription

public final String stageDescription()

The description of the Stage resource for the Deployment resource to create.

Returns:

The description of the Stage resource for the Deployment resource to create.

description

public final String description()

The description for the Deployment resource to create.

Returns:

The description for the Deployment resource to create.

cacheClusterEnabled

public final Boolean cacheClusterEnabled()

Enables a cache cluster for the Stage resource specified in the input.

Returns:

Enables a cache cluster for the Stage resource specified in the input.

cacheClusterSize

public final String cacheClusterSize()

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

Returns:

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

hasVariables

public final boolean hasVariables()

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

variables

public final Map<String,String> variables()

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

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

Returns:

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

canarySettings

public final DeploymentCanarySettings canarySettings()

The input configuration for the canary deployment when the deployment is a canary release deployment.

Returns:

The input configuration for the canary deployment when the deployment is a canary release deployment.

tracingEnabled

public final Boolean tracingEnabled()

Specifies whether active tracing with X-ray is enabled for the Stage.

Returns:

Specifies whether active tracing with X-ray is enabled for the Stage.

toBuilder

public CreateDeploymentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static CreateDeploymentRequest.Builder builder()

serializableBuilderClass

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