com.amazonaws.services.datapipeline.model

Class DescribePipelinesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.DescribePipelinesRequest

All Implemented Interfaces:

Serializable

public class DescribePipelinesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribePipelines operation.

Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read permission for.

To retrieve the full pipeline definition instead of metadata about the pipeline, call the GetPipelineDefinition action.

See Also:

DataPipeline.describePipelines(DescribePipelinesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribePipelinesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getPipelineIds() Identifiers of the pipelines to describe.
int	hashCode()
void	setPipelineIds(Collection<String> pipelineIds) Identifiers of the pipelines to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribePipelinesRequest	withPipelineIds(Collection<String> pipelineIds) Identifiers of the pipelines to describe.
DescribePipelinesRequest	withPipelineIds(String... pipelineIds) Identifiers of the pipelines to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribePipelinesRequest

public DescribePipelinesRequest()

Method Detail

getPipelineIds

public List<String> getPipelineIds()

Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

Returns:

Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

setPipelineIds

public void setPipelineIds(Collection<String> pipelineIds)

Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

Parameters:

pipelineIds - Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

withPipelineIds

public DescribePipelinesRequest withPipelineIds(String... pipelineIds)

Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

Returns a reference to this object so that method calls can be chained together.

Parameters:

pipelineIds - Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

Returns:

A reference to this updated object so that method calls can be chained together.

withPipelineIds

public DescribePipelinesRequest withPipelineIds(Collection<String> pipelineIds)

Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

Returns a reference to this object so that method calls can be chained together.

Parameters:

pipelineIds - Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

Returns:

A reference to this updated 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:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object