ScheduledAction (AWS Java SDK :: Services :: Amazon Redshift 2.14.3 API)

java.lang.Object
- software.amazon.awssdk.services.redshift.model.ScheduledAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScheduledAction.Builder,ScheduledAction>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ScheduledAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledAction.Builder,ScheduledAction>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ScheduledAction.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ScheduledAction.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ScheduledAction.Builder`	`builder()`
`Instant`	`endTime()` The end time in UTC when the schedule is no longer active.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasNextInvocations()` Returns true if the NextInvocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`iamRole()` The IAM role to assume to run the scheduled action.
`List<Instant>`	`nextInvocations()` List of times when the scheduled action will run.
`String`	`schedule()` The schedule for a one-time (at format) or recurring (cron format) scheduled action.
`String`	`scheduledActionDescription()` The description of the scheduled action.
`String`	`scheduledActionName()` The name of the scheduled action.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ScheduledAction.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The start time in UTC when the schedule is active.
`ScheduledActionState`	`state()` The state of the scheduled action.
`String`	`stateAsString()` The state of the scheduled action.
`ScheduledActionType`	`targetAction()` A JSON format string of the Amazon Redshift API operation with input parameters.
`ScheduledAction.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - scheduledActionName
```
public String scheduledActionName()
```
    The name of the scheduled action.
    
    Returns:
    
    The name of the scheduled action.
  - targetAction
```
public ScheduledActionType targetAction()
```
    A JSON format string of the Amazon Redshift API operation with input parameters.
    
    " {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".
    
    Returns:
    
    A JSON format string of the Amazon Redshift API operation with input parameters.
    
    " {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".
  - schedule
```
public 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.
    
    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.
  - iamRole
```
public 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.
    
    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.
  - scheduledActionDescription
```
public String scheduledActionDescription()
```
    The description of the scheduled action.
    
    Returns:
    
    The description of the scheduled action.
  - state
```
public ScheduledActionState state()
```
    The state of the scheduled action. For example, DISABLED.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ScheduledActionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the scheduled action. For example, DISABLED.
    
    See Also:
    
    ScheduledActionState
  - stateAsString
```
public String stateAsString()
```
    The state of the scheduled action. For example, DISABLED.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ScheduledActionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the scheduled action. For example, DISABLED.
    
    See Also:
    
    ScheduledActionState
  - hasNextInvocations
```
public boolean hasNextInvocations()
```
    Returns true if the NextInvocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - nextInvocations
```
public List<Instant> nextInvocations()
```
    List of times when the scheduled action will run.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNextInvocations() to see if a value was sent in this field.
    
    Returns:
    
    List of times when the scheduled action will run.
  - startTime
```
public Instant startTime()
```
    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.
  - endTime
```
public Instant endTime()
```
    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.
  - toBuilder
```
public ScheduledAction.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScheduledAction.Builder,ScheduledAction>
  - builder
```
public static ScheduledAction.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScheduledAction.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ScheduledAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

scheduledActionName

targetAction

schedule

iamRole

scheduledActionDescription

state

stateAsString

hasNextInvocations

nextInvocations

startTime

endTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields