@Generated(value="software.amazon.awssdk:codegen") public final class DescribeRuleResponse extends CloudWatchEventsResponse implements ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeRuleResponse.Builder |
| Modifier and Type | Method and 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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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)
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 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()
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.
|
responseMetadatasdkHttpResponsecopypublic final String name()
The name of the rule.
public final String arn()
The Amazon Resource Name (ARN) of the rule.
public final String eventPattern()
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
public final String scheduleExpression()
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
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().
RuleStatepublic 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().
RuleStatepublic final String description()
The description of the rule.
public final String roleArn()
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
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.
public final String eventBusName()
The name of the event bus associated with the rule.
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.
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.public DescribeRuleResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>toBuilder in class AwsResponsepublic static DescribeRuleResponse.Builder builder()
public static Class<? extends DescribeRuleResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.