com.amazonaws.services.datapipeline.model

Class DescribePipelinesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.DescribePipelinesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribePipelinesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribePipelines operation.

Retrieves 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 for which you have read permissions.

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

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
DescribePipelinesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getPipelineIds() The IDs of the pipelines to describe.
int	hashCode()
void	setPipelineIds(Collection<String> pipelineIds) The IDs of the pipelines to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribePipelinesRequest	withPipelineIds(Collection<String> pipelineIds) The IDs of the pipelines to describe.
DescribePipelinesRequest	withPipelineIds(String... pipelineIds) The IDs of the pipelines to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribePipelinesRequest

public DescribePipelinesRequest()

Method Detail

getPipelineIds

public List<String> getPipelineIds()

The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

Returns:

The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

setPipelineIds

public void setPipelineIds(Collection<String> pipelineIds)

The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

Parameters:

pipelineIds - The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

withPipelineIds

public DescribePipelinesRequest withPipelineIds(String... pipelineIds)

The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

NOTE: This method appends the values to the existing list (if any). Use setPipelineIds(java.util.Collection) or withPipelineIds(java.util.Collection) if you want to override the existing values.

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

Parameters:

pipelineIds - The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

Returns:

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

withPipelineIds

public DescribePipelinesRequest withPipelineIds(Collection<String> pipelineIds)

The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

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

Parameters:

pipelineIds - The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call 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

clone

public DescribePipelinesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()