Class DescribeObjectsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Contains the parameters for DescribeObjects.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.The starting point for the results to be returned.The IDs of the pipeline objects that contain the definitions to be described.The ID of the pipeline that contains the object definitions.int
hashCode()
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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withEvaluateExpressions
(Boolean evaluateExpressions) Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.withMarker
(String marker) The starting point for the results to be returned.withObjectIds
(String... objectIds) The IDs of the pipeline objects that contain the definitions to be described.withObjectIds
(Collection<String> objectIds) The IDs of the pipeline objects that contain the definitions to be described.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
-
Constructor Details
-
DescribeObjectsRequest
public DescribeObjectsRequest()
-
-
Method Details
-
setPipelineId
The ID of the pipeline that contains the object definitions.
- Parameters:
pipelineId
- The ID of the pipeline that contains the object definitions.
-
getPipelineId
The ID of the pipeline that contains the object definitions.
- Returns:
- The ID of the pipeline that contains the object definitions.
-
withPipelineId
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
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-