com.microsoft.azure.sdk.iot.service.devicetwin

Class QueryCollection

java.lang.Object

com.microsoft.azure.sdk.iot.service.devicetwin.QueryCollection

public class QueryCollection
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryCollection(int pageSize, QueryType requestQueryType, IotHubConnectionString iotHubConnectionString, URL url, HttpMethod httpMethod, long timeout) Constructor for non-sql based queries
protected	QueryCollection(String query, int pageSize, QueryType requestQueryType, IotHubConnectionString iotHubConnectionString, URL url, HttpMethod httpMethod, long timeout) Constructor for sql based queries

Method Summary

Modifier and Type	Method and Description
protected Integer	getPageSize() Getter for page size.
protected boolean	hasNext() Returns if this query collection has a next collection to return.
protected QueryCollectionResponse<String>	next() Returns the next QueryCollectionResponse object.
protected QueryCollectionResponse<String>	next(QueryOptions options) Returns the next QueryCollectionResponse object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryCollection

protected QueryCollection(String query,
                          int pageSize,
                          QueryType requestQueryType,
                          IotHubConnectionString iotHubConnectionString,
                          URL url,
                          HttpMethod httpMethod,
                          long timeout)

Constructor for sql based queries

Parameters:

query - the sql query to use

pageSize - the size of the page to return per query collection response

requestQueryType - the type of query this is

iotHubConnectionString - the connection string to connect with to query against

url - the url to query against

httpMethod - the http method to call with the query

timeout - timeout until the request expires

Throws:

IllegalArgumentException - if page size is 0 or negative, or if the query type is null or unknown, of if the query string is null or empty, or if the provided connection string is null, or if the provided url is null, or if the provided http method is null

QueryCollection

protected QueryCollection(int pageSize,
                          QueryType requestQueryType,
                          IotHubConnectionString iotHubConnectionString,
                          URL url,
                          HttpMethod httpMethod,
                          long timeout)

Constructor for non-sql based queries

Parameters:

pageSize - the size of the page to return per query collection response

requestQueryType - the type of query this is

iotHubConnectionString - the connection string to connect with to query against

url - the url to query against

httpMethod - the http method to call with the query

timeout - timeout until the request expires

Throws:

IllegalArgumentException - if page size is 0 or negative, or if the query type is null or unknown, or if the provided connection string is null, or if the provided url is null, or if the provided http method is null

Method Detail

hasNext

protected boolean hasNext()

Returns if this query collection has a next collection to return.

Returns:

true if there is another page to return in the query and false otherwise

next

protected QueryCollectionResponse<String> next()
                                        throws IOException,
                                               IotHubException

Returns the next QueryCollectionResponse object. The query shall continue with the same page size and use the internally saved continuation token.

Returns:

The next QueryCollectionResponse object or null if there is not a next QueryCollectionResponse object

Throws:

IOException - If an IOException occurs when calling the Service API, or if the results of that call are unexpected

IotHubException - If an IotHubException occurs when calling the Service API

next

protected QueryCollectionResponse<String> next(QueryOptions options)
                                        throws IOException,
                                               IotHubException

Returns the next QueryCollectionResponse object. If the provided query options have a continuation token, the query shall continue from that token. The query shall use the page size set in the query options.

Parameters:

options - The options for the query

Returns:

The next QueryCollectionResponse object or null if there is no next QueryCollectionResponse object

Throws:

IOException - If an IOException occurs when calling the Service API, or if the results of that call are unexpected

IotHubException - If an IotHubException occurs when calling the Service API

getPageSize

protected Integer getPageSize()

Getter for page size.

Returns:

the page size of this