QueryObjectsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.datapipeline.model.QueryObjectsRequest

All Implemented Interfaces:

Serializable
```
public class QueryObjectsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the QueryObjects operation.
Queries a pipeline for the names of objects that match a specified set of conditions.

The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If HasMoreResults is set to True , you should continue to call QueryObjects, passing in the returned value for marker, until HasMoreResults returns False .

See Also:
DataPipeline.queryObjects(QueryObjectsRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

QueryObjectsRequest()

Constructors
Constructor and Description
`QueryObjectsRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Integer`	`getLimit()` Specifies 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()` Identifier of the pipeline to be queried for object names.
`Query`	`getQuery()` Query that defines the objects to be returned.
`String`	`getSphere()` Specifies whether the query applies to components or instances.
`int`	`hashCode()`
`void`	`setLimit(Integer limit)` Specifies 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)` Identifier of the pipeline to be queried for object names.
`void`	`setQuery(Query query)` Query that defines the objects to be returned.
`void`	`setSphere(String sphere)` Specifies 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)` Specifies 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)` Identifier of the pipeline to be queried for object names.
`QueryObjectsRequest`	`withQuery(Query query)` Query that defines the objects to be returned.
`QueryObjectsRequest`	`withSphere(String sphere)` Specifies whether the query applies to components or instances.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - QueryObjectsRequest
```
public QueryObjectsRequest()
```
- Method Detail
  - getPipelineId
```
public String getPipelineId()
```
    Identifier of the pipeline to be queried for object names.
    Constraints:
    Length: 1 - 1024
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    Returns:
    Identifier of the pipeline to be queried for object names.
  - setPipelineId
```
public void setPipelineId(String pipelineId)
```
    Identifier of the pipeline to be queried for object names.
    Constraints:
    Length: 1 - 1024
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    Parameters:
    pipelineId - Identifier of the pipeline to be queried for object names.
  - withPipelineId
```
public QueryObjectsRequest withPipelineId(String pipelineId)
```
    Identifier of the pipeline to be queried for object names.
    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 to be queried for object names.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getQuery
```
public Query getQuery()
```
    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:
    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)
```
    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 - 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)
```
    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 - 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()
```
    Specifies whether the query applies to components or instances. Allowable values: COMPONENT, INSTANCE, ATTEMPT.
    Constraints:
    Length: 0 - 1024
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    Returns:
    Specifies whether the query applies to components or instances. Allowable values: COMPONENT, INSTANCE, ATTEMPT.
  - setSphere
```
public void setSphere(String sphere)
```
    Specifies whether the query applies to components or instances. Allowable values: COMPONENT, INSTANCE, ATTEMPT.
    Constraints:
    Length: 0 - 1024
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    Parameters:
    sphere - Specifies whether the query applies to components or instances. Allowable values: COMPONENT, INSTANCE, ATTEMPT.
  - withSphere
```
public QueryObjectsRequest withSphere(String sphere)
```
    Specifies whether the query applies to components or instances. Allowable values: COMPONENT, INSTANCE, ATTEMPT.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 1024
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    Parameters:
    sphere - Specifies whether the query applies to components or instances. Allowable values: COMPONENT, INSTANCE, 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. The first time you call QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects 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 QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.
  - setMarker
```
public void setMarker(String marker)
```
    The starting point for the results to be returned. The first time you call QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects 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 QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.
  - withMarker
```
public QueryObjectsRequest withMarker(String marker)
```
    The starting point for the results to be returned. The first time you call QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects 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 QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects 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.
  - getLimit
```
public Integer getLimit()
```
    Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.
    
    Returns:
    Specifies 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)
```
    Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.
    
    Parameters:
    limit - Specifies 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)
```
    Specifies 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 - Specifies 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

Did this page help you?

Class QueryObjectsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

QueryObjectsRequest

Method Detail

getPipelineId

setPipelineId

withPipelineId

getQuery

setQuery

withQuery

getSphere

setSphere

withSphere

getMarker

setMarker

withMarker

getLimit

setLimit

withLimit

toString

hashCode

equals