Rule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticloadbalancingv2.model.Rule

All Implemented Interfaces:: Serializable, Cloneable

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

Information about a rule.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rule`	`clone()`
`boolean`	`equals(Object obj)`
`List<Action>`	`getActions()` The actions.
`List<RuleCondition>`	`getConditions()` The conditions.
`Boolean`	`getIsDefault()` Indicates whether this is the default rule.
`String`	`getPriority()` The priority.
`String`	`getRuleArn()` The Amazon Resource Name (ARN) of the rule.
`int`	`hashCode()`
`Boolean`	`isDefault()` Indicates whether this is the default rule.
`void`	`setActions(Collection<Action> actions)` The actions.
`void`	`setConditions(Collection<RuleCondition> conditions)` The conditions.
`void`	`setIsDefault(Boolean isDefault)` Indicates whether this is the default rule.
`void`	`setPriority(String priority)` The priority.
`void`	`setRuleArn(String ruleArn)` The Amazon Resource Name (ARN) of the rule.
`String`	`toString()` Returns a string representation of this object.
`Rule`	`withActions(Action... actions)` The actions.
`Rule`	`withActions(Collection<Action> actions)` The actions.
`Rule`	`withConditions(Collection<RuleCondition> conditions)` The conditions.
`Rule`	`withConditions(RuleCondition... conditions)` The conditions.
`Rule`	`withIsDefault(Boolean isDefault)` Indicates whether this is the default rule.
`Rule`	`withPriority(String priority)` The priority.
`Rule`	`withRuleArn(String ruleArn)` The Amazon Resource Name (ARN) of the rule.

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

- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - setRuleArn
```
public void setRuleArn(String ruleArn)
```
    The Amazon Resource Name (ARN) of the rule.
    
    Parameters:
    
    ruleArn - The Amazon Resource Name (ARN) of the rule.
  - getRuleArn
```
public String getRuleArn()
```
    The Amazon Resource Name (ARN) of the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the rule.
  - withRuleArn
```
public Rule withRuleArn(String ruleArn)
```
    The Amazon Resource Name (ARN) of the rule.
    
    Parameters:
    
    ruleArn - The Amazon Resource Name (ARN) of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(String priority)
```
    The priority.
    
    Parameters:
    
    priority - The priority.
  - getPriority
```
public String getPriority()
```
    The priority.
    
    Returns:
    
    The priority.
  - withPriority
```
public Rule withPriority(String priority)
```
    The priority.
    
    Parameters:
    
    priority - The priority.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getConditions
```
public List<RuleCondition> getConditions()
```
    The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
    
    Returns:
    
    The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
  - setConditions
```
public void setConditions(Collection<RuleCondition> conditions)
```
    The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
    
    Parameters:
    
    conditions - The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
  - withConditions
```
public Rule withConditions(RuleCondition... conditions)
```
    The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
    
    NOTE: This method appends the values to the existing list (if any). Use setConditions(java.util.Collection) or withConditions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    conditions - The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withConditions
```
public Rule withConditions(Collection<RuleCondition> conditions)
```
    The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
    
    Parameters:
    
    conditions - The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getActions
```
public List<Action> getActions()
```
    The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.
    
    Returns:
    
    The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.
  - setActions
```
public void setActions(Collection<Action> actions)
```
    The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.
    
    Parameters:
    
    actions - The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.
  - withActions
```
public Rule withActions(Action... actions)
```
    The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.
    
    NOTE: This method appends the values to the existing list (if any). Use setActions(java.util.Collection) or withActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    actions - The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withActions
```
public Rule withActions(Collection<Action> actions)
```
    The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.
    
    Parameters:
    
    actions - The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsDefault
```
public void setIsDefault(Boolean isDefault)
```
    Indicates whether this is the default rule.
    
    Parameters:
    
    isDefault - Indicates whether this is the default rule.
  - getIsDefault
```
public Boolean getIsDefault()
```
    Indicates whether this is the default rule.
    
    Returns:
    
    Indicates whether this is the default rule.
  - withIsDefault
```
public Rule withIsDefault(Boolean isDefault)
```
    Indicates whether this is the default rule.
    
    Parameters:
    
    isDefault - Indicates whether this is the default rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefault
```
public Boolean isDefault()
```
    Indicates whether this is the default rule.
    
    Returns:
    
    Indicates whether this is the default rule.
  - 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 Rule clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Method Detail

setRuleArn

getRuleArn

withRuleArn

setPriority

getPriority

withPriority

getConditions

setConditions

withConditions

withConditions

getActions

setActions

withActions

withActions

setIsDefault

getIsDefault

withIsDefault

isDefault

toString

equals

hashCode

clone