Class PutRuleRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutRuleRequest.Builder,
PutRuleRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PutRuleRequest.Builder
builder()
final String
A 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 to associate with this rule.final String
The event pattern.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
The name of the rule that you are creating or updating.final String
roleArn()
The Amazon Resource Name (ARN) of the IAM role associated with the rule.final String
The scheduling expression.static Class
<? extends PutRuleRequest.Builder> final RuleState
state()
Indicates whether the rule is enabled or disabled.final String
Indicates whether the rule is enabled or disabled.tags()
The list of key-value pairs to associate with 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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the rule that you are creating or updating.
- Returns:
- The name of the rule that you are creating or updating.
-
scheduleExpression
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
- Returns:
- The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
-
eventPattern
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
- Returns:
- The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
-
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 returnRuleState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Indicates whether the rule is enabled or disabled.
- See Also:
-
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 returnRuleState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Indicates whether the rule is enabled or disabled.
- See Also:
-
description
A description of the rule.
- Returns:
- A description of the rule.
-
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 theTarget
structure, instead of here in this parameter.- Returns:
- 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 theTarget
structure, instead of here in this parameter.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The list of key-value pairs to associate with the rule.
-
eventBusName
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
- Returns:
- The name or ARN of the event bus to associate with this 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<PutRuleRequest.Builder,
PutRuleRequest> - Specified by:
toBuilder
in classCloudWatchEventsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-