Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.datapipeline.model
Class DescribeObjectsRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.datapipeline.model.DescribeObjectsRequest

public class DescribeObjectsRequest
extends AmazonWebServiceRequest

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.

See Also:
DataPipeline.describeObjects(DescribeObjectsRequest)

Constructor Summary
DescribeObjectsRequest()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.Boolean getEvaluateExpressions()
          Returns the value of the EvaluateExpressions property for this object.
 java.lang.String getMarker()
          The starting point for the results to be returned.
 java.util.List<java.lang.String> getObjectIds()
          Identifiers of the pipeline objects that contain the definitions to be described.
 java.lang.String getPipelineId()
          Identifier of the pipeline that contains the object definitions.
 int hashCode()
           
 java.lang.Boolean isEvaluateExpressions()
          Returns the value of the EvaluateExpressions property for this object.
 void setEvaluateExpressions(java.lang.Boolean evaluateExpressions)
          Sets the value of the EvaluateExpressions property for this object.
 void setMarker(java.lang.String marker)
          The starting point for the results to be returned.
 void setObjectIds(java.util.Collection<java.lang.String> objectIds)
          Identifiers of the pipeline objects that contain the definitions to be described.
 void setPipelineId(java.lang.String pipelineId)
          Identifier 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)
          Sets the value of the EvaluateExpressions property for this object.
 DescribeObjectsRequest withMarker(java.lang.String marker)
          The starting point for the results to be returned.
 DescribeObjectsRequest withObjectIds(java.util.Collection<java.lang.String> objectIds)
          Identifiers of the pipeline objects that contain the definitions to be described.
 DescribeObjectsRequest withObjectIds(java.lang.String... objectIds)
          Identifiers of the pipeline objects that contain the definitions to be described.
 DescribeObjectsRequest withPipelineId(java.lang.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

DescribeObjectsRequest

public DescribeObjectsRequest()
Method Detail

getPipelineId

public java.lang.String getPipelineId()
Identifier of the pipeline that contains the object definitions.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Returns:
Identifier of the pipeline that contains the object definitions.

setPipelineId

public void setPipelineId(java.lang.String pipelineId)
Identifier of the pipeline that contains the object definitions.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Parameters:
pipelineId - Identifier of the pipeline that contains the object definitions.

withPipelineId

public DescribeObjectsRequest withPipelineId(java.lang.String pipelineId)
Identifier 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: [ -??-??-?\r\n\t]*

Parameters:
pipelineId - Identifier 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 java.util.List<java.lang.String> getObjectIds()
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

Returns:
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

setObjectIds

public void setObjectIds(java.util.Collection<java.lang.String> 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

Parameters:
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

withObjectIds

public DescribeObjectsRequest withObjectIds(java.lang.String... 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

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

Parameters:
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
Returns:
A reference to this updated object so that method calls can be chained together.

withObjectIds

public DescribeObjectsRequest withObjectIds(java.util.Collection<java.lang.String> 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

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

Parameters:
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
Returns:
A reference to this updated object so that method calls can be chained together.

isEvaluateExpressions

public java.lang.Boolean isEvaluateExpressions()
Returns the value of the EvaluateExpressions property for this object.

Returns:
The value of the EvaluateExpressions property for this object.

setEvaluateExpressions

public void setEvaluateExpressions(java.lang.Boolean evaluateExpressions)
Sets the value of the EvaluateExpressions property for this object.

Parameters:
evaluateExpressions - The new value for the EvaluateExpressions property for this object.

withEvaluateExpressions

public DescribeObjectsRequest withEvaluateExpressions(java.lang.Boolean evaluateExpressions)
Sets the value of the EvaluateExpressions property for this object.

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

Parameters:
evaluateExpressions - The new value for the EvaluateExpressions property for this object.
Returns:
A reference to this updated object so that method calls can be chained together.

getEvaluateExpressions

public java.lang.Boolean getEvaluateExpressions()
Returns the value of the EvaluateExpressions property for this object.

Returns:
The value of the EvaluateExpressions property for this object.

getMarker

public java.lang.String getMarker()
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.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Returns:
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.

setMarker

public void setMarker(java.lang.String 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.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Parameters:
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.

withMarker

public DescribeObjectsRequest withMarker(java.lang.String 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.

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

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.