@Generated(value="software.amazon.awssdk:codegen") public final class DeactivatePipelineRequest extends DataPipelineRequest implements ToCopyableBuilder<DeactivatePipelineRequest.Builder,DeactivatePipelineRequest>
Contains the parameters for DeactivatePipeline.
Modifier and Type | Class and Description |
---|---|
static interface |
DeactivatePipelineRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DeactivatePipelineRequest.Builder |
builder() |
Boolean |
cancelActive()
Indicates whether to cancel any running objects.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
pipelineId()
The ID of the pipeline.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DeactivatePipelineRequest.Builder> |
serializableBuilderClass() |
DeactivatePipelineRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String pipelineId()
The ID of the pipeline.
public final 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.
CANCELED
. If this value is false, the pipeline is deactivated after all running
objects finish.public DeactivatePipelineRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DeactivatePipelineRequest.Builder,DeactivatePipelineRequest>
toBuilder
in class DataPipelineRequest
public static DeactivatePipelineRequest.Builder builder()
public static Class<? extends DeactivatePipelineRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.