PutRuleRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.eventbridge.model.PutRuleRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

PutRuleRequest()

Constructors
Constructor and Description
`PutRuleRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutRuleRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A description of the rule.
`String`	`getEventBusName()` The name or ARN of the event bus to associate with this rule.
`String`	`getEventPattern()` The event pattern.
`String`	`getName()` The name of the rule that you are creating or updating.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the IAM role associated with the rule.
`String`	`getScheduleExpression()` The scheduling expression.
`String`	`getState()` The state of the rule.
`List<Tag>`	`getTags()` The list of key-value pairs to associate with the rule.
`int`	`hashCode()`
`void`	`setDescription(String description)` A description of the rule.
`void`	`setEventBusName(String eventBusName)` The name or ARN of the event bus to associate with this rule.
`void`	`setEventPattern(String eventPattern)` The event pattern.
`void`	`setName(String name)` The name of the rule that you are creating or updating.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role associated with the rule.
`void`	`setScheduleExpression(String scheduleExpression)` The scheduling expression.
`void`	`setState(String state)` The state of the rule.
`void`	`setTags(Collection<Tag> tags)` The list of key-value pairs to associate with the rule.
`String`	`toString()` Returns a string representation of this object.
`PutRuleRequest`	`withDescription(String description)` A description of the rule.
`PutRuleRequest`	`withEventBusName(String eventBusName)` The name or ARN of the event bus to associate with this rule.
`PutRuleRequest`	`withEventPattern(String eventPattern)` The event pattern.
`PutRuleRequest`	`withName(String name)` The name of the rule that you are creating or updating.
`PutRuleRequest`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role associated with the rule.
`PutRuleRequest`	`withScheduleExpression(String scheduleExpression)` The scheduling expression.
`PutRuleRequest`	`withState(RuleState state)` The state of the rule.
`PutRuleRequest`	`withState(String state)` The state of the rule.
`PutRuleRequest`	`withTags(Collection<Tag> tags)` The list of key-value pairs to associate with the rule.
`PutRuleRequest`	`withTags(Tag... tags)` The list of key-value pairs to associate with the rule.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutRuleRequest
```
public PutRuleRequest()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the rule that you are creating or updating.
    
    Parameters:
    
    name - The name of the rule that you are creating or updating.
  - getName
```
public String getName()
```
    The name of the rule that you are creating or updating.
    
    Returns:
    
    The name of the rule that you are creating or updating.
  - withName
```
public PutRuleRequest withName(String name)
```
    The name of the rule that you are creating or updating.
    
    Parameters:
    
    name - The name of the rule that you are creating or updating.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScheduleExpression
```
public void setScheduleExpression(String scheduleExpression)
```
    The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
    
    Parameters:
    
    scheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
  - getScheduleExpression
```
public String getScheduleExpression()
```
    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)".
  - withScheduleExpression
```
public PutRuleRequest withScheduleExpression(String scheduleExpression)
```
    The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
    
    Parameters:
    
    scheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventPattern
```
public void setEventPattern(String eventPattern)
```
    The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
    
    Parameters:
    
    eventPattern - The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
  - getEventPattern
```
public String getEventPattern()
```
    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 .
  - withEventPattern
```
public PutRuleRequest withEventPattern(String eventPattern)
```
    The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
    
    Parameters:
    
    eventPattern - The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The state of the rule.
    
    Valid values include:
    - DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    - ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
    - ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.
      
      Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
      
      This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
    Parameters:
    state - The state of the rule.
    
    Valid values include:
    
    DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    
    ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
    
    ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.
    
    Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
    
    This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
    See Also:
    
    RuleState
  - getState
```
public String getState()
```
    The state of the rule.
    
    Valid values include:
    - DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    - ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
    - ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.
      
      Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
      
      This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
    Returns:
    The state of the rule.
    
    Valid values include:
    
    DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    
    ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
    
    ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.
    
    Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
    
    This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
    See Also:
    
    RuleState
  - withState
```
public PutRuleRequest withState(String state)
```
    The state of the rule.
    
    Valid values include:
    - DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    - ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
    - ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.
      
      Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
      
      This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
    Parameters:
    state - The state of the rule.
    
    Valid values include:
    
    DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    
    ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
    
    ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.
    
    Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
    
    This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleState
  - withState
```
public PutRuleRequest withState(RuleState state)
```
    The state of the rule.
    
    Valid values include:
    - DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    - ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
    - ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.
      
      Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
      
      This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
    Parameters:
    state - The state of the rule.
    
    Valid values include:
    
    DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
    
    ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
    
    ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.
    
    Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
    
    This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleState
  - setDescription
```
public void setDescription(String description)
```
    A description of the rule.
    
    Parameters:
    
    description - A description of the rule.
  - getDescription
```
public String getDescription()
```
    A description of the rule.
    
    Returns:
    
    A description of the rule.
  - withDescription
```
public PutRuleRequest withDescription(String description)
```
    A description of the rule.
    
    Parameters:
    
    description - A description of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(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.
    
    Parameters:
    
    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.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public PutRuleRequest withRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The list of key-value pairs to associate with the rule.
    
    Returns:
    
    The list of key-value pairs to associate with the rule.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The list of key-value pairs to associate with the rule.
    
    Parameters:
    
    tags - The list of key-value pairs to associate with the rule.
  - withTags
```
public PutRuleRequest withTags(Tag... tags)
```
    The list of key-value pairs to associate with the rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The list of key-value pairs to associate with the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public PutRuleRequest withTags(Collection<Tag> tags)
```
    The list of key-value pairs to associate with the rule.
    
    Parameters:
    
    tags - The list of key-value pairs to associate with the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventBusName
```
public void setEventBusName(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.
    
    Parameters:
    
    eventBusName - The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
  - getEventBusName
```
public String getEventBusName()
```
    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.
  - withEventBusName
```
public PutRuleRequest withEventBusName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutRuleRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.772

Class PutRuleRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutRuleRequest

Method Detail

setName

getName

withName

setScheduleExpression

getScheduleExpression

withScheduleExpression

setEventPattern

getEventPattern

withEventPattern

setState

getState

withState

withState

setDescription

getDescription

withDescription

setRoleArn

getRoleArn

withRoleArn

getTags

setTags

withTags

withTags

setEventBusName

getEventBusName

withEventBusName

toString

equals

hashCode

clone