software.amazon.awssdk.services.cloudwatchevents.model

Class DescribeRuleResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cloudwatchevents.model.CloudWatchEventsResponse

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

All Implemented Interfaces:

ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeRuleResponse
extends CloudWatchEventsResponse
implements ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeRuleResponse.Builder

Method Summary

Modifier and Type	Method and 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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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()
RuleState	state() Specifies whether the rule is enabled or disabled.
String	stateAsString() Specifies whether the rule is enabled or disabled.
DescribeRuleResponse.Builder	toBuilder()
String	toString()

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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 RuleState state()

Specifies whether the rule is enabled or disabled.

If the service returns an enum value that is not available in the current SDK version, state will return RuleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

Specifies whether the rule is enabled or disabled.

See Also:

RuleState

stateAsString

public String stateAsString()

Specifies whether the rule is enabled or disabled.

If the service returns an enum value that is not available in the current SDK version, state will return RuleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

Overrides:

toBuilder in class AwsResponse

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse