Class PipelineDescription
- All Implemented Interfaces:
Serializable
,Cloneable
Contains pipeline metadata.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Description of the pipeline.A list of read-only fields that contain metadata about the pipeline:getName()
The name of the pipeline.The pipeline identifier that was assigned by AWS Data Pipeline.getTags()
A list of tags to associated with a pipeline.int
hashCode()
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:void
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.toString()
Returns a string representation of this object; useful for testing and debugging.withDescription
(String description) Description of the pipeline.withFields
(Field... fields) A list of read-only fields that contain metadata about the pipeline:withFields
(Collection<Field> fields) A list of read-only fields that contain metadata about the pipeline:The name of the pipeline.withPipelineId
(String pipelineId) The pipeline identifier that was assigned by AWS Data Pipeline.A list of tags to associated with a pipeline.withTags
(Collection<Tag> tags) A list of tags to associated with a pipeline.
-
Constructor Details
-
PipelineDescription
public PipelineDescription()
-
-
Method Details
-
setPipelineId
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 formdf-297EG78HU43EEXAMPLE
.
-
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
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 formdf-297EG78HU43EEXAMPLE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
The name of the pipeline.
- Parameters:
name
- The name of the pipeline.
-
getName
The name of the pipeline.
- Returns:
- The name of the pipeline.
-
withName
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
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
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
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
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
Description of the pipeline.
- Parameters:
description
- Description of the pipeline.
-
getDescription
Description of the pipeline.
- Returns:
- Description of the pipeline.
-
withDescription
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
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
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
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)
orwithTags(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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-