Package software.amazon.awssdk.services.swf.model

Class ActivityTypeConfiguration

java.lang.Object

software.amazon.awssdk.services.swf.model.ActivityTypeConfiguration

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ActivityTypeConfiguration.Builder,ActivityTypeConfiguration>

@Generated("software.amazon.awssdk:codegen")
public class ActivityTypeConfiguration
extends Object
implements StructuredPojo, ToCopyableBuilder<ActivityTypeConfiguration.Builder,ActivityTypeConfiguration>

Configuration settings registered with the activity type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ActivityTypeConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ActivityTypeConfiguration.Builder	builder()
String	defaultTaskHeartbeatTimeout()	Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
TaskList	defaultTaskList()	Optional. The default task list specified for this activity type at registration.
String	defaultTaskPriority()	Optional. The default task priority for tasks of this activity type, specified at registration.
String	defaultTaskScheduleToCloseTimeout()	Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type.
String	defaultTaskScheduleToStartTimeout()	Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker.
String	defaultTaskStartToCloseTimeout()	Optional. The default maximum duration for tasks of an activity type specified when registering the activity type.
boolean	equals(Object obj)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends ActivityTypeConfiguration.Builder>	serializableBuilderClass()
ActivityTypeConfiguration.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

Method Detail

defaultTaskStartToCloseTimeout

public String defaultTaskStartToCloseTimeout()

Optional. The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

Returns:

Optional. The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

defaultTaskHeartbeatTimeout

public String defaultTaskHeartbeatTimeout()

Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.

You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

Returns:

Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.

You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

defaultTaskList

public TaskList defaultTaskList()

Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask decision.

Returns:

Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask

defaultTaskPriority

public String defaultTaskPriority()

Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then "0" will be used as the default priority. This default can be overridden when scheduling an activity task.

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 Simple Workflow Developer Guide.

Returns:

Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then "0" will be used as the default priority. This default can be overridden when scheduling an activity task.

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 Simple Workflow Developer Guide

defaultTaskScheduleToStartTimeout

public String defaultTaskScheduleToStartTimeout()

Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

Returns:

Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask decision.

defaultTaskScheduleToCloseTimeout

public String defaultTaskScheduleToCloseTimeout()

Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

Returns:

Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

toBuilder

public ActivityTypeConfiguration.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<ActivityTypeConfiguration.Builder,ActivityTypeConfiguration>

Returns:

a builder for type T

builder

public static ActivityTypeConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ActivityTypeConfiguration.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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.