software.amazon.awssdk.services.datapipeline.model

Interface DeactivatePipelineRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<DeactivatePipelineRequest.Builder,DeactivatePipelineRequest>, DataPipelineRequest.Builder, SdkBuilder<DeactivatePipelineRequest.Builder,DeactivatePipelineRequest>, SdkRequest.Builder

Enclosing class:

DeactivatePipelineRequest

public static interface DeactivatePipelineRequest.Builder
extends DataPipelineRequest.Builder, CopyableBuilder<DeactivatePipelineRequest.Builder,DeactivatePipelineRequest>

Method Summary

Modifier and Type	Method and Description
DeactivatePipelineRequest.Builder	cancelActive(Boolean cancelActive) Indicates whether to cancel any running objects.
DeactivatePipelineRequest.Builder	pipelineId(String pipelineId) The ID of the pipeline.
DeactivatePipelineRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DeactivatePipelineRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.datapipeline.model.DataPipelineRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

pipelineId

DeactivatePipelineRequest.Builder pipelineId(String pipelineId)

The ID of the pipeline.

Parameters:

pipelineId - The ID of the pipeline.

Returns:

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

cancelActive

DeactivatePipelineRequest.Builder cancelActive(Boolean cancelActive)

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Parameters:

cancelActive - Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Returns:

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

requestOverrideConfig

DeactivatePipelineRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DeactivatePipelineRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.