CanarySettings (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Configuration settings of a canary deployment.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

CanarySettings()

Constructors
Constructor and Description
`CanarySettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CanarySettings`	`addStageVariableOverridesEntry(String key, String value)` Add a single StageVariableOverrides entry
`CanarySettings`	`clearStageVariableOverridesEntries()` Removes all the entries added into StageVariableOverrides.
`CanarySettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDeploymentId()` The ID of the canary deployment.
`Double`	`getPercentTraffic()` The percent (0-100) of traffic diverted to a canary deployment.
`Map<String,String>`	`getStageVariableOverrides()` Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
`Boolean`	`getUseStageCache()` A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
`int`	`hashCode()`
`Boolean`	`isUseStageCache()` A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDeploymentId(String deploymentId)` The ID of the canary deployment.
`void`	`setPercentTraffic(Double percentTraffic)` The percent (0-100) of traffic diverted to a canary deployment.
`void`	`setStageVariableOverrides(Map<String,String> stageVariableOverrides)` Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
`void`	`setUseStageCache(Boolean useStageCache)` A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
`String`	`toString()` Returns a string representation of this object.
`CanarySettings`	`withDeploymentId(String deploymentId)` The ID of the canary deployment.
`CanarySettings`	`withPercentTraffic(Double percentTraffic)` The percent (0-100) of traffic diverted to a canary deployment.
`CanarySettings`	`withStageVariableOverrides(Map<String,String> stageVariableOverrides)` Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
`CanarySettings`	`withUseStageCache(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

- Constructor Detail
  - CanarySettings
```
public CanarySettings()
```
- Method Detail
  - setPercentTraffic
```
public void setPercentTraffic(Double percentTraffic)
```
    The percent (0-100) of traffic diverted to a canary deployment.
    
    Parameters:
    
    percentTraffic - The percent (0-100) of traffic diverted to a canary deployment.
  - getPercentTraffic
```
public Double getPercentTraffic()
```
    The percent (0-100) of traffic diverted to a canary deployment.
    
    Returns:
    
    The percent (0-100) of traffic diverted to a canary deployment.
  - withPercentTraffic
```
public CanarySettings withPercentTraffic(Double percentTraffic)
```
    The percent (0-100) of traffic diverted to a canary deployment.
    
    Parameters:
    
    percentTraffic - The percent (0-100) of traffic diverted to a canary deployment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeploymentId
```
public void setDeploymentId(String deploymentId)
```
    The ID of the canary deployment.
    
    Parameters:
    
    deploymentId - The ID of the canary deployment.
  - getDeploymentId
```
public String getDeploymentId()
```
    The ID of the canary deployment.
    
    Returns:
    
    The ID of the canary deployment.
  - withDeploymentId
```
public CanarySettings withDeploymentId(String deploymentId)
```
    The ID of the canary deployment.
    
    Parameters:
    
    deploymentId - The ID of the canary deployment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStageVariableOverrides
```
public Map<String,String> getStageVariableOverrides()
```
    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.
    
    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.
  - setStageVariableOverrides
```
public void setStageVariableOverrides(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.
    
    Parameters:
    
    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.
  - withStageVariableOverrides
```
public CanarySettings withStageVariableOverrides(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addStageVariableOverridesEntry
```
public CanarySettings addStageVariableOverridesEntry(String key,
                                                     String value)
```
    Add a single StageVariableOverrides entry
    
    See Also:
    
    withStageVariableOverrides(java.util.Map<java.lang.String, java.lang.String>)
  - clearStageVariableOverridesEntries
```
public CanarySettings 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 deployment uses the stage cache or not.
    
    Parameters:
    
    useStageCache - A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
  - getUseStageCache
```
public Boolean getUseStageCache()
```
    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.
  - withUseStageCache
```
public CanarySettings withUseStageCache(Boolean useStageCache)
```
    A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
    
    Parameters:
    
    useStageCache - A Boolean flag to indicate whether the canary 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 deployment uses the stage cache or not.
    
    Returns:
    
    A Boolean flag to indicate whether the canary 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 CanarySettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class CanarySettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CanarySettings

Method Detail

setPercentTraffic

getPercentTraffic

withPercentTraffic

setDeploymentId

getDeploymentId

withDeploymentId

getStageVariableOverrides

setStageVariableOverrides

withStageVariableOverrides

addStageVariableOverridesEntry

clearStageVariableOverridesEntries

setUseStageCache

getUseStageCache

withUseStageCache

isUseStageCache

toString

equals

hashCode

clone

marshall