Package software.amazon.awssdk.services.securityhub.model

Class AwsApiGatewayCanarySettings

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsApiGatewayCanarySettings

All Implemented Interfaces:

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

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

Contains information about settings for canary deployment in the stage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsApiGatewayCanarySettings.Builder

Method Summary

Modifier and Type	Method	Description
static AwsApiGatewayCanarySettings.Builder	builder()
String	deploymentId()	The deployment identifier for the canary deployment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStageVariableOverrides()	For responses, this returns true if the service returned a value for the StageVariableOverrides property.
Double	percentTraffic()	The percentage of traffic that is diverted to a canary deployment.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsApiGatewayCanarySettings.Builder>	serializableBuilderClass()
Map<String,String>	stageVariableOverrides()	Stage variables that are overridden in the canary release deployment.
AwsApiGatewayCanarySettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	useStageCache()	Indicates whether the canary deployment uses the stage cache.

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 percentage of traffic that is diverted to a canary deployment.

Returns:

The percentage of traffic that is diverted to a canary deployment.

deploymentId

public final String deploymentId()

The deployment identifier for the canary deployment.

Returns:

The deployment identifier for the canary deployment.

hasStageVariableOverrides

public final boolean hasStageVariableOverrides()

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

stageVariableOverrides

public final Map<String,String> stageVariableOverrides()

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

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

Returns:

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

useStageCache

public final Boolean useStageCache()

Indicates whether the canary deployment uses the stage cache.

Returns:

Indicates whether the canary deployment uses the stage cache.

toBuilder

public AwsApiGatewayCanarySettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsApiGatewayCanarySettings.Builder,AwsApiGatewayCanarySettings>

builder

public static AwsApiGatewayCanarySettings.Builder builder()

serializableBuilderClass

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