Class: Aws::SWF::Types::ActivityTypeConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-swf/types.rb

Overview

Configuration settings registered with the activity type.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_task_heartbeat_timeout ⇒ String

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`. You can use `NONE` to specify unlimited duration.

Returns:

  • (String) 


426
427
428
429
430
431
432
433
434
435
 
# File 'lib/aws-sdk-swf/types.rb', line 426

class ActivityTypeConfiguration < Struct.new(
  :default_task_start_to_close_timeout,
  :default_task_heartbeat_timeout,
  :default_task_list,
  :default_task_priority,
  :default_task_schedule_to_start_timeout,
  :default_task_schedule_to_close_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#default_task_list ⇒ Types::TaskList

The default task list specified for this activity type at registration. This default is used if a task list isn’t 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:



426
427
428
429
430
431
432
433
434
435
 
# File 'lib/aws-sdk-swf/types.rb', line 426

class ActivityTypeConfiguration < Struct.new(
  :default_task_start_to_close_timeout,
  :default_task_heartbeat_timeout,
  :default_task_list,
  :default_task_priority,
  :default_task_schedule_to_start_timeout,
  :default_task_schedule_to_close_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#default_task_priority ⇒ String

The default task priority for tasks of this activity type, specified at registration. If not set, then ‘0` is 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 SWF Developer Guide*.

[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html

Returns:

  • (String) 


426
427
428
429
430
431
432
433
434
435
 
# File 'lib/aws-sdk-swf/types.rb', line 426

class ActivityTypeConfiguration < Struct.new(
  :default_task_start_to_close_timeout,
  :default_task_heartbeat_timeout,
  :default_task_list,
  :default_task_priority,
  :default_task_schedule_to_start_timeout,
  :default_task_schedule_to_close_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#default_task_schedule_to_close_timeout ⇒ String

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`. You can use `NONE` to specify unlimited duration.

Returns:

  • (String) 


426
427
428
429
430
431
432
433
434
435
 
# File 'lib/aws-sdk-swf/types.rb', line 426

class ActivityTypeConfiguration < Struct.new(
  :default_task_start_to_close_timeout,
  :default_task_heartbeat_timeout,
  :default_task_list,
  :default_task_priority,
  :default_task_schedule_to_start_timeout,
  :default_task_schedule_to_close_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#default_task_schedule_to_start_timeout ⇒ String

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`. You can use `NONE` to specify unlimited duration.

Returns:

  • (String) 


426
427
428
429
430
431
432
433
434
435
 
# File 'lib/aws-sdk-swf/types.rb', line 426

class ActivityTypeConfiguration < Struct.new(
  :default_task_start_to_close_timeout,
  :default_task_heartbeat_timeout,
  :default_task_list,
  :default_task_priority,
  :default_task_schedule_to_start_timeout,
  :default_task_schedule_to_close_timeout)
  SENSITIVE = []
  include Aws::Structure
end

#default_task_start_to_close_timeout ⇒ String

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`. You can use `NONE` to specify unlimited duration.

Returns:

  • (String) 


426
427
428
429
430
431
432
433
434
435
 
# File 'lib/aws-sdk-swf/types.rb', line 426

class ActivityTypeConfiguration < Struct.new(
  :default_task_start_to_close_timeout,
  :default_task_heartbeat_timeout,
  :default_task_list,
  :default_task_priority,
  :default_task_schedule_to_start_timeout,
  :default_task_schedule_to_close_timeout)
  SENSITIVE = []
  include Aws::Structure
end