@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GatingRule extends Object implements Serializable, Cloneable, StructuredPojo
A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.
For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
Constructor and Description |
---|
GatingRule() |
Modifier and Type | Method and Description |
---|---|
GatingRule |
clone() |
boolean |
equals(Object obj) |
String |
getControlPanelArn()
The Amazon Resource Name (ARN) of the control panel.
|
List<String> |
getGatingControls()
An array of gating routing control Amazon Resource Names (ARNs).
|
String |
getName()
The name for the gating rule.
|
String |
getOwner()
The Amazon Web Services account ID of the gating rule owner.
|
RuleConfig |
getRuleConfig()
The criteria that you set for gating routing controls that designate how many of the routing control states must
be ON to allow you to update target routing control states.
|
String |
getSafetyRuleArn()
The Amazon Resource Name (ARN) of the gating rule.
|
String |
getStatus()
The deployment status of a gating rule.
|
List<String> |
getTargetControls()
An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the
rule configuration that you specify evaluates to true for the gating routing control.
|
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)
An array of gating routing control Amazon Resource Names (ARNs).
|
void |
setName(String name)
The name for the gating rule.
|
void |
setOwner(String owner)
The Amazon Web Services account ID of the gating rule owner.
|
void |
setRuleConfig(RuleConfig ruleConfig)
The criteria that you set for gating routing controls that designate how many of the routing control states must
be ON to allow you to update target routing control states.
|
void |
setSafetyRuleArn(String safetyRuleArn)
The Amazon Resource Name (ARN) of the gating rule.
|
void |
setStatus(String status)
The deployment status of a gating rule.
|
void |
setTargetControls(Collection<String> targetControls)
An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the
rule configuration that you specify evaluates to true for the gating routing control.
|
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.
|
GatingRule |
withControlPanelArn(String controlPanelArn)
The Amazon Resource Name (ARN) of the control panel.
|
GatingRule |
withGatingControls(Collection<String> gatingControls)
An array of gating routing control Amazon Resource Names (ARNs).
|
GatingRule |
withGatingControls(String... gatingControls)
An array of gating routing control Amazon Resource Names (ARNs).
|
GatingRule |
withName(String name)
The name for the gating rule.
|
GatingRule |
withOwner(String owner)
The Amazon Web Services account ID of the gating rule owner.
|
GatingRule |
withRuleConfig(RuleConfig ruleConfig)
The criteria that you set for gating routing controls that designate how many of the routing control states must
be ON to allow you to update target routing control states.
|
GatingRule |
withSafetyRuleArn(String safetyRuleArn)
The Amazon Resource Name (ARN) of the gating rule.
|
GatingRule |
withStatus(Status status)
The deployment status of a gating rule.
|
GatingRule |
withStatus(String status)
The deployment status of a gating rule.
|
GatingRule |
withTargetControls(Collection<String> targetControls)
An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the
rule configuration that you specify evaluates to true for the gating routing control.
|
GatingRule |
withTargetControls(String... targetControls)
An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the
rule configuration that you specify evaluates to true for the gating routing control.
|
GatingRule |
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 GatingRule 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()
An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.
public void setGatingControls(Collection<String> gatingControls)
An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.
gatingControls
- An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the
ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you
specify to determine if the target routing control states can be changed.public GatingRule withGatingControls(String... gatingControls)
An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.
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
- An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the
ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you
specify to determine if the target routing control states can be changed.public GatingRule withGatingControls(Collection<String> gatingControls)
An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.
gatingControls
- An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the
ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you
specify to determine if the target routing control states can be changed.public void setName(String name)
The name for the gating rule. You can use any non-white space character in the name.
name
- The name for the gating rule. You can use any non-white space character in the name.public String getName()
The name for the gating rule. You can use any non-white space character in the name.
public GatingRule withName(String name)
The name for the gating rule. You can use any non-white space character in the name.
name
- The name for the gating rule. You can use any non-white space character in the name.public void setRuleConfig(RuleConfig ruleConfig)
The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.
ruleConfig
- The criteria that you set for gating routing controls that designate how many of the routing control
states must be ON to allow you to update target routing control states.public RuleConfig getRuleConfig()
The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.
public GatingRule withRuleConfig(RuleConfig ruleConfig)
The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.
ruleConfig
- The criteria that you set for gating routing controls that designate how many of the routing control
states must be ON to allow you to update target routing control states.public void setSafetyRuleArn(String safetyRuleArn)
The Amazon Resource Name (ARN) of the gating rule.
safetyRuleArn
- The Amazon Resource Name (ARN) of the gating rule.public String getSafetyRuleArn()
The Amazon Resource Name (ARN) of the gating rule.
public GatingRule withSafetyRuleArn(String safetyRuleArn)
The Amazon Resource Name (ARN) of the gating rule.
safetyRuleArn
- The Amazon Resource Name (ARN) of the gating rule.public void setStatus(String status)
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
status
- The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED,
PENDING_DELETION.Status
public String getStatus()
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Status
public GatingRule withStatus(String status)
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
status
- The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED,
PENDING_DELETION.Status
public GatingRule withStatus(Status status)
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
status
- The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED,
PENDING_DELETION.Status
public List<String> getTargetControls()
An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.
public void setTargetControls(Collection<String> targetControls)
An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.
targetControls
- An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated
if the rule configuration that you specify evaluates to true for the gating routing control. As a simple
example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target
routing controls. You can use this to manually override automated failover, for example.public GatingRule withTargetControls(String... targetControls)
An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.
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
- An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated
if the rule configuration that you specify evaluates to true for the gating routing control. As a simple
example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target
routing controls. You can use this to manually override automated failover, for example.public GatingRule withTargetControls(Collection<String> targetControls)
An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.
targetControls
- An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated
if the rule configuration that you specify evaluates to true for the gating routing control. As a simple
example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target
routing controls. You can use this to manually override automated failover, for example.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 GatingRule 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 void setOwner(String owner)
The Amazon Web Services account ID of the gating rule owner.
owner
- The Amazon Web Services account ID of the gating rule owner.public String getOwner()
The Amazon Web Services account ID of the gating rule owner.
public GatingRule withOwner(String owner)
The Amazon Web Services account ID of the gating rule owner.
owner
- The Amazon Web Services account ID of the gating rule owner.public String toString()
toString
in class Object
Object.toString()
public GatingRule clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.