Package software.amazon.awssdk.services.sfn.model

Interface DescribeExecutionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeExecutionResponse.Builder,DescribeExecutionResponse>, SdkBuilder<DescribeExecutionResponse.Builder,DescribeExecutionResponse>, SdkPojo, SdkResponse.Builder, SfnResponse.Builder
Enclosing class:
DescribeExecutionResponse
public static interface DescribeExecutionResponse.Builder extends SfnResponse.Builder, SdkPojo, CopyableBuilder<DescribeExecutionResponse.Builder,DescribeExecutionResponse>

  • Method Details

    • executionArn

      DescribeExecutionResponse.Builder executionArn(String executionArn)

      The Amazon Resource Name (ARN) that identifies the execution.

      Parameters:
      executionArn - The Amazon Resource Name (ARN) that identifies the execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateMachineArn

      DescribeExecutionResponse.Builder stateMachineArn(String stateMachineArn)

      The Amazon Resource Name (ARN) of the executed stated machine.

      Parameters:
      stateMachineArn - The Amazon Resource Name (ARN) of the executed stated machine.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      DescribeExecutionResponse.Builder name(String name)

      The name of the execution.

      A name must not contain:

      • white space

      • brackets < > { } [ ]

      • wildcard characters ? *

      • special characters " # % \ ^ | ~ ` $ & , ; : /

      • control characters (U+0000-001F, U+007F-009F)

      To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

      Parameters:
      name - The name of the execution.

      A name must not contain:

      • white space

      • brackets < > { } [ ]

      • wildcard characters ? *

      • special characters " # % \ ^ | ~ ` $ & , ; : /

      • control characters (U+0000-001F, U+007F-009F)

      To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

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

    • status

      DescribeExecutionResponse.Builder status(String status)

      The current status of the execution.

      Parameters:
      status - The current status of the execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeExecutionResponse.Builder status(ExecutionStatus status)

      The current status of the execution.

      Parameters:
      status - The current status of the execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startDate

      DescribeExecutionResponse.Builder startDate(Instant startDate)

      The date the execution is started.

      Parameters:
      startDate - The date the execution is started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stopDate

      DescribeExecutionResponse.Builder stopDate(Instant stopDate)

      If the execution ended, the date the execution stopped.

      Parameters:
      stopDate - If the execution ended, the date the execution stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • input

      DescribeExecutionResponse.Builder input(String input)

      The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

      Parameters:
      input - The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDetails

      DescribeExecutionResponse.Builder inputDetails(CloudWatchEventsExecutionDataDetails inputDetails)
      Sets the value of the InputDetails property for this object.
      Parameters:
      inputDetails - The new value for the InputDetails property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDetails

      default DescribeExecutionResponse.Builder inputDetails(Consumer<CloudWatchEventsExecutionDataDetails.Builder> inputDetails)
      Sets the value of the InputDetails property for this object. This is a convenience method that creates an instance of the CloudWatchEventsExecutionDataDetails.Builder avoiding the need to create one manually via CloudWatchEventsExecutionDataDetails.builder().

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

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

    • output

      DescribeExecutionResponse.Builder output(String output)

      The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

      This field is set only if the execution succeeds. If the execution fails, this field is null.

      Parameters:
      output - The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

      This field is set only if the execution succeeds. If the execution fails, this field is null.

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

    • outputDetails

      DescribeExecutionResponse.Builder outputDetails(CloudWatchEventsExecutionDataDetails outputDetails)
      Sets the value of the OutputDetails property for this object.
      Parameters:
      outputDetails - The new value for the OutputDetails property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputDetails

      default DescribeExecutionResponse.Builder outputDetails(Consumer<CloudWatchEventsExecutionDataDetails.Builder> outputDetails)
      Sets the value of the OutputDetails property for this object. This is a convenience method that creates an instance of the CloudWatchEventsExecutionDataDetails.Builder avoiding the need to create one manually via CloudWatchEventsExecutionDataDetails.builder().

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

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

    • traceHeader

      DescribeExecutionResponse.Builder traceHeader(String traceHeader)

      The X-Ray trace header that was passed to the execution.

      Parameters:
      traceHeader - The X-Ray trace header that was passed to the execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mapRunArn

      DescribeExecutionResponse.Builder mapRunArn(String mapRunArn)

      The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

      Parameters:
      mapRunArn - The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • error

      DescribeExecutionResponse.Builder error(String error)

      The error string if the state machine execution failed.

      Parameters:
      error - The error string if the state machine execution failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cause

      DescribeExecutionResponse.Builder cause(String causeValue)

      The cause string if the state machine execution failed.

      Parameters:
      causeValue - The cause string if the state machine execution failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateMachineVersionArn

      DescribeExecutionResponse.Builder stateMachineVersionArn(String stateMachineVersionArn)

      The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

      If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.

      Parameters:
      stateMachineVersionArn - The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

      If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.

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

    • stateMachineAliasArn

      DescribeExecutionResponse.Builder stateMachineAliasArn(String stateMachineAliasArn)

      The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

      If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.

      Parameters:
      stateMachineAliasArn - The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

      If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.

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

    • redriveCount

      DescribeExecutionResponse.Builder redriveCount(Integer redriveCount)

      The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.

      Parameters:
      redriveCount - The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • redriveDate

      DescribeExecutionResponse.Builder redriveDate(Instant redriveDate)

      The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.

      The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.

      Parameters:
      redriveDate - The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.

      The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.

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

    • redriveStatus

      DescribeExecutionResponse.Builder redriveStatus(String redriveStatus)

      Indicates whether or not an execution can be redriven at a given point in time.

      • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.

      • For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

        You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

      Parameters:
      redriveStatus - Indicates whether or not an execution can be redriven at a given point in time.

      • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.

      • For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

        You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

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

    • redriveStatus

      DescribeExecutionResponse.Builder redriveStatus(ExecutionRedriveStatus redriveStatus)

      Indicates whether or not an execution can be redriven at a given point in time.

      • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.

      • For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

        You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

      Parameters:
      redriveStatus - Indicates whether or not an execution can be redriven at a given point in time.

      • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.

      • For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

        You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

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

    • redriveStatusReason

      DescribeExecutionResponse.Builder redriveStatusReason(String redriveStatusReason)

      When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.

      • For executions of type STANDARD, or for a Distributed Map that includes child workflows of type STANDARD, redriveStatusReason can include one of the following reasons:

        • State machine is in DELETING status.

        • Execution is RUNNING and cannot be redriven.

        • Execution is SUCCEEDED and cannot be redriven.

        • Execution was started before the launch of RedriveExecution.

        • Execution history event limit exceeded.

        • Execution has exceeded the max execution time.

        • Execution redrivable period exceeded.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatusReason is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.

      Parameters:
      redriveStatusReason - When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.

      • For executions of type STANDARD, or for a Distributed Map that includes child workflows of type STANDARD, redriveStatusReason can include one of the following reasons:

        • State machine is in DELETING status.

        • Execution is RUNNING and cannot be redriven.

        • Execution is SUCCEEDED and cannot be redriven.

        • Execution was started before the launch of RedriveExecution.

        • Execution history event limit exceeded.

        • Execution has exceeded the max execution time.

        • Execution redrivable period exceeded.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatusReason is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.

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