Package 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("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	Description
static interface	SetStatusRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SetStatusRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasObjectIds()	For responses, this returns true if the service returned a value for the ObjectIds property.
List<String>	objectIds()	The IDs of the objects.
String	pipelineId()	The ID of the pipeline that contains the objects.
Map<String,SdkField<?>>	sdkFieldNameToField()
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()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

pipelineId

public final String pipelineId()

The ID of the pipeline that contains the objects.

Returns:

The ID of the pipeline that contains the objects.

hasObjectIds

public final boolean hasObjectIds()

For responses, this returns true if the service returned a value for the ObjectIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

objectIds

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasObjectIds() method.

Returns:

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

status

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<SetStatusRequest.Builder,SetStatusRequest>

Specified by:

toBuilder in class DataPipelineRequest

builder

public static SetStatusRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo