Class PipelineDescription

java.lang.Object
com.amazonaws.services.datapipeline.model.PipelineDescription
All Implemented Interfaces:
Serializable, Cloneable

public class PipelineDescription extends Object implements Serializable, Cloneable

Contains pipeline metadata.

See Also:
  • Constructor Details

    • PipelineDescription

      public PipelineDescription()
  • Method Details

    • 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:

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

      public void setFields(Collection<Field> fields)

      A list of read-only fields that contain metadata about the pipeline:

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

      public PipelineDescription withFields(Field... fields)

      A list of read-only fields that contain metadata about the pipeline:

      Parameters:
      fields - A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
      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:

      Parameters:
      fields - A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
      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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • 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