Class: Aws::SWF::Types::RegisterActivityTypeInput

Inherits:

Struct

• Object
• Struct
• Aws::SWF::Types::RegisterActivityTypeInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-swf/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_task_heartbeat_timeout ⇒ String

  If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat.

• #default_task_list ⇒ Types::TaskList

  If set, specifies the default task list to use for scheduling tasks of this activity type.

• #default_task_priority ⇒ String

  The default task priority to assign to the activity type.

• #default_task_schedule_to_close_timeout ⇒ String

  If set, specifies the default maximum duration for a task of this activity type.

• #default_task_schedule_to_start_timeout ⇒ String

  If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker.

• #default_task_start_to_close_timeout ⇒ String

  If set, specifies the default maximum duration that a worker can take to process tasks of this activity type.

• #description ⇒ String

  A textual description of the activity type.

• #domain ⇒ String

  The name of the domain in which this activity is to be registered.

• #name ⇒ String

  The name of the activity type within the domain.

• #version ⇒ String

  The version of the activity type.

Instance Attribute Details

#default_task_heartbeat_timeout ⇒ String

If set, specifies the default 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. This default can be overridden when scheduling an activity task using 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)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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

If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn’t provided when a task is scheduled through the ‘ScheduleActivityTask` Decision.

Returns:

• (Types::TaskList)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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 to assign to the activity type. If not assigned, then ‘0` is used. 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 *in the *Amazon SWF Developer Guide*.*.

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

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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

If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using 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)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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

If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using 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)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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

If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using 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)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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

#description ⇒ String

A textual description of the activity type.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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

#domain ⇒ String

The name of the domain in which this activity is to be registered.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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

#name ⇒ String

The name of the activity type within the domain.

The specified string must not contain a ‘:` (colon), `/` (slash), `|` (vertical bar), or any control characters (`u0000-u001f` | `u007f-u009f`). Also, it must not be the literal string `arn`.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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

#version ⇒ String

The version of the activity type.

<note markdown=“1”> The activity type consists of the name and version, the combination of which must be unique within the domain.

</note>

The specified string must not contain a ‘:` (colon), `/` (slash), `|` (vertical bar), or any control characters (`u0000-u001f` | `u007f-u009f`). Also, it must not be the literal string `arn`.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 3659

class RegisterActivityTypeInput < Struct.new(
  :domain,
  :name,
  :version,
  :description,
  :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