software.amazon.awssdk.services.apigateway.model

Class CanarySettings

java.lang.Object

software.amazon.awssdk.services.apigateway.model.CanarySettings

All Implemented Interfaces:

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

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

Configuration settings of a canary deployment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CanarySettings.Builder

Method Summary

Modifier and Type	Method and Description
static CanarySettings.Builder	builder()
String	deploymentId() The ID of the canary deployment.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Double	percentTraffic() The percent (0-100) of traffic diverted to a canary deployment.
List<SdkField<?>>	sdkFields()
static Class<? extends CanarySettings.Builder>	serializableBuilderClass()
Map<String,String>	stageVariableOverrides() Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
CanarySettings.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 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 percent (0-100) of traffic diverted to a canary deployment.

Returns:

The percent (0-100) of traffic diverted to a canary deployment.

deploymentId

public String deploymentId()

The ID of the canary deployment.

Returns:

The ID of the canary deployment.

stageVariableOverrides

public Map<String,String> stageVariableOverrides()

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. 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:

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. 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 deployment uses the stage cache or not.

Returns:

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

toBuilder

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

Returns:

a builder for type T

builder

public static CanarySettings.Builder builder()

serializableBuilderClass

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