Interface StartPipelineExecutionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartPipelineExecutionRequest
@Mutable @NotThreadSafe public static interface StartPipelineExecutionRequest.Builder extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>

  • Method Details

    • workspaceName

      StartPipelineExecutionRequest.Builder workspaceName(String workspaceName)

      The name of the workspace containing the pipeline.

      Parameters:
      workspaceName - The name of the workspace containing the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pipelineName

      StartPipelineExecutionRequest.Builder pipelineName(String pipelineName)

      The name of the pipeline to execute.

      Parameters:
      pipelineName - The name of the pipeline to execute.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionEnvironmentVariableOverrides

      StartPipelineExecutionRequest.Builder executionEnvironmentVariableOverrides(ExecutionEnvironmentVariables executionEnvironmentVariableOverrides)

      Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.

      Parameters:
      executionEnvironmentVariableOverrides - Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionEnvironmentVariableOverrides

      default StartPipelineExecutionRequest.Builder executionEnvironmentVariableOverrides(Consumer<ExecutionEnvironmentVariables.Builder> executionEnvironmentVariableOverrides)

      Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.

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

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

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

    • executionPriority

      StartPipelineExecutionRequest.Builder executionPriority(Integer executionPriority)

      Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.

      Parameters:
      executionPriority - Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartPipelineExecutionRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartPipelineExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartPipelineExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.