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
Contains the parameters for DescribeObjects.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeObjectsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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(String... objectIds)
The IDs of the pipeline objects that contain the definitions to be described.DescribeObjectsRequest
withObjectIds(Collection<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, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setPipelineId
public void setPipelineId(String pipelineId)
The ID of the pipeline that contains the object definitions.
- Parameters:
pipelineId
- The ID of the pipeline that contains the object definitions.
-
getPipelineId
public String getPipelineId()
The ID of the pipeline that contains the object definitions.
- Returns:
- 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.
- Parameters:
pipelineId
- The ID of the pipeline that contains the object definitions.- Returns:
- Returns a reference to this 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 toDescribeObjects
.
-
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)
orwithObjectIds(java.util.Collection)
if you want to override the existing values.- 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 toDescribeObjects
.- Returns:
- Returns a reference to this 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
.- 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 toDescribeObjects
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
withEvaluateExpressions
public DescribeObjectsRequest withEvaluateExpressions(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.- Returns:
- Returns a reference to this 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.
-
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.- 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 callDescribeObjects
with the marker value from the previous call to retrieve the next set of results.
-
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.- 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.
-
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.- 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 callDescribeObjects
with the marker value from the previous call to retrieve the next set of results.- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-