You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass RegisterActivityTypeInput data as a hash:

{
  domain: "DomainName", # required
  name: "Name", # required
  version: "Version", # required
  description: "Description",
  default_task_start_to_close_timeout: "DurationInSecondsOptional",
  default_task_heartbeat_timeout: "DurationInSecondsOptional",
  default_task_list: {
    name: "Name", # required
  },
  default_task_priority: "TaskPriority",
  default_task_schedule_to_start_timeout: "DurationInSecondsOptional",
  default_task_schedule_to_close_timeout: "DurationInSecondsOptional",
}

Instance Attribute Summary collapse

Instance Attribute Details

#default_task_heartbeat_timeoutString

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)


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end

#default_task_listTypes::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:



3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end

#default_task_priorityString

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..

Returns:

  • (String)


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end

#default_task_schedule_to_close_timeoutString

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)


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end

#default_task_schedule_to_start_timeoutString

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)


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end

#default_task_start_to_close_timeoutString

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)


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end

#descriptionString

A textual description of the activity type.

Returns:

  • (String)


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end

#domainString

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

Returns:

  • (String)


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end

#nameString

The name of the activity type within the domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

Returns:

  • (String)


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end

#versionString

The version of the activity type.

The activity type consists of the name and version, the combination of which must be unique within the domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

Returns:

  • (String)


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3906

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)
  include Aws::Structure
end