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

Interface DescribeRuleResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>, EventBridgeResponse.Builder, SdkBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeRuleResponse

public static interface DescribeRuleResponse.Builder
extends EventBridgeResponse.Builder, SdkPojo, CopyableBuilder<DescribeRuleResponse.Builder,DescribeRuleResponse>

Method Summary

Modifier and Type	Method	Description
DescribeRuleResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the rule.
DescribeRuleResponse.Builder	createdBy(String createdBy)	The account ID of the user that created the rule.
DescribeRuleResponse.Builder	description(String description)	The description of the rule.
DescribeRuleResponse.Builder	eventBusName(String eventBusName)	The name of the event bus associated with the rule.
DescribeRuleResponse.Builder	eventPattern(String eventPattern)	The event pattern.
DescribeRuleResponse.Builder	managedBy(String managedBy)	If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
DescribeRuleResponse.Builder	name(String name)	The name of the rule.
DescribeRuleResponse.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role associated with the rule.
DescribeRuleResponse.Builder	scheduleExpression(String scheduleExpression)	The scheduling expression.
DescribeRuleResponse.Builder	state(String state)	Specifies whether the rule is enabled or disabled.
DescribeRuleResponse.Builder	state(RuleState state)	Specifies whether the rule is enabled or disabled.

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

copy

Methods inherited from interface software.amazon.awssdk.services.eventbridge.model.EventBridgeResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

name

DescribeRuleResponse.Builder name(String name)

The name of the rule.

Parameters:

name - The name of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

arn

DescribeRuleResponse.Builder arn(String arn)

The Amazon Resource Name (ARN) of the rule.

Parameters:

arn - The Amazon Resource Name (ARN) of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

eventPattern

DescribeRuleResponse.Builder eventPattern(String eventPattern)

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Parameters:

eventPattern - The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

scheduleExpression

DescribeRuleResponse.Builder scheduleExpression(String scheduleExpression)

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

Parameters:

scheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

Returns:

Returns a reference to this object so that method calls can be chained together.

state

DescribeRuleResponse.Builder state(String state)

Specifies whether the rule is enabled or disabled.

Parameters:

state - Specifies whether the rule is enabled or disabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RuleState, RuleState

state

DescribeRuleResponse.Builder state(RuleState state)

Specifies whether the rule is enabled or disabled.

Parameters:

state - Specifies whether the rule is enabled or disabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RuleState, RuleState

description

DescribeRuleResponse.Builder description(String description)

The description of the rule.

Parameters:

description - The description of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

DescribeRuleResponse.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

managedBy

DescribeRuleResponse.Builder managedBy(String managedBy)

If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

Parameters:

managedBy - If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

eventBusName

DescribeRuleResponse.Builder eventBusName(String eventBusName)

The name of the event bus associated with the rule.

Parameters:

eventBusName - The name of the event bus associated with the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdBy

DescribeRuleResponse.Builder createdBy(String createdBy)

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Parameters:

createdBy - The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

Returns:

Returns a reference to this object so that method calls can be chained together.