PipelineDescription (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.datapipeline.model

Class PipelineDescription

java.lang.Object
- com.amazonaws.services.datapipeline.model.PipelineDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipelineDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains pipeline metadata.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipelineDescription ()

Constructors
Constructor and Description
`PipelineDescription ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`PipelineDescription`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getDescription ()` Description of the pipeline.
`List<Field>`	`getFields ()` A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
`String`	`getName ()` The name of the pipeline.
`String`	`getPipelineId ()` The pipeline identifier that was assigned by AWS Data Pipeline.
`List<Tag>`	`getTags ()` A list of tags to associated with a pipeline.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription (String description)` Description of the pipeline.
`void`	`setFields (Collection<Field> fields)` A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
`void`	`setName (String name)` The name of the pipeline.
`void`	`setPipelineId (String pipelineId)` The pipeline identifier that was assigned by AWS Data Pipeline.
`void`	`setTags (Collection<Tag> tags)` A list of tags to associated with a pipeline.
`String`	`toString ()` Returns a string representation of this object.
`PipelineDescription`	`withDescription (String description)` Description of the pipeline.
`PipelineDescription`	`withFields (Collection<Field> fields)` A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
`PipelineDescription`	`withFields (Field... fields)` A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
`PipelineDescription`	`withName (String name)` The name of the pipeline.
`PipelineDescription`	`withPipelineId (String pipelineId)` The pipeline identifier that was assigned by AWS Data Pipeline.
`PipelineDescription`	`withTags (Collection<Tag> tags)` A list of tags to associated with a pipeline.
`PipelineDescription`	`withTags (Tag... tags)` A list of tags to associated with a pipeline.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PipelineDescription
```
public PipelineDescription()
```
- Method Detail
  - setPipelineId
```
public void setPipelineId(String pipelineId)
```
    The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
    
    Parameters:
    
    pipelineId - The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
  - getPipelineId
```
public String getPipelineId()
```
    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.
  - withPipelineId
```
public PipelineDescription withPipelineId(String pipelineId)
```
    The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
    
    Parameters:
    
    pipelineId - The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the pipeline.
    
    Parameters:
    
    name - The name of the pipeline.
  - getName
```
public String getName()
```
    The name of the pipeline.
    
    Returns:
    
    The name of the pipeline.
  - withName
```
public PipelineDescription withName(String name)
```
    The name of the pipeline.
    
    Parameters:
    
    name - The name of the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFields
```
public List<Field> getFields()
```
    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
  - setFields
```
public void setFields(Collection<Field> fields)
```
    A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
    
    Parameters:
    
    fields - A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and
  - withFields
```
public PipelineDescription withFields(Field... fields)
```
    A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
    
    NOTE: This method appends the values to the existing list (if any). Use setFields(java.util.Collection) or withFields(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    fields - A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFields
```
public PipelineDescription withFields(Collection<Field> fields)
```
    A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
    
    Parameters:
    
    fields - A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Description of the pipeline.
    
    Parameters:
    
    description - Description of the pipeline.
  - getDescription
```
public String getDescription()
```
    Description of the pipeline.
    
    Returns:
    
    Description of the pipeline.
  - withDescription
```
public PipelineDescription withDescription(String description)
```
    Description of the pipeline.
    
    Parameters:
    
    description - Description of the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    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.
  - setTags
```
public void setTags(Collection<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.
    
    Parameters:
    
    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.
  - withTags
```
public PipelineDescription withTags(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public PipelineDescription withTags(Collection<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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PipelineDescription clone()
```
    Overrides:
    
    clone 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class PipelineDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipelineDescription

Method Detail

setPipelineId

getPipelineId

withPipelineId

setName

getName

withName

getFields

setFields

withFields

withFields

setDescription

getDescription

withDescription

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall