ScheduleActivityTaskDecisionAttributes (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.swf.model.ScheduleActivityTaskDecisionAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScheduleActivityTaskDecisionAttributes.Builder,ScheduleActivityTaskDecisionAttributes>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ScheduleActivityTaskDecisionAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScheduleActivityTaskDecisionAttributes.Builder,ScheduleActivityTaskDecisionAttributes>
```
Provides the details of the ScheduleActivityTask decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
- Use a Resource element with the domain name to limit the action to only specified domains.
- Use an Action element to allow or deny permission to call this action.
- Constrain the following parameters by using a Condition element with the appropriate keys.
  - activityType.name – String constraint. The key is swf:activityType.name.
  - activityType.version – String constraint. The key is swf:activityType.version.
  - taskList – String constraint. The key is swf:taskList.name.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ScheduleActivityTaskDecisionAttributes.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`activityId()` The `activityId` of the activity task.
`ActivityType`	`activityType()` The type of the activity task to schedule.
`static ScheduleActivityTaskDecisionAttributes.Builder`	`builder()`
`String`	`control()` Data attached to the event that can be used by the decider in subsequent workflow tasks.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`heartbeatTimeout()` If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat.
`String`	`input()` The input provided to the activity task.
`String`	`scheduleToCloseTimeout()` The maximum duration for this activity task.
`String`	`scheduleToStartTimeout()` If set, specifies the maximum duration the activity task can wait to be assigned to a worker.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ScheduleActivityTaskDecisionAttributes.Builder>`	`serializableBuilderClass()`
`String`	`startToCloseTimeout()` If set, specifies the maximum duration a worker may take to process this activity task.
`TaskList`	`taskList()` If set, specifies the name of the task list in which to schedule the activity task.
`String`	`taskPriority()` If set, specifies the priority with which the activity task is to be assigned to a worker.
`ScheduleActivityTaskDecisionAttributes.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

- Method Detail
  - activityType
```
public ActivityType activityType()
```
    The type of the activity task to schedule.
    
    Returns:
    
    The type of the activity task to schedule.
  - activityId
```
public String activityId()
```
    The activityId of the activity task.
    
    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not contain the literal string arn.
    
    Returns:
    
    The activityId of the activity task.
    
    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters ( - | -). Also, it must not contain the literal string arn.
  - control
```
public String control()
```
    Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.
    
    Returns:
    
    Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.
  - input
```
public String input()
```
    The input provided to the activity task.
    
    Returns:
    
    The input provided to the activity task.
  - scheduleToCloseTimeout
```
public String scheduleToCloseTimeout()
```
    The maximum duration for this activity task.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.
    
    Returns:
    
    The maximum duration for this activity task.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.
  - taskList
```
public TaskList taskList()
```
    If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.
    
    A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.
    
    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not contain the literal string arn.
    
    Returns:
    
    If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.
    
    A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.
    
    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters ( - | -). Also, it must not contain the literal string arn.
  - taskPriority
```
public String taskPriority()
```
    If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
    
    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
    
    Returns:
    
    If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
    
    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
  - scheduleToStartTimeout
```
public String scheduleToStartTimeout()
```
    If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.
    
    Returns:
    
    If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.
  - startToCloseTimeout
```
public String startToCloseTimeout()
```
    If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.
    
    Returns:
    
    If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.
  - heartbeatTimeout
```
public String heartbeatTimeout()
```
    If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    Returns:
    
    If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
  - toBuilder
```
public ScheduleActivityTaskDecisionAttributes.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScheduleActivityTaskDecisionAttributes.Builder,ScheduleActivityTaskDecisionAttributes>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ScheduleActivityTaskDecisionAttributes.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScheduleActivityTaskDecisionAttributes.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ScheduleActivityTaskDecisionAttributes

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

activityType

activityId

control

input

scheduleToCloseTimeout

taskList

taskPriority

scheduleToStartTimeout

startToCloseTimeout

heartbeatTimeout

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields