Interface DeactivatePipelineRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DeactivatePipelineRequest.Builder,
,DeactivatePipelineRequest> DataPipelineRequest.Builder
,SdkBuilder<DeactivatePipelineRequest.Builder,
,DeactivatePipelineRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DeactivatePipelineRequest
public static interface DeactivatePipelineRequest.Builder
extends DataPipelineRequest.Builder, SdkPojo, CopyableBuilder<DeactivatePipelineRequest.Builder,DeactivatePipelineRequest>
-
Method Summary
Modifier and TypeMethodDescriptioncancelActive
(Boolean cancelActive) Indicates whether to cancel any running objects.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.pipelineId
(String pipelineId) The ID of the pipeline.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.datapipeline.model.DataPipelineRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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 toCANCELED
. 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.
-
overrideConfiguration
DeactivatePipelineRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DeactivatePipelineRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-