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

Class PipelineDescription

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<PipelineDescription.Builder,PipelineDescription>

@Generated("software.amazon.awssdk:codegen")
public class PipelineDescription
extends Object
implements StructuredPojo, ToCopyableBuilder<PipelineDescription.Builder,PipelineDescription>

Contains pipeline metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PipelineDescription.Builder

Method Summary

Modifier and Type	Method	Description
static PipelineDescription.Builder	builder()
String	description()	Description of the pipeline.
boolean	equals(Object obj)
List<Field>	fields()	A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The name of the pipeline.
String	pipelineId()	The pipeline identifier that was assigned by AWS Data Pipeline.
static Class<? extends PipelineDescription.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of tags to associated with a pipeline.
PipelineDescription.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

pipelineId

public 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 String name()

The name of the pipeline.

Returns:

The name of the pipeline.

fields

public List<Field> fields()

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

Returns:

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

description

public String description()

Description of the pipeline.

Returns:

Description of the pipeline.

tags

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

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

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<PipelineDescription.Builder,PipelineDescription>

Returns:

a builder for type T

builder

public static PipelineDescription.Builder builder()

serializableBuilderClass

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.