@Generated(value="software.amazon.awssdk:codegen") public final class Rule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Rule.Builder,Rule>
Contains information about a rule in Amazon EventBridge.
Modifier and Type | Class and Description |
---|---|
static interface |
Rule.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
The Amazon Resource Name (ARN) of the rule.
|
static Rule.Builder |
builder() |
String |
description()
The description of the rule.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
eventBusName()
The name or ARN of the event bus associated with the rule.
|
String |
eventPattern()
The event pattern of the rule.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
managedBy()
If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the
principal name of the service that created the rule.
|
String |
name()
The name of the rule.
|
String |
roleArn()
The Amazon Resource Name (ARN) of the role that is used for target invocation.
|
String |
scheduleExpression()
The scheduling expression.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Rule.Builder> |
serializableBuilderClass() |
RuleState |
state()
The state of the rule.
|
String |
stateAsString()
The state of the rule.
|
Rule.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public 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 of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
public final RuleState state()
The state of the rule.
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()
.
RuleState
public final String stateAsString()
The state of the rule.
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()
.
RuleState
public final String description()
The description of the rule.
public final String scheduleExpression()
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
public final String roleArn()
The Amazon Resource Name (ARN) of the role that is used for target invocation.
If you're setting an event bus in another account as the target and that account granted permission to your
account through an organization instead of directly by the account ID, you must specify a RoleArn
with proper permissions in the Target
structure, instead of here in this parameter.
If you're setting an event bus in another account as the target and that account granted permission to
your account through an organization instead of directly by the account ID, you must specify a
RoleArn
with proper permissions in the Target
structure, instead of here in
this parameter.
public final String managedBy()
If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.
public final String eventBusName()
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
public Rule.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<Rule.Builder,Rule>
public static Rule.Builder builder()
public static Class<? extends Rule.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.