@Generated(value="software.amazon.awssdk:codegen") public 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 |
description()
The description of the rule.
|
boolean |
equals(Object obj) |
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 |
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 |
stateString()
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() |
copy
public String name()
The name of the rule.
public String arn()
The Amazon Resource Name (ARN) of the rule.
public String eventPattern()
The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.
public String scheduleExpression()
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
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
stateString()
.
RuleState
public String stateString()
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
stateString()
.
RuleState
public String description()
The description of the rule.
public String roleArn()
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
public DescribeRuleResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>
toBuilder
in class AwsResponse
public static DescribeRuleResponse.Builder builder()
public static Class<? extends DescribeRuleResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.