Class Rule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Rule.Builder,
Rule>
Contains information about a rule in Amazon EventBridge.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the rule.static Rule.Builder
builder()
final String
The description of the rule.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name or ARN of the event bus associated with the rule.final String
The event pattern of the rule.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
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.final String
name()
The name of the rule.final String
roleArn()
The Amazon Resource Name (ARN) of the role that is used for target invocation.final String
The scheduling expression.static Class
<? extends Rule.Builder> final RuleState
state()
The state of the rule.final String
The state of the rule.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the rule.
- Returns:
- The name of the rule.
-
arn
The Amazon Resource Name (ARN) of the rule.
- Returns:
- The Amazon Resource Name (ARN) of the rule.
-
eventPattern
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
- Returns:
- The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
-
state
The state of the rule.
If the service returns an enum value that is not available in the current SDK version,
state
will returnRuleState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the rule.
- See Also:
-
stateAsString
The state of the rule.
If the service returns an enum value that is not available in the current SDK version,
state
will returnRuleState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the rule.
- See Also:
-
description
The description of the rule.
- Returns:
- The description of the rule.
-
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.
- Returns:
- 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.
-
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 theTarget
structure, instead of here in this parameter.- Returns:
- 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 theTarget
structure, instead of here in this parameter.
-
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.
- Returns:
- 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.
-
eventBusName
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
- Returns:
- The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
-
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 interfaceToCopyableBuilder<Rule.Builder,
Rule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-