software.amazon.awssdk.services.cloudwatchevents.model

Class PutRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchevents.model.CloudWatchEventsRequest

software.amazon.awssdk.services.cloudwatchevents.model.PutRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutRuleRequest
extends CloudWatchEventsRequest
implements ToCopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutRuleRequest.Builder

Method Summary

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() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String 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

public String 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

public String 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

public 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().

Returns:

Indicates whether the rule is enabled or disabled.

See Also:

RuleState

stateAsString

public 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().

Returns:

Indicates whether the rule is enabled or disabled.

See Also:

RuleState

description

public String description()

A description of the rule.

Returns:

A description of the rule.

roleArn

public String roleArn()

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Returns:

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public 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.

You can use hasTags() to see if a value was sent in this field.

Returns:

The list of key-value pairs to associate with the rule.

eventBusName

public 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.

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

public PutRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>

Specified by:

toBuilder in class CloudWatchEventsRequest

builder

public static PutRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutRuleRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String 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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo