java.lang.Object
- software.amazon.awssdk.services.redshiftserverless.model.ScheduledActionResponse

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ScheduledActionResponse.Builder,ScheduledActionResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ScheduledActionResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledActionResponse.Builder,ScheduledActionResponse>

The returned scheduled action object.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ScheduledActionResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ScheduledActionResponse.Builder`	`builder()`
`Instant`	`endTime()`	The end time of
`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`	`namespaceName()`	The end time in UTC when the schedule is no longer active.
`List<Instant>`	`nextInvocations()`	An array of timestamps of when the next scheduled actions will trigger.
`String`	`roleArn()`	The ARN of the IAM role to assume to run the scheduled action.
`Schedule`	`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.
`String`	`scheduledActionUuid()`	The uuid of the scheduled action.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ScheduledActionResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The start time in UTC when the schedule is active.
`State`	`state()`	The state of the scheduled action.
`String`	`stateAsString()`	The state of the scheduled action.
`TargetAction`	`targetAction()`	Returns the value of the TargetAction property for this object.
`ScheduledActionResponse.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
  - endTime
```
public final Instant endTime()
```
    The end time of
    
    Returns:
    
    The end time of
  - namespaceName
```
public final String namespaceName()
```
    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.
  - 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()
```
    An array of timestamps of when the next scheduled actions will trigger.
    
    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:
    
    An array of timestamps of when the next scheduled actions will trigger.
  - roleArn
```
public final String roleArn()
```
    The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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
  - schedule
```
public final Schedule 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.
  - scheduledActionDescription
```
public final String scheduledActionDescription()
```
    The description of the scheduled action.
    
    Returns:
    
    The description of the scheduled action.
  - scheduledActionName
```
public final String scheduledActionName()
```
    The name of the scheduled action.
    
    Returns:
    
    The name of the scheduled action.
  - scheduledActionUuid
```
public final String scheduledActionUuid()
```
    The uuid of the scheduled action.
    
    Returns:
    
    The uuid of the scheduled action.
  - 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.
  - state
```
public final State state()
```
    The state of the scheduled action.
    
    If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the scheduled action.
    
    See Also:
    
    State
  - stateAsString
```
public final String stateAsString()
```
    The state of the scheduled action.
    
    If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the scheduled action.
    
    See Also:
    
    State
  - targetAction
```
public final TargetAction targetAction()
```
    Returns the value of the TargetAction property for this object.
    
    Returns:
    
    The value of the TargetAction property for this object.
  - toBuilder
```
public ScheduledActionResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScheduledActionResponse.Builder,ScheduledActionResponse>
  - builder
```
public static ScheduledActionResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScheduledActionResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ScheduledActionResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

endTime

namespaceName

hasNextInvocations

nextInvocations

roleArn

schedule

scheduledActionDescription

scheduledActionName

scheduledActionUuid

startTime

state

stateAsString

targetAction

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields