Package software.amazon.awssdk.services.datapipeline.model

Class PipelineObject

java.lang.Object

software.amazon.awssdk.services.datapipeline.model.PipelineObject

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PipelineObject.Builder,PipelineObject>

@Generated("software.amazon.awssdk:codegen")
public final class PipelineObject
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PipelineObject.Builder,PipelineObject>

Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PipelineObject.Builder

Method Summary

Modifier and Type	Method	Description
static PipelineObject.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Field>	fields()	Key-value pairs that define the properties of the object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFields()	For responses, this returns true if the service returned a value for the Fields property.
int	hashCode()
String	id()	The ID of the object.
String	name()	The name of the object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PipelineObject.Builder>	serializableBuilderClass()
PipelineObject.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

id

public final String id()

The ID of the object.

Returns:

The ID of the object.

name

public final String name()

The name of the object.

Returns:

The name of the object.

hasFields

public final boolean hasFields()

For responses, this returns true if the service returned a value for the Fields 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.

fields

public final List<Field> fields()

Key-value pairs that define the properties of the object.

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 hasFields() method.

Returns:

Key-value pairs that define the properties of the object.

toBuilder

public PipelineObject.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipelineObject.Builder,PipelineObject>

builder

public static PipelineObject.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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