Class DeploymentCanarySettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DeploymentCanarySettings.Builder,
DeploymentCanarySettings>
The input configuration for a canary deployment.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StageVariableOverrides property.final Double
The percentage (0.0-100.0) of traffic routed to the canary deployment.static Class
<? extends DeploymentCanarySettings.Builder> A stage variable overrides used for the canary release deployment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
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 theisEmpty()
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
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.
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:
- 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
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
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 interfaceToCopyableBuilder<DeploymentCanarySettings.Builder,
DeploymentCanarySettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-