software.amazon.awssdk.services.datapipeline.model

Class SetStatusRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datapipeline.model.DataPipelineRequest

software.amazon.awssdk.services.datapipeline.model.SetStatusRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetStatusRequest.Builder,SetStatusRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SetStatusRequest
extends DataPipelineRequest
implements ToCopyableBuilder<SetStatusRequest.Builder,SetStatusRequest>

Contains the parameters for SetStatus.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SetStatusRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SetStatusRequest.Builder	builder()
boolean	equals(Object obj)
<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()
List<String>	objectIds() The IDs of the objects.
String	pipelineId() The ID of the pipeline that contains the objects.
List<SdkField<?>>	sdkFields()
static Class<? extends SetStatusRequest.Builder>	serializableBuilderClass()
String	status() The status to be set on all the objects specified in objectIds.
SetStatusRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

pipelineId

public String pipelineId()

The ID of the pipeline that contains the objects.

Returns:

The ID of the pipeline that contains the objects.

objectIds

public List<String> objectIds()

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

status

public String status()

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

Returns:

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN , or MARK_FINISHED.

toBuilder

public SetStatusRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SetStatusRequest.Builder,SetStatusRequest>

Specified by:

toBuilder in class DataPipelineRequest

Returns:

a builder for type T

builder

public static SetStatusRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetStatusRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.