Package software.amazon.awssdk.services.cloudwatchevents.model

Class DescribeRuleResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.cloudwatchevents.model.DescribeRuleResponse

All Implemented Interfaces:

ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

@Generated("software.amazon.awssdk:codegen")
public class DescribeRuleResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeRuleResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the rule.
static DescribeRuleResponse.Builder	builder()
String	description()	The description of the rule.
boolean	equals(Object obj)
String	eventPattern()	The event pattern.
int	hashCode()
String	name()	The name of the rule.
String	roleArn()	The Amazon Resource Name (ARN) of the IAM role associated with the rule.
String	scheduleExpression()	The scheduling expression.
static Class<? extends DescribeRuleResponse.Builder>	serializableBuilderClass()
String	state()	Specifies whether the rule is enabled or disabled.
DescribeRuleResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

name

public String name()

The name of the rule.

Returns:

The name of the rule.

arn

public String arn()

The Amazon Resource Name (ARN) of the rule.

Returns:

The Amazon Resource Name (ARN) of the rule.

eventPattern

public String eventPattern()

The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

Returns:

The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

scheduleExpression

public String scheduleExpression()

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

Returns:

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

state

public String state()

Specifies whether the rule is enabled or disabled.

Returns:

Specifies whether the rule is enabled or disabled.

See Also:

RuleState

description

public String description()

The description of the rule.

Returns:

The description of the rule.

roleArn

public String roleArn()

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.

toBuilder

public DescribeRuleResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

Returns:

a builder for type T

builder

public static DescribeRuleResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeRuleResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object