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

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) of the rule.
`String`	`getCreatedBy()` The account ID of the user that created the rule.
`String`	`getDescription()` The description of the rule.
`String`	`getEventBusName()` The name of the event bus associated with the rule.
`String`	`getEventPattern()` The event pattern.
`String`	`getManagedBy()` If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
`String`	`getName()` The name of the rule.
`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) of the rule.
`void`	`setCreatedBy(String createdBy)` The account ID of the user that created the rule.
`void`	`setDescription(String description)` The description of the rule.
`void`	`setEventBusName(String eventBusName)` The name of the event bus associated with the rule.
`void`	`setEventPattern(String eventPattern)` The event pattern.
`void`	`setManagedBy(String managedBy)` If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
`void`	`setName(String name)` The name of the rule.
`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.
`DescribeRuleResult`	`withArn(String arn)` The Amazon Resource Name (ARN) of the rule.
`DescribeRuleResult`	`withCreatedBy(String createdBy)` The account ID of the user that created the rule.
`DescribeRuleResult`	`withDescription(String description)` The description of the rule.
`DescribeRuleResult`	`withEventBusName(String eventBusName)` The name of the event bus associated with the rule.
`DescribeRuleResult`	`withEventPattern(String eventPattern)` The event pattern.
`DescribeRuleResult`	`withManagedBy(String managedBy)` If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
`DescribeRuleResult`	`withName(String name)` The name of the rule.
`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 name of the rule.
    
    Parameters:
    
    name - The name of the rule.
  - getName
```
public String getName()
```
    The name of the rule.
    
    Returns:
    
    The name of the rule.
  - withName
```
public DescribeRuleResult withName(String name)
```
    The name of the rule.
    
    Parameters:
    
    name - The name of the rule.
    
    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) of the rule.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the rule.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the rule.
  - withArn
```
public DescribeRuleResult withArn(String arn)
```
    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
```
public void setEventPattern(String eventPattern)
```
    The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
    
    Parameters:
    
    eventPattern - The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
  - getEventPattern
```
public String getEventPattern()
```
    The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
    
    Returns:
    
    The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
  - withEventPattern
```
public DescribeRuleResult withEventPattern(String eventPattern)
```
    The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
    
    Parameters:
    
    eventPattern - The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
    
    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 description of the rule.
    
    Parameters:
    
    description - The description of the rule.
  - getDescription
```
public String getDescription()
```
    The description of the rule.
    
    Returns:
    
    The description of the rule.
  - withDescription
```
public DescribeRuleResult withDescription(String description)
```
    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.
  - 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.
  - setManagedBy
```
public void setManagedBy(String managedBy)
```
    If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
    
    Parameters:
    
    managedBy - If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
  - getManagedBy
```
public String getManagedBy()
```
    If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
    
    Returns:
    
    If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
  - withManagedBy
```
public DescribeRuleResult withManagedBy(String managedBy)
```
    If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
    
    Parameters:
    
    managedBy - If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventBusName
```
public void setEventBusName(String eventBusName)
```
    The name of the event bus associated with the rule.
    
    Parameters:
    
    eventBusName - The name of the event bus associated with the rule.
  - getEventBusName
```
public String getEventBusName()
```
    The name of the event bus associated with the rule.
    
    Returns:
    
    The name of the event bus associated with the rule.
  - withEventBusName
```
public DescribeRuleResult withEventBusName(String eventBusName)
```
    The name of the event bus associated with the rule.
    
    Parameters:
    
    eventBusName - The name of the event bus associated with the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.
    
    Parameters:
    
    createdBy - The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.
  - getCreatedBy
```
public String getCreatedBy()
```
    The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.
    
    Returns:
    
    The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.
  - withCreatedBy
```
public DescribeRuleResult withCreatedBy(String createdBy)
```
    The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.
    
    Parameters:
    
    createdBy - The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.
    
    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. 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 DescribeRuleResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

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

setManagedBy

getManagedBy

withManagedBy

setEventBusName

getEventBusName

withEventBusName

setCreatedBy

getCreatedBy

withCreatedBy

toString

equals

hashCode

clone