@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class NewGatingRule extends Object implements Serializable, Cloneable, StructuredPojo
A new gating rule for a control panel.
Constructor and Description |
---|
NewGatingRule() |
Modifier and Type | Method and Description |
---|---|
NewGatingRule |
clone() |
boolean |
equals(Object obj) |
String |
getControlPanelArn()
The Amazon Resource Name (ARN) of the control panel.
|
List<String> |
getGatingControls()
The gating controls for the new gating rule.
|
String |
getName()
The name for the new gating rule.
|
RuleConfig |
getRuleConfig()
The criteria that you set for specific gating controls (routing controls) that designate how many control states
must be ON to allow you to change (set or unset) the target control states.
|
List<String> |
getTargetControls()
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified
GatingControls.
|
Integer |
getWaitPeriodMs()
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will
fail.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setControlPanelArn(String controlPanelArn)
The Amazon Resource Name (ARN) of the control panel.
|
void |
setGatingControls(Collection<String> gatingControls)
The gating controls for the new gating rule.
|
void |
setName(String name)
The name for the new gating rule.
|
void |
setRuleConfig(RuleConfig ruleConfig)
The criteria that you set for specific gating controls (routing controls) that designate how many control states
must be ON to allow you to change (set or unset) the target control states.
|
void |
setTargetControls(Collection<String> targetControls)
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified
GatingControls.
|
void |
setWaitPeriodMs(Integer waitPeriodMs)
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will
fail.
|
String |
toString()
Returns a string representation of this object.
|
NewGatingRule |
withControlPanelArn(String controlPanelArn)
The Amazon Resource Name (ARN) of the control panel.
|
NewGatingRule |
withGatingControls(Collection<String> gatingControls)
The gating controls for the new gating rule.
|
NewGatingRule |
withGatingControls(String... gatingControls)
The gating controls for the new gating rule.
|
NewGatingRule |
withName(String name)
The name for the new gating rule.
|
NewGatingRule |
withRuleConfig(RuleConfig ruleConfig)
The criteria that you set for specific gating controls (routing controls) that designate how many control states
must be ON to allow you to change (set or unset) the target control states.
|
NewGatingRule |
withTargetControls(Collection<String> targetControls)
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified
GatingControls.
|
NewGatingRule |
withTargetControls(String... targetControls)
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified
GatingControls.
|
NewGatingRule |
withWaitPeriodMs(Integer waitPeriodMs)
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will
fail.
|
public void setControlPanelArn(String controlPanelArn)
The Amazon Resource Name (ARN) of the control panel.
controlPanelArn
- The Amazon Resource Name (ARN) of the control panel.public String getControlPanelArn()
The Amazon Resource Name (ARN) of the control panel.
public NewGatingRule withControlPanelArn(String controlPanelArn)
The Amazon Resource Name (ARN) of the control panel.
controlPanelArn
- The Amazon Resource Name (ARN) of the control panel.public List<String> getGatingControls()
The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
public void setGatingControls(Collection<String> gatingControls)
The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
gatingControls
- The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule
configuration that you specify.public NewGatingRule withGatingControls(String... gatingControls)
The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
NOTE: This method appends the values to the existing list (if any). Use
setGatingControls(java.util.Collection)
or withGatingControls(java.util.Collection)
if you want
to override the existing values.
gatingControls
- The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule
configuration that you specify.public NewGatingRule withGatingControls(Collection<String> gatingControls)
The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
gatingControls
- The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule
configuration that you specify.public void setName(String name)
The name for the new gating rule.
name
- The name for the new gating rule.public String getName()
The name for the new gating rule.
public NewGatingRule withName(String name)
The name for the new gating rule.
name
- The name for the new gating rule.public void setRuleConfig(RuleConfig ruleConfig)
The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.
ruleConfig
- The criteria that you set for specific gating controls (routing controls) that designate how many control
states must be ON to allow you to change (set or unset) the target control states.public RuleConfig getRuleConfig()
The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.
public NewGatingRule withRuleConfig(RuleConfig ruleConfig)
The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.
ruleConfig
- The criteria that you set for specific gating controls (routing controls) that designate how many control
states must be ON to allow you to change (set or unset) the target control states.public List<String> getTargetControls()
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
public void setTargetControls(Collection<String> targetControls)
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
targetControls
- Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the
specified GatingControls. For example, say you have three gating controls, one for each of three Amazon
Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only
change (set or unset) the routing controls that you have specified as TargetControls if that rule
evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
public NewGatingRule withTargetControls(String... targetControls)
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
NOTE: This method appends the values to the existing list (if any). Use
setTargetControls(java.util.Collection)
or withTargetControls(java.util.Collection)
if you want
to override the existing values.
targetControls
- Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the
specified GatingControls. For example, say you have three gating controls, one for each of three Amazon
Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only
change (set or unset) the routing controls that you have specified as TargetControls if that rule
evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
public NewGatingRule withTargetControls(Collection<String> targetControls)
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
targetControls
- Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the
specified GatingControls. For example, say you have three gating controls, one for each of three Amazon
Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only
change (set or unset) the routing controls that you have specified as TargetControls if that rule
evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
public void setWaitPeriodMs(Integer waitPeriodMs)
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
waitPeriodMs
- An evaluation period, in milliseconds (ms), during which any request against the target routing controls
will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can
choose a custom value.public Integer getWaitPeriodMs()
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
public NewGatingRule withWaitPeriodMs(Integer waitPeriodMs)
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
waitPeriodMs
- An evaluation period, in milliseconds (ms), during which any request against the target routing controls
will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can
choose a custom value.public String toString()
toString
in class Object
Object.toString()
public NewGatingRule clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.