software.amazon.awssdk.services.apigateway.model

Class DeploymentCanarySettings

java.lang.Object

software.amazon.awssdk.services.apigateway.model.DeploymentCanarySettings

All Implemented Interfaces:

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

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

The input configuration for a canary deployment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeploymentCanarySettings.Builder

Method Summary

Modifier and Type	Method and Description
static DeploymentCanarySettings.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Double	percentTraffic() The percentage (0.0-100.0) of traffic routed to the canary deployment.
List<SdkField<?>>	sdkFields()
static Class<? extends DeploymentCanarySettings.Builder>	serializableBuilderClass()
Map<String,String>	stageVariableOverrides() A stage variable overrides used for the canary release deployment.
DeploymentCanarySettings.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Boolean	useStageCache() A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

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

percentTraffic

public Double percentTraffic()

The percentage (0.0-100.0) of traffic routed to the canary deployment.

Returns:

The percentage (0.0-100.0) of traffic routed to the canary deployment.

stageVariableOverrides

public Map<String,String> stageVariableOverrides()

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

useStageCache

public Boolean useStageCache()

A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

Returns:

A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

toBuilder

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

Returns:

a builder for type T

builder

public static DeploymentCanarySettings.Builder builder()

serializableBuilderClass

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