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

Class RawTwinQuery

java.lang.Object

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

public class RawTwinQuery
extends Object

Constructor Summary

Constructors

Constructor and Description
RawTwinQuery(String connectionString) Constructor to create instance from connection string
RawTwinQuery(String hostName, com.azure.core.credential.AzureSasCredential azureSasCredential) Constructor to create instance from connection string
RawTwinQuery(String hostName, com.azure.core.credential.TokenCredential credential) Constructor to create instance from connection string

Method Summary

Modifier and Type	Method and Description
static RawTwinQuery	createFromConnectionString(String connectionString) Deprecated. because this method declares a thrown IOException even though it never throws an IOException. Users are recommended to use RawTwinQuery(String) instead since it does not declare this exception even though it constructs the same RawTwinQuery.
boolean	hasNext(Query query) Returns the availability of next element in response.
String	next(Query query) Returns the next json element available in response
Query	query(String sqlQuery) Creates a query object for this query using default page size
Query	query(String sqlQuery, Integer pageSize) Creates a query object for this query

Methods inherited from class java.lang.Object

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

Constructor Detail

RawTwinQuery

public RawTwinQuery(String connectionString)

Constructor to create instance from connection string

Parameters:

connectionString - The iot hub connection string

RawTwinQuery

public RawTwinQuery(String hostName,
                    com.azure.core.credential.TokenCredential credential)

Constructor to create instance from connection string

Parameters:

hostName - The hostname of your IoT Hub instance (For instance, "your-iot-hub.azure-devices.net")

credential - The custom TokenCredential that will provide authentication tokens to this library when they are needed. The provided tokens must be Json Web Tokens.

RawTwinQuery

public RawTwinQuery(String hostName,
                    com.azure.core.credential.AzureSasCredential azureSasCredential)

Constructor to create instance from connection string

Parameters:

hostName - The hostname of your IoT Hub instance (For instance, "your-iot-hub.azure-devices.net")

azureSasCredential - The custom TokenCredential that will provide authentication tokens to this library when they are needed.

Method Detail

createFromConnectionString

@Deprecated
public static RawTwinQuery createFromConnectionString(String connectionString)
                                                            throws IOException

Deprecated. because this method declares a thrown IOException even though it never throws an IOException. Users are recommended to use RawTwinQuery(String) instead since it does not declare this exception even though it constructs the same RawTwinQuery.

Static constructor to create instance from connection string

Parameters:

connectionString - The iot hub connection string

Returns:

The instance of RawTwinQuery

Throws:

IOException - This exception is never thrown.

query

public Query query(String sqlQuery,
                   Integer pageSize)
            throws IotHubException,
                   IOException

Creates a query object for this query

Parameters:

sqlQuery - Sql style query for Raw data over twin

pageSize - Size to restrict response of query by

Returns:

Object for the query

Throws:

IotHubException - If IotHub did not respond successfully to the query

IOException - If any of the input parameters are incorrect

query

public Query query(String sqlQuery)
            throws IotHubException,
                   IOException

Creates a query object for this query using default page size

Parameters:

sqlQuery - Sql style query for Raw data over twin

Returns:

Object for the query

Throws:

IotHubException - If IotHub did not respond successfully to the query

IOException - If any of the input parameters are incorrect

hasNext

public boolean hasNext(Query query)
                throws IotHubException,
                       IOException

Returns the availability of next element in response. Sends the request again (if possible) to retrieve response until no response is found.

Parameters:

query - Object corresponding to the query

Returns:

True if available and false otherwise

Throws:

IotHubException - If IotHub could not respond successfully to the query request

IOException - If any of the input parameters are incorrect

next

public String next(Query query)
            throws IOException,
                   IotHubException,
                   NoSuchElementException

Returns the next json element available in response

Parameters:

query - Object corresponding for this query

Returns:

Next json element as a response to this query

Throws:

IOException - If any of input parameters are incorrect

IotHubException - If IotHub could not respond successfully to the query request

NoSuchElementException - If no other element is found