software.amazon.awssdk.services.datapipeline.model

Class PipelineDescription

java.lang.Object

software.amazon.awssdk.services.datapipeline.model.PipelineDescription

All Implemented Interfaces:

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

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

Contains pipeline metadata.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PipelineDescription.Builder

Method Summary

Modifier and Type	Method and Description
static PipelineDescription.Builder	builder()
String	description() Description of the pipeline.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Field>	fields() A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
<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()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() The name of the pipeline.
String	pipelineId() The pipeline identifier that was assigned by AWS Data Pipeline.
List<SdkField<?>>	sdkFields()
static Class<? extends PipelineDescription.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tags to associated with a pipeline.
PipelineDescription.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

pipelineId

public final String pipelineId()

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

Returns:

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

name

public final String name()

The name of the pipeline.

Returns:

The name of the pipeline.

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

A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.

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:

A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and

description

public final String description()

Description of the pipeline.

Returns:

Description of the pipeline.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

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

Returns:

A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

toBuilder

public PipelineDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipelineDescription.Builder,PipelineDescription>

builder

public static PipelineDescription.Builder builder()

serializableBuilderClass

public static Class<? extends PipelineDescription.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