CreateScheduledActionResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.redshift.model.RedshiftResponse
    - - software.amazon.awssdk.services.redshift.model.CreateScheduledActionResponse

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateScheduledActionResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateScheduledActionResponse.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()` For responses, this returns true if the service returned a value for the NextInvocations property.
`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 CreateScheduledActionResponse.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.
`CreateScheduledActionResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.redshift.model.RedshiftResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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 final String scheduledActionName()
```
    The name of the scheduled action.
    
    Returns:
    
    The name of the scheduled action.
  - targetAction
```
public final 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 final 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 final 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 final String scheduledActionDescription()
```
    The description of the scheduled action.
    
    Returns:
    
    The description of the scheduled action.
  - state
```
public final 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 final 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 final boolean hasNextInvocations()
```
    For responses, this returns true if the service returned a value for the NextInvocations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - nextInvocations
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNextInvocations() method.
    
    Returns:
    
    List of times when the scheduled action will run.
  - startTime
```
public final 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 final 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 CreateScheduledActionResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateScheduledActionResponse.Builder,CreateScheduledActionResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static CreateScheduledActionResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateScheduledActionResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateScheduledActionResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.redshift.model.RedshiftResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

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