Class WorkflowExecutionStartedEventAttributes

    • Method Detail

      • input

        public final String input()

        The input provided to the workflow execution.

        Returns:
        The input provided to the workflow execution.
      • executionStartToCloseTimeout

        public final String executionStartToCloseTimeout()

        The maximum duration for this workflow execution.

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

        Returns:
        The maximum duration for this workflow execution.

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

      • taskStartToCloseTimeout

        public final String taskStartToCloseTimeout()

        The maximum duration of decision tasks for this workflow type.

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

        Returns:
        The maximum duration of decision tasks for this workflow type.

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

      • childPolicy

        public final ChildPolicy childPolicy()

        The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

        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.

        If the service returns an enum value that is not available in the current SDK version, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().

        Returns:
        The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

        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.

        See Also:
        ChildPolicy
      • childPolicyAsString

        public final String childPolicyAsString()

        The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

        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.

        If the service returns an enum value that is not available in the current SDK version, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().

        Returns:
        The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

        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.

        See Also:
        ChildPolicy
      • taskList

        public final TaskList taskList()

        The name of the task list for scheduling the decision tasks for this workflow execution.

        Returns:
        The name of the task list for scheduling the decision tasks for this workflow execution.
      • taskPriority

        public final String taskPriority()

        The priority of the decision tasks in the workflow execution.

        Returns:
        The priority of the decision tasks in the workflow execution.
      • workflowType

        public final WorkflowType workflowType()

        The workflow type of this execution.

        Returns:
        The workflow type of this execution.
      • hasTagList

        public final boolean hasTagList()
        For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tagList

        public final List<String> tagList()

        The list of tags associated with this workflow execution. An execution can have up to 5 tags.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagList() method.

        Returns:
        The list of tags associated with this workflow execution. An execution can have up to 5 tags.
      • continuedExecutionRunId

        public final String continuedExecutionRunId()

        If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

        Returns:
        If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.
      • parentWorkflowExecution

        public final WorkflowExecution parentWorkflowExecution()

        The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

        Returns:
        The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.
      • parentInitiatedEventId

        public final Long parentInitiatedEventId()

        The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        Returns:
        The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
      • lambdaRole

        public final String lambdaRole()

        The IAM role attached to the workflow execution.

        Returns:
        The IAM role attached to the workflow execution.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)