com.amazonaws.services.datapipeline.model

Class DescribeObjectsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.DescribeObjectsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeObjectsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeObjects operation.

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

See Also:

DataPipeline.describeObjects(DescribeObjectsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeObjectsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeObjectsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getEvaluateExpressions() Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
String	getMarker() The starting point for the results to be returned.
List<String>	getObjectIds() The IDs of the pipeline objects that contain the definitions to be described.
String	getPipelineId() The ID of the pipeline that contains the object definitions.
int	hashCode()
Boolean	isEvaluateExpressions() Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
void	setEvaluateExpressions(Boolean evaluateExpressions) Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
void	setMarker(String marker) The starting point for the results to be returned.
void	setObjectIds(Collection<String> objectIds) The IDs of the pipeline objects that contain the definitions to be described.
void	setPipelineId(String pipelineId) The ID of the pipeline that contains the object definitions.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeObjectsRequest	withEvaluateExpressions(Boolean evaluateExpressions) Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
DescribeObjectsRequest	withMarker(String marker) The starting point for the results to be returned.
DescribeObjectsRequest	withObjectIds(Collection<String> objectIds) The IDs of the pipeline objects that contain the definitions to be described.
DescribeObjectsRequest	withObjectIds(String... objectIds) The IDs of the pipeline objects that contain the definitions to be described.
DescribeObjectsRequest	withPipelineId(String pipelineId) The ID of the pipeline that contains the object definitions.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, 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

DescribeObjectsRequest

public DescribeObjectsRequest()

Method Detail

getPipelineId

public String getPipelineId()

The ID of the pipeline that contains the object definitions.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The ID of the pipeline that contains the object definitions.

setPipelineId

public void setPipelineId(String pipelineId)

The ID of the pipeline that contains the object definitions.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

pipelineId - The ID of the pipeline that contains the object definitions.

withPipelineId

public DescribeObjectsRequest withPipelineId(String pipelineId)

The ID of the pipeline that contains the object definitions.

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

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

pipelineId - The ID of the pipeline that contains the object definitions.

Returns:

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

getObjectIds

public List<String> getObjectIds()

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Returns:

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

setObjectIds

public void setObjectIds(Collection<String> objectIds)

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Parameters:

objectIds - The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

withObjectIds

public DescribeObjectsRequest withObjectIds(String... objectIds)

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

NOTE: This method appends the values to the existing list (if any). Use setObjectIds(java.util.Collection) or withObjectIds(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:

objectIds - The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Returns:

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

withObjectIds

public DescribeObjectsRequest withObjectIds(Collection<String> objectIds)

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

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

Parameters:

objectIds - The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Returns:

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

isEvaluateExpressions

public Boolean isEvaluateExpressions()

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Returns:

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

setEvaluateExpressions

public void setEvaluateExpressions(Boolean evaluateExpressions)

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Parameters:

evaluateExpressions - Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

withEvaluateExpressions

public DescribeObjectsRequest withEvaluateExpressions(Boolean evaluateExpressions)

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

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

Parameters:

evaluateExpressions - Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Returns:

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

getEvaluateExpressions

public Boolean getEvaluateExpressions()

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Returns:

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

getMarker

public String getMarker()

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

setMarker

public void setMarker(String marker)

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

marker - The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

withMarker

public DescribeObjectsRequest withMarker(String marker)

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

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

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

marker - The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

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 DescribeObjectsRequest 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()