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

Interface DescribeExecutionResponse.Builder

    • Method Detail

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

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

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

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