Rule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.eventbridge.model.Rule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Rule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about a rule in Amazon EventBridge.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the rule.
`String`	`getDescription()` The description of the rule.
`String`	`getEventBusName()` The event bus associated with the rule.
`String`	`getEventPattern()` The event pattern of the rule.
`String`	`getManagedBy()` If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
`String`	`getName()` The name of the rule.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the role that is used for target invocation.
`String`	`getScheduleExpression()` The scheduling expression: for example, `"cron(0 20 * * ? *)"` or `"rate(5 minutes)"`.
`String`	`getState()` The state of the rule.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the rule.
`void`	`setDescription(String description)` The description of the rule.
`void`	`setEventBusName(String eventBusName)` The event bus associated with the rule.
`void`	`setEventPattern(String eventPattern)` The event pattern of the rule.
`void`	`setManagedBy(String managedBy)` If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
`void`	`setName(String name)` The name of the rule.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that is used for target invocation.
`void`	`setScheduleExpression(String scheduleExpression)` The scheduling expression: for example, `"cron(0 20 * * ? *)"` or `"rate(5 minutes)"`.
`void`	`setState(String state)` The state of the rule.
`String`	`toString()` Returns a string representation of this object.
`Rule`	`withArn(String arn)` The Amazon Resource Name (ARN) of the rule.
`Rule`	`withDescription(String description)` The description of the rule.
`Rule`	`withEventBusName(String eventBusName)` The event bus associated with the rule.
`Rule`	`withEventPattern(String eventPattern)` The event pattern of the rule.
`Rule`	`withManagedBy(String managedBy)` If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
`Rule`	`withName(String name)` The name of the rule.
`Rule`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that is used for target invocation.
`Rule`	`withScheduleExpression(String scheduleExpression)` The scheduling expression: for example, `"cron(0 20 * * ? *)"` or `"rate(5 minutes)"`.
`Rule`	`withState(RuleState state)` The state of the rule.
`Rule`	`withState(String state)` The state of the rule.

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

- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the rule.
    
    Parameters:
    
    name - The name of the rule.
  - getName
```
public String getName()
```
    The name of the rule.
    
    Returns:
    
    The name of the rule.
  - withName
```
public Rule withName(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.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the rule.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the rule.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the rule.
  - withArn
```
public Rule withArn(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.
  - setEventPattern
```
public void setEventPattern(String eventPattern)
```
    The event pattern of the rule. For more information, see Event Patterns in the Amazon EventBridge User Guide.
    
    Parameters:
    
    eventPattern - The event pattern of the rule. For more information, see Event Patterns in the Amazon EventBridge User Guide.
  - getEventPattern
```
public String getEventPattern()
```
    The event pattern of the rule. For more information, see Event Patterns in the Amazon EventBridge User Guide.
    
    Returns:
    
    The event pattern of the rule. For more information, see Event Patterns in the Amazon EventBridge User Guide.
  - withEventPattern
```
public Rule withEventPattern(String eventPattern)
```
    The event pattern of the rule. For more information, see Event Patterns in the Amazon EventBridge User Guide.
    
    Parameters:
    
    eventPattern - The event pattern of the rule. For more information, see 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.
    
    Parameters:
    
    state - The state of the rule.
    
    See Also:
    
    RuleState
  - getState
```
public String getState()
```
    The state of the rule.
    
    Returns:
    
    The state of the rule.
    
    See Also:
    
    RuleState
  - withState
```
public Rule withState(String state)
```
    The state of the rule.
    
    Parameters:
    
    state - The state of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleState
  - withState
```
public Rule withState(RuleState state)
```
    The state of the rule.
    
    Parameters:
    
    state - The state of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleState
  - setDescription
```
public void setDescription(String description)
```
    The description of the rule.
    
    Parameters:
    
    description - The description of the rule.
  - getDescription
```
public String getDescription()
```
    The description of the rule.
    
    Returns:
    
    The description of the rule.
  - withDescription
```
public Rule withDescription(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.
  - 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 Rule 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.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role that is used for target invocation.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
  - withRoleArn
```
public Rule withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that is used for target invocation.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role that is used for target invocation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setManagedBy
```
public void setManagedBy(String managedBy)
```
    If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
    
    Parameters:
    
    managedBy - If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
  - getManagedBy
```
public String getManagedBy()
```
    If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
    
    Returns:
    
    If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
  - withManagedBy
```
public Rule withManagedBy(String managedBy)
```
    If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
    
    Parameters:
    
    managedBy - If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventBusName
```
public void setEventBusName(String eventBusName)
```
    The event bus associated with the rule.
    
    Parameters:
    
    eventBusName - The event bus associated with the rule.
  - getEventBusName
```
public String getEventBusName()
```
    The event bus associated with the rule.
    
    Returns:
    
    The event bus associated with the rule.
  - withEventBusName
```
public Rule withEventBusName(String eventBusName)
```
    The event bus associated with the rule.
    
    Parameters:
    
    eventBusName - The event bus associated with the rule.
    
    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 Rule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Method Detail

setName

getName

withName

setArn

getArn

withArn

setEventPattern

getEventPattern

withEventPattern

setState

getState

withState

withState

setDescription

getDescription

withDescription

setScheduleExpression

getScheduleExpression

withScheduleExpression

setRoleArn

getRoleArn

withRoleArn

setManagedBy

getManagedBy

withManagedBy

setEventBusName

getEventBusName

withEventBusName

toString

equals

hashCode

clone

marshall