DescribeRuleResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.cloudwatchevents.model.DescribeRuleResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeRuleResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

The result of the DescribeRule operation.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeRuleResult()

Constructors
Constructor and Description
`DescribeRuleResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeRuleResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) associated with the rule.
`String`	`getDescription()` The rule's description.
`String`	`getEventPattern()` The event pattern.
`String`	`getName()` The rule's name.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the IAM role associated with the rule.
`String`	`getScheduleExpression()` The scheduling expression.
`String`	`getState()` Specifies whether the rule is enabled or disabled.
`int`	`hashCode()`
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) associated with the rule.
`void`	`setDescription(String description)` The rule's description.
`void`	`setEventPattern(String eventPattern)` The event pattern.
`void`	`setName(String name)` The rule's name.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role associated with the rule.
`void`	`setScheduleExpression(String scheduleExpression)` The scheduling expression.
`void`	`setState(RuleState state)` Specifies whether the rule is enabled or disabled.
`void`	`setState(String state)` Specifies whether the rule is enabled or disabled.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeRuleResult`	`withArn(String arn)` The Amazon Resource Name (ARN) associated with the rule.
`DescribeRuleResult`	`withDescription(String description)` The rule's description.
`DescribeRuleResult`	`withEventPattern(String eventPattern)` The event pattern.
`DescribeRuleResult`	`withName(String name)` The rule's name.
`DescribeRuleResult`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role associated with the rule.
`DescribeRuleResult`	`withScheduleExpression(String scheduleExpression)` The scheduling expression.
`DescribeRuleResult`	`withState(RuleState state)` Specifies whether the rule is enabled or disabled.
`DescribeRuleResult`	`withState(String state)` Specifies whether the rule is enabled or disabled.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeRuleResult
```
public DescribeRuleResult()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The rule's name.
    
    Parameters:
    
    name - The rule's name.
  - getName
```
public String getName()
```
    The rule's name.
    
    Returns:
    
    The rule's name.
  - withName
```
public DescribeRuleResult withName(String name)
```
    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
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) associated with the rule.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) associated with the rule.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) associated with the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) associated with the rule.
  - withArn
```
public DescribeRuleResult withArn(String arn)
```
    The Amazon Resource Name (ARN) associated with the rule.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) associated with the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventPattern
```
public void setEventPattern(String eventPattern)
```
    The event pattern.
    
    Parameters:
    
    eventPattern - The event pattern.
  - getEventPattern
```
public String getEventPattern()
```
    The event pattern.
    
    Returns:
    
    The event pattern.
  - withEventPattern
```
public DescribeRuleResult withEventPattern(String eventPattern)
```
    The event pattern.
    
    Parameters:
    
    eventPattern - The event pattern.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScheduleExpression
```
public void setScheduleExpression(String scheduleExpression)
```
    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
```
public String 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
```
public DescribeRuleResult withScheduleExpression(String scheduleExpression)
```
    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.
  - setState
```
public void setState(String state)
```
    Specifies whether the rule is enabled or disabled.
    
    Parameters:
    
    state - Specifies whether the rule is enabled or disabled.
    
    See Also:
    
    RuleState
  - getState
```
public String getState()
```
    Specifies whether the rule is enabled or disabled.
    
    Returns:
    
    Specifies whether the rule is enabled or disabled.
    
    See Also:
    
    RuleState
  - withState
```
public DescribeRuleResult withState(String state)
```
    Specifies whether the rule is enabled or disabled.
    
    Parameters:
    
    state - Specifies whether the rule is enabled or disabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleState
  - setState
```
public void setState(RuleState state)
```
    Specifies whether the rule is enabled or disabled.
    
    Parameters:
    
    state - Specifies whether the rule is enabled or disabled.
    
    See Also:
    
    RuleState
  - withState
```
public DescribeRuleResult withState(RuleState state)
```
    Specifies whether the rule is enabled or disabled.
    
    Parameters:
    
    state - Specifies whether the rule is enabled or disabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleState
  - setDescription
```
public void setDescription(String description)
```
    The rule's description.
    
    Parameters:
    
    description - The rule's description.
  - getDescription
```
public String getDescription()
```
    The rule's description.
    
    Returns:
    
    The rule's description.
  - withDescription
```
public DescribeRuleResult withDescription(String description)
```
    The rule's description.
    
    Parameters:
    
    description - The rule's description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role associated with the rule.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the rule.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role associated with the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role associated with the rule.
  - withRoleArn
```
public DescribeRuleResult withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role associated with the rule.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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 DescribeRuleResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeRuleResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeRuleResult

Method Detail

setName

getName

withName

setArn

getArn

withArn

setEventPattern

getEventPattern

withEventPattern

setScheduleExpression

getScheduleExpression

withScheduleExpression

setState

getState

withState

setState

withState

setDescription

getDescription

withDescription

setRoleArn

getRoleArn

withRoleArn

toString

equals

hashCode

clone