@Generated(value="software.amazon.awssdk:codegen") public final class PutRuleRequest extends EventBridgeRequest implements ToCopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
PutRuleRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static PutRuleRequest.Builder |
builder() |
String |
description()
A description of the rule.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
eventBusName()
The name or ARN of the event bus to associate with this rule.
|
String |
eventPattern()
The event pattern.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
name()
The name of the rule that you are creating or updating.
|
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 PutRuleRequest.Builder> |
serializableBuilderClass() |
RuleState |
state()
Indicates whether the rule is enabled or disabled.
|
String |
stateAsString()
Indicates whether the rule is enabled or disabled.
|
List<Tag> |
tags()
The list of key-value pairs to associate with the rule.
|
PutRuleRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
The name of the rule that you are creating or updating.
public final String scheduleExpression()
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
public final String eventPattern()
The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.
public final RuleState state()
Indicates 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()
Indicates 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()
A description of the rule.
public final String roleArn()
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
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 boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
The list of key-value pairs to associate with the rule.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final String eventBusName()
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
public PutRuleRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>toBuilder in class EventBridgeRequestpublic static PutRuleRequest.Builder builder()
public static Class<? extends PutRuleRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.