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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStageVariableOverrides() Returns true if the StageVariableOverrides property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
String	toString() Returns a string representation of this object.
Boolean	useStageCache() A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

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

percentTraffic

public final 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 final String deploymentId()

The ID of the canary deployment.

Returns:

The ID of the canary deployment.

hasStageVariableOverrides

public final boolean hasStageVariableOverrides()

Returns true if the StageVariableOverrides 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.

stageVariableOverrides

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

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

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

Specified by:

toBuilder in interface ToCopyableBuilder<CanarySettings.Builder,CanarySettings>

builder

public static CanarySettings.Builder builder()

serializableBuilderClass

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