|
Did this page help you?Yes No Tell us about it... |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.datapipeline.model.DescribeObjectsRequest
public class DescribeObjectsRequest
Container for the parameters to the DescribeObjects operation
.
Returns 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.
DataPipeline.describeObjects(DescribeObjectsRequest)
,
Serialized FormConstructor Summary | |
---|---|
DescribeObjectsRequest()
|
Method Summary | |
---|---|
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()
Identifiers of the pipeline objects that contain the definitions to be described. |
String |
getPipelineId()
Identifier 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)
Identifiers of the pipeline objects that contain the definitions to be described. |
void |
setPipelineId(String pipelineId)
Identifier 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)
Identifiers of the pipeline objects that contain the definitions to be described. |
DescribeObjectsRequest |
withObjectIds(String... objectIds)
Identifiers of the pipeline objects that contain the definitions to be described. |
DescribeObjectsRequest |
withPipelineId(String pipelineId)
Identifier of the pipeline that contains the object definitions. |
Methods inherited from class com.amazonaws.AmazonWebServiceRequest |
---|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DescribeObjectsRequest()
Method Detail |
---|
public String getPipelineId()
Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*
public void setPipelineId(String pipelineId)
Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*
pipelineId
- Identifier of the pipeline that contains the object definitions.public DescribeObjectsRequest withPipelineId(String pipelineId)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*
pipelineId
- Identifier of the pipeline that contains the object definitions.
public List<String> getObjectIds()
public void setObjectIds(Collection<String> objectIds)
objectIds
- Identifiers 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(String... objectIds)
Returns a reference to this object so that method calls can be chained together.
objectIds
- Identifiers 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(Collection<String> objectIds)
Returns a reference to this object so that method calls can be chained together.
objectIds
- Identifiers 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 Boolean isEvaluateExpressions()
public void setEvaluateExpressions(Boolean evaluateExpressions)
evaluateExpressions
- Indicates whether any expressions in the object should be evaluated
when the object descriptions are returned.public DescribeObjectsRequest withEvaluateExpressions(Boolean evaluateExpressions)
Returns a reference to this object so that method calls can be chained together.
evaluateExpressions
- Indicates whether any expressions in the object should be evaluated
when the object descriptions are returned.
public Boolean getEvaluateExpressions()
public String getMarker()
HasMoreResults
as True
,
you can call DescribeObjects again and pass the marker value
from the response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*
HasMoreResults
as True
,
you can call DescribeObjects again and pass the marker value
from the response to retrieve the next set of results.public void setMarker(String marker)
HasMoreResults
as True
,
you can call DescribeObjects again and pass the marker value
from the response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*
marker
- The starting point for the results to be returned. The first time you
call DescribeObjects, this value should be empty. As long as
the action returns HasMoreResults
as True
,
you can call DescribeObjects again and pass the marker value
from the response to retrieve the next set of results.public DescribeObjectsRequest withMarker(String marker)
HasMoreResults
as True
,
you can call DescribeObjects again and pass the marker value
from the response 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: [ -??-??-?\r\n\t]*
marker
- The starting point for the results to be returned. The first time you
call DescribeObjects, this value should be empty. As long as
the action returns HasMoreResults
as True
,
you can call DescribeObjects again and pass the marker value
from the response to retrieve the next set of results.
public String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |