Share via

TwinQueryResponse Class

  • Reference
Package:
com.microsoft.azure.sdk.iot.service.query
  • java.lang.Object
    • com.microsoft.azure.sdk.iot.service.query.TwinQueryResponse

public class TwinQueryResponse

A pageable set of Twin objects returned from a query.

Constructor Summary

Constructor 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. 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.

Twin next(QueryPageOptions pageOptions)

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.

Constructor Details

TwinQueryResponse

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

Parameters:

json
queryClient
originalQuery

Method Details

hasNext

public boolean hasNext()

Returns:

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

next

public Twin next()

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)

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.

Applies to