Class Rule
- All Implemented Interfaces:
Serializable
,Cloneable
Contains information about a rule in Amazon CloudWatch Events. A ListRulesResult contains a list of Rules.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
getArn()
The Amazon Resource Name (ARN) of the rule.The description of the rule.The event pattern of the rule.getName()
The rule's name.The Amazon Resource Name (ARN) associated with the role that is used for target invocation.The scheduling expression.getState()
The rule's state.int
hashCode()
void
The Amazon Resource Name (ARN) of the rule.void
setDescription
(String description) The description of the rule.void
setEventPattern
(String eventPattern) The event pattern of the rule.void
The rule's name.void
setRoleArn
(String roleArn) The Amazon Resource Name (ARN) associated with the role that is used for target invocation.void
setScheduleExpression
(String scheduleExpression) The scheduling expression.void
The rule's state.void
The rule's state.toString()
Returns a string representation of this object; useful for testing and debugging.The Amazon Resource Name (ARN) of the rule.withDescription
(String description) The description of the rule.withEventPattern
(String eventPattern) The event pattern of the rule.The rule's name.withRoleArn
(String roleArn) The Amazon Resource Name (ARN) associated with the role that is used for target invocation.withScheduleExpression
(String scheduleExpression) The scheduling expression.The rule's state.The rule's state.
-
Constructor Details
-
Rule
public Rule()
-
-
Method Details
-
setName
The rule's name.
- Parameters:
name
- The rule's name.
-
getName
The rule's name.
- Returns:
- The rule's name.
-
withName
The rule's name.
- Parameters:
name
- The rule's name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setArn
The Amazon Resource Name (ARN) of the rule.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the rule.
-
getArn
The Amazon Resource Name (ARN) of the rule.
- Returns:
- The Amazon Resource Name (ARN) of the rule.
-
withArn
The Amazon Resource Name (ARN) of the rule.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEventPattern
The event pattern of the rule.
- Parameters:
eventPattern
- The event pattern of the rule.
-
getEventPattern
The event pattern of the rule.
- Returns:
- The event pattern of the rule.
-
withEventPattern
The event pattern of the rule.
- Parameters:
eventPattern
- The event pattern of the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setState
The rule's state.
- Parameters:
state
- The rule's state.- See Also:
-
getState
The rule's state.
- Returns:
- The rule's state.
- See Also:
-
withState
The rule's state.
- Parameters:
state
- The rule's state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setState
The rule's state.
- Parameters:
state
- The rule's state.- See Also:
-
withState
The rule's state.
- Parameters:
state
- The rule's state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setDescription
The description of the rule.
- Parameters:
description
- The description of the rule.
-
getDescription
The description of the rule.
- Returns:
- The description of the rule.
-
withDescription
The description of the rule.
- Parameters:
description
- The description of the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setScheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
- Parameters:
scheduleExpression
- The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
-
getScheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
- Returns:
- The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
-
withScheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
- Parameters:
scheduleExpression
- The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRoleArn
The Amazon Resource Name (ARN) associated with the role that is used for target invocation.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) associated with the role that is used for target invocation.
-
getRoleArn
The Amazon Resource Name (ARN) associated with the role that is used for target invocation.
- Returns:
- The Amazon Resource Name (ARN) associated with the role that is used for target invocation.
-
withRoleArn
The Amazon Resource Name (ARN) associated with the role that is used for target invocation.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) associated with the role that is used for target invocation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-