com.amazonaws.services.datapipeline.model

Class QueryObjectsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.QueryObjectsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class QueryObjectsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the QueryObjects operation.

Queries the specified pipeline for the names of objects that match the specified set of conditions.

See Also:

DataPipeline.queryObjects(QueryObjectsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
QueryObjectsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
QueryObjectsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Integer	getLimit() The maximum number of object names that QueryObjects will return in a single call.
String	getMarker() The starting point for the results to be returned.
String	getPipelineId() The ID of the pipeline.
Query	getQuery() The query that defines the objects to be returned.
String	getSphere() Indicates whether the query applies to components or instances.
int	hashCode()
void	setLimit(Integer limit) The maximum number of object names that QueryObjects will return in a single call.
void	setMarker(String marker) The starting point for the results to be returned.
void	setPipelineId(String pipelineId) The ID of the pipeline.
void	setQuery(Query query) The query that defines the objects to be returned.
void	setSphere(String sphere) Indicates whether the query applies to components or instances.
String	toString() Returns a string representation of this object; useful for testing and debugging.
QueryObjectsRequest	withLimit(Integer limit) The maximum number of object names that QueryObjects will return in a single call.
QueryObjectsRequest	withMarker(String marker) The starting point for the results to be returned.
QueryObjectsRequest	withPipelineId(String pipelineId) The ID of the pipeline.
QueryObjectsRequest	withQuery(Query query) The query that defines the objects to be returned.
QueryObjectsRequest	withSphere(String sphere) Indicates whether the query applies to components or instances.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryObjectsRequest

public QueryObjectsRequest()

Method Detail

getPipelineId

public String getPipelineId()

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The ID of the pipeline.

setPipelineId

public void setPipelineId(String pipelineId)

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

pipelineId - The ID of the pipeline.

withPipelineId

public QueryObjectsRequest withPipelineId(String pipelineId)

The ID of the pipeline.

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

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

pipelineId - The ID of the pipeline.

Returns:

A reference to this updated object so that method calls can be chained together.

getQuery

public Query getQuery()

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Returns:

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

setQuery

public void setQuery(Query query)

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Parameters:

query - The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

withQuery

public QueryObjectsRequest withQuery(Query query)

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

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

Parameters:

query - The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Returns:

A reference to this updated object so that method calls can be chained together.

getSphere

public String getSphere()

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

setSphere

public void setSphere(String sphere)

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

sphere - Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

withSphere

public QueryObjectsRequest withSphere(String sphere)

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

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

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

sphere - Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Returns:

A reference to this updated object so that method calls can be chained together.

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 QueryObjects with the marker value from the previous call to retrieve the next set of results.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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 QueryObjects with the marker value from the previous call to retrieve the next set of results.

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 QueryObjects with the marker value from the previous call to retrieve the next set of results.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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 call QueryObjects with the marker value from the previous call to retrieve the next set of results.

withMarker

public QueryObjectsRequest 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 QueryObjects with the marker value from the previous call 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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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 call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Returns:

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

setLimit

public void setLimit(Integer limit)

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Parameters:

limit - The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

withLimit

public QueryObjectsRequest withLimit(Integer limit)

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

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

Parameters:

limit - The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Returns:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public QueryObjectsRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()