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

Interface StartWorkflowExecutionRequest.Builder

    • Method Detail

      • domain

        StartWorkflowExecutionRequest.Builder domain​(String domain)

        The name of the domain in which the workflow execution is created.

        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:
        domain - The name of the domain in which the workflow execution is created.

        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.

      • workflowId

        StartWorkflowExecutionRequest.Builder workflowId​(String workflowId)

        The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same 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:
        workflowId - The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same 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.

      • workflowType

        StartWorkflowExecutionRequest.Builder workflowType​(WorkflowType workflowType)

        The type of the workflow to start.

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

      • taskList

        StartWorkflowExecutionRequest.Builder taskList​(TaskList taskList)

        The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

        A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

        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:
        taskList - The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

        A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

        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.

      • taskList

        default StartWorkflowExecutionRequest.Builder taskList​(Consumer<TaskList.Builder> taskList)

        The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

        A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

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

        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 taskList(TaskList).

        Parameters:
        taskList - 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:
        taskList(TaskList)

      • taskPriority

        StartWorkflowExecutionRequest.Builder taskPriority​(String taskPriority)

        The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type 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:
        taskPriority - The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type 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.

      • input

        StartWorkflowExecutionRequest.Builder input​(String input)

        The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

        Parameters:
        input - The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionStartToCloseTimeout

        StartWorkflowExecutionRequest.Builder executionStartToCloseTimeout​(String executionStartToCloseTimeout)

        The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

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

        An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

        Parameters:
        executionStartToCloseTimeout - The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

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

        An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

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

      • taskStartToCloseTimeout

        StartWorkflowExecutionRequest.Builder taskStartToCloseTimeout​(String taskStartToCloseTimeout)

        Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

        The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

        Parameters:
        taskStartToCloseTimeout - Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

        The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

        A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

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

      • childPolicy

        StartWorkflowExecutionRequest.Builder childPolicy​(String childPolicy)

        If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

        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.

        A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

        Parameters:
        childPolicy - If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

        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.

        A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

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

      • childPolicy

        StartWorkflowExecutionRequest.Builder childPolicy​(ChildPolicy childPolicy)

        If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

        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.

        A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

        Parameters:
        childPolicy - If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

        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.

        A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

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

      • lambdaRole

        StartWorkflowExecutionRequest.Builder lambdaRole​(String lambdaRole)

        The IAM role to attach to this workflow execution.

        Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

        Parameters:
        lambdaRole - The IAM role to attach to this workflow execution.

        Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. 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.