Package software.amazon.awssdk.services.transfer.model

Interface DescribedExecution.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DescribedExecution.Builder,DescribedExecution>, SdkBuilder<DescribedExecution.Builder,DescribedExecution>, SdkPojo
Enclosing class:
DescribedExecution
public static interface DescribedExecution.Builder extends SdkPojo, CopyableBuilder<DescribedExecution.Builder,DescribedExecution>

  • Method Details

    • executionId

      DescribedExecution.Builder executionId(String executionId)

      A unique identifier for the execution of a workflow.

      Parameters:
      executionId - A unique identifier for the execution of a workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialFileLocation

      DescribedExecution.Builder initialFileLocation(FileLocation initialFileLocation)

      A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

      Parameters:
      initialFileLocation - A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialFileLocation

      default DescribedExecution.Builder initialFileLocation(Consumer<FileLocation.Builder> initialFileLocation)

      A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

      This is a convenience method that creates an instance of the FileLocation.Builder avoiding the need to create one manually via FileLocation.builder().

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

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

    • serviceMetadata

      DescribedExecution.Builder serviceMetadata(ServiceMetadata serviceMetadata)

      A container object for the session details that are associated with a workflow.

      Parameters:
      serviceMetadata - A container object for the session details that are associated with a workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceMetadata

      default DescribedExecution.Builder serviceMetadata(Consumer<ServiceMetadata.Builder> serviceMetadata)

      A container object for the session details that are associated with a workflow.

      This is a convenience method that creates an instance of the ServiceMetadata.Builder avoiding the need to create one manually via ServiceMetadata.builder().

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

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

    • executionRole

      DescribedExecution.Builder executionRole(String executionRole)

      The IAM role associated with the execution.

      Parameters:
      executionRole - The IAM role associated with the execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      DescribedExecution.Builder loggingConfiguration(LoggingConfiguration loggingConfiguration)

      The IAM logging role associated with the execution.

      Parameters:
      loggingConfiguration - The IAM logging role associated with the execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      default DescribedExecution.Builder loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration)

      The IAM logging role associated with the execution.

      This is a convenience method that creates an instance of the LoggingConfiguration.Builder avoiding the need to create one manually via LoggingConfiguration.builder().

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

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

    • posixProfile

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

    • posixProfile

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

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

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

    • status

      DescribedExecution.Builder status(String status)

      The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

      Parameters:
      status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribedExecution.Builder status(ExecutionStatus status)

      The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

      Parameters:
      status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • results

      DescribedExecution.Builder results(ExecutionResults results)

      A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

      Parameters:
      results - A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • results

      default DescribedExecution.Builder results(Consumer<ExecutionResults.Builder> results)

      A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

      This is a convenience method that creates an instance of the ExecutionResults.Builder avoiding the need to create one manually via ExecutionResults.builder().

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

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