com.amazonaws.services.redshift.model

Class ModifyScheduledActionResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.redshift.model.ModifyScheduledActionResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyScheduledActionResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModifyScheduledActionResult()

Method Summary

Modifier and Type	Method and Description
ModifyScheduledActionResult	clone()
boolean	equals(Object obj)
Date	getEndTime() The end time in UTC when the schedule is no longer active.
String	getIamRole() The IAM role to assume to run the scheduled action.
List<Date>	getNextInvocations() List of times when the scheduled action will run.
String	getSchedule() The schedule for a one-time (at format) or recurring (cron format) scheduled action.
String	getScheduledActionDescription() The description of the scheduled action.
String	getScheduledActionName() The name of the scheduled action.
Date	getStartTime() The start time in UTC when the schedule is active.
String	getState() The state of the scheduled action.
ScheduledActionType	getTargetAction() A JSON format string of the Amazon Redshift API operation with input parameters.
int	hashCode()
void	setEndTime(Date endTime) The end time in UTC when the schedule is no longer active.
void	setIamRole(String iamRole) The IAM role to assume to run the scheduled action.
void	setNextInvocations(Collection<Date> nextInvocations) List of times when the scheduled action will run.
void	setSchedule(String schedule) The schedule for a one-time (at format) or recurring (cron format) scheduled action.
void	setScheduledActionDescription(String scheduledActionDescription) The description of the scheduled action.
void	setScheduledActionName(String scheduledActionName) The name of the scheduled action.
void	setStartTime(Date startTime) The start time in UTC when the schedule is active.
void	setState(String state) The state of the scheduled action.
void	setTargetAction(ScheduledActionType targetAction) A JSON format string of the Amazon Redshift API operation with input parameters.
String	toString() Returns a string representation of this object.
ModifyScheduledActionResult	withEndTime(Date endTime) The end time in UTC when the schedule is no longer active.
ModifyScheduledActionResult	withIamRole(String iamRole) The IAM role to assume to run the scheduled action.
ModifyScheduledActionResult	withNextInvocations(Collection<Date> nextInvocations) List of times when the scheduled action will run.
ModifyScheduledActionResult	withNextInvocations(Date... nextInvocations) List of times when the scheduled action will run.
ModifyScheduledActionResult	withSchedule(String schedule) The schedule for a one-time (at format) or recurring (cron format) scheduled action.
ModifyScheduledActionResult	withScheduledActionDescription(String scheduledActionDescription) The description of the scheduled action.
ModifyScheduledActionResult	withScheduledActionName(String scheduledActionName) The name of the scheduled action.
ModifyScheduledActionResult	withStartTime(Date startTime) The start time in UTC when the schedule is active.
ModifyScheduledActionResult	withState(ScheduledActionState state) The state of the scheduled action.
ModifyScheduledActionResult	withState(String state) The state of the scheduled action.
ModifyScheduledActionResult	withTargetAction(ScheduledActionType targetAction) A JSON format string of the Amazon Redshift API operation with input parameters.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyScheduledActionResult

public ModifyScheduledActionResult()

Method Detail

setScheduledActionName

public void setScheduledActionName(String scheduledActionName)

The name of the scheduled action.

Parameters:

scheduledActionName - The name of the scheduled action.

getScheduledActionName

public String getScheduledActionName()

The name of the scheduled action.

Returns:

The name of the scheduled action.

withScheduledActionName

public ModifyScheduledActionResult withScheduledActionName(String scheduledActionName)

The name of the scheduled action.

Parameters:

scheduledActionName - The name of the scheduled action.

Returns:

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

setTargetAction

public void setTargetAction(ScheduledActionType targetAction)

A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

Parameters:

targetAction - A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

getTargetAction

public ScheduledActionType getTargetAction()

A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

Returns:

A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

withTargetAction

public ModifyScheduledActionResult withTargetAction(ScheduledActionType targetAction)

A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

Parameters:

targetAction - A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

Returns:

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

setSchedule

public void setSchedule(String schedule)

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

Parameters:

schedule - The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

getSchedule

public String getSchedule()

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

Returns:

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

withSchedule

public ModifyScheduledActionResult withSchedule(String schedule)

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

Parameters:

schedule - The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

Returns:

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

setIamRole

public void setIamRole(String iamRole)

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Parameters:

iamRole - The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

getIamRole

public String getIamRole()

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Returns:

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

withIamRole

public ModifyScheduledActionResult withIamRole(String iamRole)

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Parameters:

iamRole - The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Returns:

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

setScheduledActionDescription

public void setScheduledActionDescription(String scheduledActionDescription)

The description of the scheduled action.

Parameters:

scheduledActionDescription - The description of the scheduled action.

getScheduledActionDescription

public String getScheduledActionDescription()

The description of the scheduled action.

Returns:

The description of the scheduled action.

withScheduledActionDescription

public ModifyScheduledActionResult withScheduledActionDescription(String scheduledActionDescription)

The description of the scheduled action.

Parameters:

scheduledActionDescription - The description of the scheduled action.

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 scheduled action. For example, DISABLED.

Parameters:

state - The state of the scheduled action. For example, DISABLED.

See Also:

ScheduledActionState

getState

public String getState()

The state of the scheduled action. For example, DISABLED.

Returns:

The state of the scheduled action. For example, DISABLED.

See Also:

ScheduledActionState

withState

public ModifyScheduledActionResult withState(String state)

The state of the scheduled action. For example, DISABLED.

Parameters:

state - The state of the scheduled action. For example, DISABLED.

Returns:

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

See Also:

ScheduledActionState

withState

public ModifyScheduledActionResult withState(ScheduledActionState state)

The state of the scheduled action. For example, DISABLED.

Parameters:

state - The state of the scheduled action. For example, DISABLED.

Returns:

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

See Also:

ScheduledActionState

getNextInvocations

public List<Date> getNextInvocations()

List of times when the scheduled action will run.

Returns:

List of times when the scheduled action will run.

setNextInvocations

public void setNextInvocations(Collection<Date> nextInvocations)

List of times when the scheduled action will run.

Parameters:

nextInvocations - List of times when the scheduled action will run.

withNextInvocations

public ModifyScheduledActionResult withNextInvocations(Date... nextInvocations)

List of times when the scheduled action will run.

NOTE: This method appends the values to the existing list (if any). Use setNextInvocations(java.util.Collection) or withNextInvocations(java.util.Collection) if you want to override the existing values.

Parameters:

nextInvocations - List of times when the scheduled action will run.

Returns:

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

withNextInvocations

public ModifyScheduledActionResult withNextInvocations(Collection<Date> nextInvocations)

List of times when the scheduled action will run.

Parameters:

nextInvocations - List of times when the scheduled action will run.

Returns:

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

setStartTime

public void setStartTime(Date startTime)

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

Parameters:

startTime - The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

getStartTime

public Date getStartTime()

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

Returns:

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

withStartTime

public ModifyScheduledActionResult withStartTime(Date startTime)

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

Parameters:

startTime - The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

Returns:

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

setEndTime

public void setEndTime(Date endTime)

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Parameters:

endTime - The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

getEndTime

public Date getEndTime()

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Returns:

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

withEndTime

public ModifyScheduledActionResult withEndTime(Date endTime)

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Parameters:

endTime - The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

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

Overrides:

clone in class Object