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

Interface RegisterWorkflowTypeRequest.Builder

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

  • Method Details

    • domain

      RegisterWorkflowTypeRequest.Builder domain(String domain)

      The name of the domain in which to register the workflow type.

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

    • name

      RegisterWorkflowTypeRequest.Builder name(String name)

      The name of the workflow type.

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

      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

      RegisterWorkflowTypeRequest.Builder version(String version)

      The version of the workflow type.

      The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

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

      The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

      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

      RegisterWorkflowTypeRequest.Builder description(String description)

      Textual description of the workflow type.

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

    • defaultTaskStartToCloseTimeout

      RegisterWorkflowTypeRequest.Builder defaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)

      If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution 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 of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution 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.

    • defaultExecutionStartToCloseTimeout

      RegisterWorkflowTypeRequest.Builder defaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)

      If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

      The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

      Parameters:
      defaultExecutionStartToCloseTimeout - If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

      The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

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

    • defaultTaskList

      RegisterWorkflowTypeRequest.Builder defaultTaskList(TaskList defaultTaskList)

      If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

      Parameters:
      defaultTaskList - If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultTaskList

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

      If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution 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

      RegisterWorkflowTypeRequest.Builder defaultTaskPriority(String defaultTaskPriority)

      The default task priority to assign to the workflow 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 Amazon SWF Developer Guide.

      Parameters:
      defaultTaskPriority - The default task priority to assign to the workflow 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 Amazon SWF Developer Guide.

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

    • defaultChildPolicy

      RegisterWorkflowTypeRequest.Builder defaultChildPolicy(String defaultChildPolicy)

      If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

      Parameters:
      defaultChildPolicy - If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

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

    • defaultChildPolicy

      RegisterWorkflowTypeRequest.Builder defaultChildPolicy(ChildPolicy defaultChildPolicy)

      If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

      Parameters:
      defaultChildPolicy - If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

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

    • defaultLambdaRole

      RegisterWorkflowTypeRequest.Builder defaultLambdaRole(String defaultLambdaRole)

      The default IAM role attached to this workflow type.

      Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https: //docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

      Parameters:
      defaultLambdaRole - The default IAM role attached to this workflow type.

      Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

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

    • overrideConfiguration

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

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