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

Class Query

java.lang.Object

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

public class Query
extends Object

Constructor Summary

Constructors

Constructor and Description
Query(int pageSize, QueryType requestQueryType) Constructor for Query
Query(String query, int pageSize, QueryType requestQueryType) Constructor for Query

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Returns the availability of next element in the query response
Object	next() provides the next element in query response
QueryResponse	sendQueryRequest(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, Long timeoutInMs) Sends request for the query to the IotHub

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(String query,
             int pageSize,
             QueryType requestQueryType)
      throws IllegalArgumentException

Constructor for Query

Parameters:

query - Sql style query to be sent to IotHub

pageSize - page size for the query response to request query over

requestQueryType - Type of query

Throws:

IllegalArgumentException - if the input parameters are invalid

Query

public Query(int pageSize,
             QueryType requestQueryType)
      throws IllegalArgumentException

Constructor for Query

Parameters:

pageSize - page size for the query response to request query over

requestQueryType - Type of query

Throws:

IllegalArgumentException - if the input parameters are invalid

Method Detail

sendQueryRequest

public QueryResponse sendQueryRequest(IotHubConnectionString iotHubConnectionString,
                                      URL url,
                                      HttpMethod method,
                                      Long timeoutInMs)
                               throws IOException,
                                      IotHubException

Sends request for the query to the IotHub

Parameters:

iotHubConnectionString - Hub Connection String

url - URL to Query on

method - HTTP Method for the requesting a query

timeoutInMs - Maximum time to wait for the hub to respond

Returns:

QueryResponse object which holds the response Iterator

Throws:

IOException - If any of the input parameters are not valid

IotHubException - If HTTP response other then status ok is received

hasNext

public boolean hasNext()
                throws IOException,
                       IotHubException

Returns the availability of next element in the query response

Returns:

the availability of next element in the query response

Throws:

IOException - if sending the request is unsuccessful because of input parameters

IotHubException - if sending the request is unsuccessful at the Hub

next

public Object next()
            throws IOException,
                   IotHubException,
                   NoSuchElementException

provides the next element in query response

Returns:

the next element in query response

Throws:

IOException - if sending the request is unsuccessful because of input parameters

IotHubException - if sending the request is unsuccessful at the Hub

NoSuchElementException - if no further elements are available