com.microsoft.azure.sdk.iot.service.query

Class TwinQueryResponse

java.lang.Object

com.microsoft.azure.sdk.iot.service.query.TwinQueryResponse

public class TwinQueryResponse
extends Object

A pageable set of Twin objects returned from a query.

Constructor Summary

Constructors

Constructor and Description
TwinQueryResponse(String json, QueryClient queryClient, String originalQuery)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
Twin	next() Return the next Twin from the query.
Twin	next(QueryPageOptions pageOptions) Return the next Twin from the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

TwinQueryResponse

public TwinQueryResponse(String json,
                         QueryClient queryClient,
                         String originalQuery)

Method Detail

hasNext

public boolean hasNext()

Returns:

True if the query has at least one more twin to return. False otherwise.

next

public Twin next()
          throws IotHubException,
                 IOException

Return the next Twin from the query. If the previous page of query results has been exhausted, then this method will make a request to the service to get the next page of results using the default paging options.

Returns:

the next Twin from the query.

Throws:

IotHubException - If any IoT Hub level errors occur such as an IotHubUnauthorizedException.

IOException - If any network level errors occur.

NoSuchElementException - If there is no next Twin to return anymore.

next

public Twin next(QueryPageOptions pageOptions)
          throws IotHubException,
                 IOException,
                 NoSuchElementException

Return the next Twin from the query. If the previous page of query results has been exhausted, then this method will make a request to the service to get the next page of results using the provided paging options.

Parameters:

pageOptions - the options for the next page of results if the next page is retrieved to fulfil this request for the next Twin. May not be null.

Returns:

the next Twin from the query.

Throws:

IotHubException - If any IoT Hub level errors occur such as an IotHubUnauthorizedException.

IOException - If any network level errors occur.

NoSuchElementException - If there is no next Twin to return anymore.