com.amazonaws.services.cloudwatchevents.model

Class PutRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatchevents.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()

Method Summary

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	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() Indicates whether the rule is enabled or disabled.
int	hashCode()
void	setDescription(String description) A description of the 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(RuleState state) Indicates whether the rule is enabled or disabled.
void	setState(String state) Indicates whether the rule is enabled or disabled.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutRuleRequest	withDescription(String description) A description of the 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) Indicates whether the rule is enabled or disabled.
PutRuleRequest	withState(String state) Indicates whether the rule is enabled or disabled.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

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 Events and Event Patterns in the Amazon CloudWatch Events User Guide.

Parameters:

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

getEventPattern

public String getEventPattern()

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

Returns:

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

withEventPattern

public PutRuleRequest withEventPattern(String eventPattern)

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

Parameters:

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

Returns:

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

setState

public void setState(String state)

Indicates whether the rule is enabled or disabled.

Parameters:

state - Indicates whether the rule is enabled or disabled.

See Also:

RuleState

getState

public String getState()

Indicates whether the rule is enabled or disabled.

Returns:

Indicates whether the rule is enabled or disabled.

See Also:

RuleState

withState

public PutRuleRequest withState(String state)

Indicates whether the rule is enabled or disabled.

Parameters:

state - Indicates 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

setState

public void setState(RuleState state)

Indicates whether the rule is enabled or disabled.

Parameters:

state - Indicates whether the rule is enabled or disabled.

See Also:

RuleState

withState

public PutRuleRequest withState(RuleState state)

Indicates whether the rule is enabled or disabled.

Parameters:

state - Indicates 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

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.

Parameters:

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

getRoleArn

public String getRoleArn()

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.

withRoleArn

public PutRuleRequest withRoleArn(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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

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