Package software.amazon.awssdk.services.eventbridge.model

Class DescribeRuleResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.eventbridge.model.EventBridgeResponse

software.amazon.awssdk.services.eventbridge.model.DescribeRuleResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeRuleResponse
extends EventBridgeResponse
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	createdBy()	The account ID of the user that created the rule.
String	description()	The description of the rule.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventBusName()	The name of the event bus associated with the rule.
String	eventPattern()	The event pattern.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
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()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.eventbridge.model.EventBridgeResponse

responseMetadata

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 final String name()

The name of the rule.

Returns:

The name of the rule.

arn

public final String arn()

The Amazon Resource Name (ARN) of the rule.

Returns:

The Amazon Resource Name (ARN) of the rule.

eventPattern

public final 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 final 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 final 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 final 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 final String description()

The description of the rule.

Returns:

The description of the rule.

roleArn

public final 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 final 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.

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.

eventBusName

public final String eventBusName()

The name of the event bus associated with the rule.

Returns:

The name of the event bus associated with the rule.

createdBy

public final 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.

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.

toBuilder

public DescribeRuleResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeRuleResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo