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:

SdkPojo, 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)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	eventBusName() The event bus associated with the rule.
String	eventPattern() The event pattern.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	managedBy() If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of the AWS service that created the rule.
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.
List<SdkField<?>>	sdkFields()
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cloudwatchevents.model.CloudWatchEventsResponse

responseMetadata

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

sdkHttpResponse

Methods inherited from class java.lang.Object

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 EventBridge User Guide.

Returns:

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge 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.

managedBy

public String managedBy()

If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of the AWS service that created the rule.

Returns:

If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of the AWS service that created the rule.

eventBusName

public String eventBusName()

The event bus associated with the rule.

Returns:

The event bus 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>

Specified by:

toBuilder in class AwsResponse

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 AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

getValueForField

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

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.