AwsApiGatewayCanarySettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsApiGatewayCanarySettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsApiGatewayCanarySettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about settings for canary deployment in the stage.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsApiGatewayCanarySettings()

Constructors
Constructor and Description
`AwsApiGatewayCanarySettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsApiGatewayCanarySettings`	`addStageVariableOverridesEntry(String key, String value)` Add a single StageVariableOverrides entry
`AwsApiGatewayCanarySettings`	`clearStageVariableOverridesEntries()` Removes all the entries added into StageVariableOverrides.
`AwsApiGatewayCanarySettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDeploymentId()` The deployment identifier for the canary deployment.
`Double`	`getPercentTraffic()` The percentage of traffic that is diverted to a canary deployment.
`Map<String,String>`	`getStageVariableOverrides()` Stage variables that are overridden in the canary release deployment.
`Boolean`	`getUseStageCache()` Indicates whether the canary deployment uses the stage cache.
`int`	`hashCode()`
`Boolean`	`isUseStageCache()` Indicates whether the canary deployment uses the stage cache.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDeploymentId(String deploymentId)` The deployment identifier for the canary deployment.
`void`	`setPercentTraffic(Double percentTraffic)` The percentage of traffic that is diverted to a canary deployment.
`void`	`setStageVariableOverrides(Map<String,String> stageVariableOverrides)` Stage variables that are overridden in the canary release deployment.
`void`	`setUseStageCache(Boolean useStageCache)` Indicates whether the canary deployment uses the stage cache.
`String`	`toString()` Returns a string representation of this object.
`AwsApiGatewayCanarySettings`	`withDeploymentId(String deploymentId)` The deployment identifier for the canary deployment.
`AwsApiGatewayCanarySettings`	`withPercentTraffic(Double percentTraffic)` The percentage of traffic that is diverted to a canary deployment.
`AwsApiGatewayCanarySettings`	`withStageVariableOverrides(Map<String,String> stageVariableOverrides)` Stage variables that are overridden in the canary release deployment.
`AwsApiGatewayCanarySettings`	`withUseStageCache(Boolean useStageCache)` Indicates whether the canary deployment uses the stage cache.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AwsApiGatewayCanarySettings
```
public AwsApiGatewayCanarySettings()
```
- Method Detail
  - setPercentTraffic
```
public void setPercentTraffic(Double percentTraffic)
```
    The percentage of traffic that is diverted to a canary deployment.
    
    Parameters:
    
    percentTraffic - The percentage of traffic that is diverted to a canary deployment.
  - getPercentTraffic
```
public Double getPercentTraffic()
```
    The percentage of traffic that is diverted to a canary deployment.
    
    Returns:
    
    The percentage of traffic that is diverted to a canary deployment.
  - withPercentTraffic
```
public AwsApiGatewayCanarySettings withPercentTraffic(Double percentTraffic)
```
    The percentage of traffic that is diverted to a canary deployment.
    
    Parameters:
    
    percentTraffic - The percentage of traffic that is 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 deployment identifier for the canary deployment.
    
    Parameters:
    
    deploymentId - The deployment identifier for the canary deployment.
  - getDeploymentId
```
public String getDeploymentId()
```
    The deployment identifier for the canary deployment.
    
    Returns:
    
    The deployment identifier for the canary deployment.
  - withDeploymentId
```
public AwsApiGatewayCanarySettings withDeploymentId(String deploymentId)
```
    The deployment identifier for the canary deployment.
    
    Parameters:
    
    deploymentId - The deployment identifier for 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 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.
    
    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.
  - setStageVariableOverrides
```
public void setStageVariableOverrides(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.
    
    Parameters:
    
    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.
  - withStageVariableOverrides
```
public AwsApiGatewayCanarySettings withStageVariableOverrides(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addStageVariableOverridesEntry
```
public AwsApiGatewayCanarySettings addStageVariableOverridesEntry(String key,
                                                                  String value)
```
    Add a single StageVariableOverrides entry
    
    See Also:
    
    withStageVariableOverrides(java.util.Map<java.lang.String, java.lang.String>)
  - clearStageVariableOverridesEntries
```
public AwsApiGatewayCanarySettings 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)
```
    Indicates whether the canary deployment uses the stage cache.
    
    Parameters:
    
    useStageCache - Indicates whether the canary deployment uses the stage cache.
  - getUseStageCache
```
public Boolean getUseStageCache()
```
    Indicates whether the canary deployment uses the stage cache.
    
    Returns:
    
    Indicates whether the canary deployment uses the stage cache.
  - withUseStageCache
```
public AwsApiGatewayCanarySettings withUseStageCache(Boolean useStageCache)
```
    Indicates whether the canary deployment uses the stage cache.
    
    Parameters:
    
    useStageCache - Indicates whether the canary deployment uses the stage cache.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUseStageCache
```
public Boolean isUseStageCache()
```
    Indicates whether the canary deployment uses the stage cache.
    
    Returns:
    
    Indicates whether the canary deployment uses the stage cache.
  - 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 AwsApiGatewayCanarySettings 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.771

Class AwsApiGatewayCanarySettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsApiGatewayCanarySettings

Method Detail

setPercentTraffic

getPercentTraffic

withPercentTraffic

setDeploymentId

getDeploymentId

withDeploymentId

getStageVariableOverrides

setStageVariableOverrides

withStageVariableOverrides

addStageVariableOverridesEntry

clearStageVariableOverridesEntries

setUseStageCache

getUseStageCache

withUseStageCache

isUseStageCache

toString

equals

hashCode

clone

marshall