public class DescribeObjectsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Contains the parameters for DescribeObjects.
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
evaluateExpressions
Indicates whether any expressions in the object should be evaluated when
the object descriptions are returned.
|
private java.lang.String |
marker
The starting point for the results to be returned.
|
private SdkInternalList<java.lang.String> |
objectIds
The IDs of the pipeline objects that contain the definitions to be
described.
|
private java.lang.String |
pipelineId
The ID of the pipeline that contains the object definitions.
|
NOOP
Constructor and Description |
---|
DescribeObjectsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeObjectsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getEvaluateExpressions()
Indicates whether any expressions in the object should be evaluated when
the object descriptions are returned.
|
java.lang.String |
getMarker()
The starting point for the results to be returned.
|
java.util.List<java.lang.String> |
getObjectIds()
The IDs of the pipeline objects that contain the definitions to be
described.
|
java.lang.String |
getPipelineId()
The ID of the pipeline that contains the object definitions.
|
int |
hashCode() |
java.lang.Boolean |
isEvaluateExpressions()
Indicates whether any expressions in the object should be evaluated when
the object descriptions are returned.
|
void |
setEvaluateExpressions(java.lang.Boolean evaluateExpressions)
Indicates whether any expressions in the object should be evaluated when
the object descriptions are returned.
|
void |
setMarker(java.lang.String marker)
The starting point for the results to be returned.
|
void |
setObjectIds(java.util.Collection<java.lang.String> objectIds)
The IDs of the pipeline objects that contain the definitions to be
described.
|
void |
setPipelineId(java.lang.String pipelineId)
The ID of the pipeline that contains the object definitions.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeObjectsRequest |
withEvaluateExpressions(java.lang.Boolean evaluateExpressions)
Indicates whether any expressions in the object should be evaluated when
the object descriptions are returned.
|
DescribeObjectsRequest |
withMarker(java.lang.String marker)
The starting point for the results to be returned.
|
DescribeObjectsRequest |
withObjectIds(java.util.Collection<java.lang.String> objectIds)
The IDs of the pipeline objects that contain the definitions to be
described.
|
DescribeObjectsRequest |
withObjectIds(java.lang.String... objectIds)
The IDs of the pipeline objects that contain the definitions to be
described.
|
DescribeObjectsRequest |
withPipelineId(java.lang.String pipelineId)
The ID of the pipeline that contains the object definitions.
|
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
private java.lang.String pipelineId
The ID of the pipeline that contains the object definitions.
private SdkInternalList<java.lang.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
.
private java.lang.Boolean evaluateExpressions
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
private java.lang.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.
public void setPipelineId(java.lang.String pipelineId)
The ID of the pipeline that contains the object definitions.
pipelineId
- The ID of the pipeline that contains the object definitions.public java.lang.String getPipelineId()
The ID of the pipeline that contains the object definitions.
public DescribeObjectsRequest withPipelineId(java.lang.String pipelineId)
The ID of the pipeline that contains the object definitions.
pipelineId
- The ID of the pipeline that contains the object definitions.public java.util.List<java.lang.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
.
DescribeObjects
.public void setObjectIds(java.util.Collection<java.lang.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
.
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
.public DescribeObjectsRequest withObjectIds(java.lang.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.
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
.public DescribeObjectsRequest withObjectIds(java.util.Collection<java.lang.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
.
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
.public void setEvaluateExpressions(java.lang.Boolean evaluateExpressions)
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
evaluateExpressions
- Indicates whether any expressions in the object should be
evaluated when the object descriptions are returned.public java.lang.Boolean getEvaluateExpressions()
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
public DescribeObjectsRequest withEvaluateExpressions(java.lang.Boolean evaluateExpressions)
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
evaluateExpressions
- Indicates whether any expressions in the object should be
evaluated when the object descriptions are returned.public java.lang.Boolean isEvaluateExpressions()
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
public void setMarker(java.lang.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.
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.public java.lang.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.
DescribeObjects
with the
marker value from the previous call to retrieve the next set of
results.public DescribeObjectsRequest withMarker(java.lang.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.
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.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeObjectsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()