Package software.amazon.awssdk.services.eventbridge.model

Class PutRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest

software.amazon.awssdk.services.eventbridge.model.PutRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutRuleRequest.Builder

Method Summary

Modifier and Type	Method	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.

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 final 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 final 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 final String eventPattern()

The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

Returns:

The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

state

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

Returns:

Indicates whether the rule is enabled or disabled.

See Also:

RuleState

stateAsString

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

Returns:

Indicates whether the rule is enabled or disabled.

See Also:

RuleState

description

public final String description()

A description of the rule.

Returns:

A description of the rule.

roleArn

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.

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 the Target 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 the 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.

tags

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.

Returns:

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

eventBusName

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.

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 EventBridgeRequest

builder

public static PutRuleRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo