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

Interface RegisterActivityTypeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RegisterActivityTypeRequest.Builder,RegisterActivityTypeRequest>, SdkBuilder<RegisterActivityTypeRequest.Builder,RegisterActivityTypeRequest>, SdkPojo, SdkRequest.Builder, SwfRequest.Builder
Enclosing class:
RegisterActivityTypeRequest
public static interface RegisterActivityTypeRequest.Builder extends SwfRequest.Builder, SdkPojo, CopyableBuilder<RegisterActivityTypeRequest.Builder,RegisterActivityTypeRequest>

  • Method Details

    • domain

      RegisterActivityTypeRequest.Builder domain(String domain)

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

      Parameters:
      domain - The name of the domain in which this activity is to be registered.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      RegisterActivityTypeRequest.Builder name(String name)

      The name of the activity type within the domain.

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

      Parameters:
      name - The name of the activity type within the domain.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      RegisterActivityTypeRequest.Builder version(String version)

      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 contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

      Parameters:
      version - 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 contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      RegisterActivityTypeRequest.Builder description(String description)

      A textual description of the activity type.

      Parameters:
      description - A textual description of the activity type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultTaskStartToCloseTimeout

      RegisterActivityTypeRequest.Builder defaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)

      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.

      Parameters:
      defaultTaskStartToCloseTimeout - 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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultTaskHeartbeatTimeout

      RegisterActivityTypeRequest.Builder defaultTaskHeartbeatTimeout(String defaultTaskHeartbeatTimeout)

      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.

      Parameters:
      defaultTaskHeartbeatTimeout - 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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultTaskList

      RegisterActivityTypeRequest.Builder defaultTaskList(TaskList defaultTaskList)

      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.

      Parameters:
      defaultTaskList - 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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultTaskList

      default RegisterActivityTypeRequest.Builder defaultTaskList(Consumer<TaskList.Builder> defaultTaskList)

      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.

      This is a convenience method that creates an instance of the TaskList.Builder avoiding the need to create one manually via TaskList.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultTaskList(TaskList).

      Parameters:
      defaultTaskList - a consumer that will call methods on TaskList.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultTaskPriority

      RegisterActivityTypeRequest.Builder defaultTaskPriority(String defaultTaskPriority)

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

      Parameters:
      defaultTaskPriority - 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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultTaskScheduleToStartTimeout

      RegisterActivityTypeRequest.Builder defaultTaskScheduleToStartTimeout(String defaultTaskScheduleToStartTimeout)

      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.

      Parameters:
      defaultTaskScheduleToStartTimeout - 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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultTaskScheduleToCloseTimeout

      RegisterActivityTypeRequest.Builder defaultTaskScheduleToCloseTimeout(String defaultTaskScheduleToCloseTimeout)

      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.

      Parameters:
      defaultTaskScheduleToCloseTimeout - 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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      RegisterActivityTypeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RegisterActivityTypeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.