178 строки
14 KiB
YAML
178 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery"
|
|
name: "RawTwinQuery"
|
|
nameWithType: "RawTwinQuery"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **RawTwinQuery**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.RawTwinQuery(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.RawTwinQuery(String connectionString)"
|
|
name: "RawTwinQuery(String connectionString)"
|
|
nameWithType: "RawTwinQuery.RawTwinQuery(String connectionString)"
|
|
summary: "Constructor to create instance from connection string"
|
|
parameters:
|
|
- description: "The iot hub connection string"
|
|
name: "connectionString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RawTwinQuery(String connectionString)"
|
|
desc: "Constructor to create instance from connection string"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.RawTwinQuery(java.lang.String,com.azure.core.credential.AzureSasCredential)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.RawTwinQuery(String hostName, AzureSasCredential azureSasCredential)"
|
|
name: "RawTwinQuery(String hostName, AzureSasCredential azureSasCredential)"
|
|
nameWithType: "RawTwinQuery.RawTwinQuery(String hostName, AzureSasCredential azureSasCredential)"
|
|
summary: "Constructor to create instance from connection string"
|
|
parameters:
|
|
- description: "The hostname of your IoT Hub instance (For instance, \"your-iot-hub.azure-devices.net\")"
|
|
name: "hostName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The custom <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> that will provide authentication tokens to\n this library when they are needed."
|
|
name: "azureSasCredential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureSasCredential?alt=com.azure.core.credential.AzureSasCredential&text=AzureSasCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RawTwinQuery(String hostName, AzureSasCredential azureSasCredential)"
|
|
desc: "Constructor to create instance from connection string"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.RawTwinQuery(java.lang.String,com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.RawTwinQuery(String hostName, TokenCredential credential)"
|
|
name: "RawTwinQuery(String hostName, TokenCredential credential)"
|
|
nameWithType: "RawTwinQuery.RawTwinQuery(String hostName, TokenCredential credential)"
|
|
summary: "Constructor to create instance from connection string"
|
|
parameters:
|
|
- description: "The hostname of your IoT Hub instance (For instance, \"your-iot-hub.azure-devices.net\")"
|
|
name: "hostName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The custom <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> that will provide authentication tokens to\n this library when they are needed. The provided tokens must be Json Web Tokens."
|
|
name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RawTwinQuery(String hostName, TokenCredential credential)"
|
|
desc: "Constructor to create instance from connection string"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.createFromConnectionString(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.createFromConnectionString(String connectionString)"
|
|
name: "createFromConnectionString(String connectionString)"
|
|
nameWithType: "RawTwinQuery.createFromConnectionString(String connectionString)"
|
|
summary: "Static constructor to create instance from connection string"
|
|
deprecatedTag: "because this method declares a thrown IOException even though it never throws an IOException. Users are recommended to use <xref uid=\"com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.RawTwinQuery(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#RawTwinQuery(String)\"></xref> instead since it does not declare this exception even though it constructs the same Raw<wbr>Twin<wbr>Query."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The iot hub connection string"
|
|
name: "connectionString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "</br>public static RawTwinQuery createFromConnectionString(String connectionString)"
|
|
exceptions:
|
|
- description: "This exception is never thrown."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Static constructor to create instance from connection string"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The instance of RawTwinQuery"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery?alt=com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery&text=RawTwinQuery\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.hasNext(com.microsoft.azure.sdk.iot.service.devicetwin.Query)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.hasNext(Query query)"
|
|
name: "hasNext(Query query)"
|
|
nameWithType: "RawTwinQuery.hasNext(Query query)"
|
|
summary: "Returns the availability of next element in response."
|
|
modifiers:
|
|
- "synchronized"
|
|
parameters:
|
|
- description: "Object corresponding to the query"
|
|
name: "query"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.Query?alt=com.microsoft.azure.sdk.iot.service.devicetwin.Query&text=Query\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public synchronized boolean hasNext(Query query)"
|
|
exceptions:
|
|
- description: "If IotHub could not respond successfully to the query request"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.exceptions.IotHubException?alt=com.microsoft.azure.sdk.iot.service.exceptions.IotHubException&text=IotHubException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If IotHub could not respond successfully to the query request"
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Returns the availability of next element in response. Sends the request again (if possible) to retrieve response until no response is found."
|
|
returns:
|
|
description: "True if available and false otherwise"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.next(com.microsoft.azure.sdk.iot.service.devicetwin.Query)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.next(Query query)"
|
|
name: "next(Query query)"
|
|
nameWithType: "RawTwinQuery.next(Query query)"
|
|
summary: "Returns the next json element available in response"
|
|
modifiers:
|
|
- "synchronized"
|
|
parameters:
|
|
- description: "Object corresponding for this query"
|
|
name: "query"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.Query?alt=com.microsoft.azure.sdk.iot.service.devicetwin.Query&text=Query\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public synchronized String next(Query query)"
|
|
exceptions:
|
|
- description: "If any of input parameters are incorrect"
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If any of input parameters are incorrect"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.exceptions.IotHubException?alt=com.microsoft.azure.sdk.iot.service.exceptions.IotHubException&text=IotHubException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If any of input parameters are incorrect"
|
|
type: "<xref href=\"java.util.NoSuchElementException?alt=java.util.NoSuchElementException&text=NoSuchElementException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Returns the next json element available in response"
|
|
returns:
|
|
description: "Next json element as a response to this query"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.query(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.query(String sqlQuery)"
|
|
name: "query(String sqlQuery)"
|
|
nameWithType: "RawTwinQuery.query(String sqlQuery)"
|
|
summary: "Creates a query object for this query using default page size"
|
|
modifiers:
|
|
- "synchronized"
|
|
parameters:
|
|
- description: "Sql style query for Raw data over twin"
|
|
name: "sqlQuery"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public synchronized Query query(String sqlQuery)"
|
|
exceptions:
|
|
- description: "If IotHub did not respond successfully to the query"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.exceptions.IotHubException?alt=com.microsoft.azure.sdk.iot.service.exceptions.IotHubException&text=IotHubException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If IotHub did not respond successfully to the query"
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Creates a query object for this query using default page size"
|
|
returns:
|
|
description: "Object for the query"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.Query?alt=com.microsoft.azure.sdk.iot.service.devicetwin.Query&text=Query\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.query(java.lang.String,java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.RawTwinQuery.query(String sqlQuery, Integer pageSize)"
|
|
name: "query(String sqlQuery, Integer pageSize)"
|
|
nameWithType: "RawTwinQuery.query(String sqlQuery, Integer pageSize)"
|
|
summary: "Creates a query object for this query"
|
|
modifiers:
|
|
- "synchronized"
|
|
parameters:
|
|
- description: "Sql style query for Raw data over twin"
|
|
name: "sqlQuery"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Size to restrict response of query by"
|
|
name: "pageSize"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public synchronized Query query(String sqlQuery, Integer pageSize)"
|
|
exceptions:
|
|
- description: "If IotHub did not respond successfully to the query"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.exceptions.IotHubException?alt=com.microsoft.azure.sdk.iot.service.exceptions.IotHubException&text=IotHubException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If IotHub did not respond successfully to the query"
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Creates a query object for this query"
|
|
returns:
|
|
description: "Object for the query"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.Query?alt=com.microsoft.azure.sdk.iot.service.devicetwin.Query&text=Query\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.service.devicetwin"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0
|