DeploymentCanarySettings (AWS Java SDK for Amazon API Gateway 1.12.267 API)

java.lang.Object
- com.amazonaws.services.apigateway.model.DeploymentCanarySettings

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeploymentCanarySettings
extends Object
implements Serializable, Cloneable, StructuredPojo

The input configuration for a canary deployment.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

DeploymentCanarySettings()

Constructors
Constructor and Description
`DeploymentCanarySettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeploymentCanarySettings`	`addStageVariableOverridesEntry(String key, String value)` Add a single StageVariableOverrides entry
`DeploymentCanarySettings`	`clearStageVariableOverridesEntries()` Removes all the entries added into StageVariableOverrides.
`DeploymentCanarySettings`	`clone()`
`boolean`	`equals(Object obj)`
`Double`	`getPercentTraffic()` The percentage (0.0-100.0) of traffic routed to the canary deployment.
`Map<String,String>`	`getStageVariableOverrides()` A stage variable overrides used for the canary release deployment.
`Boolean`	`getUseStageCache()` A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
`int`	`hashCode()`
`Boolean`	`isUseStageCache()` A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setPercentTraffic(Double percentTraffic)` The percentage (0.0-100.0) of traffic routed to the canary deployment.
`void`	`setStageVariableOverrides(Map<String,String> stageVariableOverrides)` A stage variable overrides used for the canary release deployment.
`void`	`setUseStageCache(Boolean useStageCache)` A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
`String`	`toString()` Returns a string representation of this object.
`DeploymentCanarySettings`	`withPercentTraffic(Double percentTraffic)` The percentage (0.0-100.0) of traffic routed to the canary deployment.
`DeploymentCanarySettings`	`withStageVariableOverrides(Map<String,String> stageVariableOverrides)` A stage variable overrides used for the canary release deployment.
`DeploymentCanarySettings`	`withUseStageCache(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
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DeploymentCanarySettings
```
public DeploymentCanarySettings()
```
- Method Detail
  - setPercentTraffic
```
public void setPercentTraffic(Double percentTraffic)
```
    The percentage (0.0-100.0) of traffic routed to the canary deployment.
    
    Parameters:
    
    percentTraffic - The percentage (0.0-100.0) of traffic routed to the canary deployment.
  - getPercentTraffic
```
public Double getPercentTraffic()
```
    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.
  - withPercentTraffic
```
public DeploymentCanarySettings withPercentTraffic(Double percentTraffic)
```
    The percentage (0.0-100.0) of traffic routed to the canary deployment.
    
    Parameters:
    
    percentTraffic - The percentage (0.0-100.0) of traffic routed to the canary deployment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStageVariableOverrides
```
public Map<String,String> getStageVariableOverrides()
```
    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.
    
    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.
  - setStageVariableOverrides
```
public void setStageVariableOverrides(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.
    
    Parameters:
    
    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.
  - withStageVariableOverrides
```
public DeploymentCanarySettings withStageVariableOverrides(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addStageVariableOverridesEntry
```
public DeploymentCanarySettings addStageVariableOverridesEntry(String key,
                                                               String value)
```
    Add a single StageVariableOverrides entry
    
    See Also:
    
    withStageVariableOverrides(java.util.Map<java.lang.String, java.lang.String>)
  - clearStageVariableOverridesEntries
```
public DeploymentCanarySettings clearStageVariableOverridesEntries()
```
    Removes all the entries added into StageVariableOverrides.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUseStageCache
```
public void setUseStageCache(Boolean useStageCache)
```
    A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
    
    Parameters:
    
    useStageCache - A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
  - getUseStageCache
```
public Boolean getUseStageCache()
```
    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.
  - withUseStageCache
```
public DeploymentCanarySettings withUseStageCache(Boolean useStageCache)
```
    A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
    
    Parameters:
    
    useStageCache - A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUseStageCache
```
public Boolean isUseStageCache()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DeploymentCanarySettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class DeploymentCanarySettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeploymentCanarySettings

Method Detail

setPercentTraffic

getPercentTraffic

withPercentTraffic

getStageVariableOverrides

setStageVariableOverrides

withStageVariableOverrides

addStageVariableOverridesEntry

clearStageVariableOverridesEntries

setUseStageCache

getUseStageCache

withUseStageCache

isUseStageCache

toString

equals

hashCode

clone

marshall