204 строки
18 KiB
YAML
204 строки
18 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Query"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Query"
|
|
name: "Query"
|
|
nameWithType: "Query"
|
|
summary: "Sql style query Iot<wbr>Hub for twin, jobs, device jobs or raw data"
|
|
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 **Query**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.Query(int,com.microsoft.azure.sdk.iot.service.devicetwin.QueryType)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.Query(int pageSize, QueryType requestQueryType)"
|
|
name: "Query(int pageSize, QueryType requestQueryType)"
|
|
nameWithType: "Query.Query(int pageSize, QueryType requestQueryType)"
|
|
summary: "Constructor for Query."
|
|
parameters:
|
|
- description: "page size for the query response to request query over."
|
|
name: "pageSize"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Type of query."
|
|
name: "requestQueryType"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.QueryType?alt=com.microsoft.azure.sdk.iot.service.devicetwin.QueryType&text=QueryType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Query(int pageSize, QueryType requestQueryType)"
|
|
exceptions:
|
|
- description: "if the input parameters are invalid."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Constructor for Query."
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.Query(java.lang.String,int,com.microsoft.azure.sdk.iot.service.devicetwin.QueryType)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.Query(String query, int pageSize, QueryType requestQueryType)"
|
|
name: "Query(String query, int pageSize, QueryType requestQueryType)"
|
|
nameWithType: "Query.Query(String query, int pageSize, QueryType requestQueryType)"
|
|
summary: "Constructor for Query."
|
|
parameters:
|
|
- description: "Sql style query to be sent to IotHub."
|
|
name: "query"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "page size for the query response to request query over."
|
|
name: "pageSize"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Type of query."
|
|
name: "requestQueryType"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.QueryType?alt=com.microsoft.azure.sdk.iot.service.devicetwin.QueryType&text=QueryType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Query(String query, int pageSize, QueryType requestQueryType)"
|
|
exceptions:
|
|
- description: "if the input parameters are invalid."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Constructor for Query."
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.hasNext()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.hasNext()"
|
|
name: "hasNext()"
|
|
nameWithType: "Query.hasNext()"
|
|
summary: "Returns the availability of next element in the query response."
|
|
syntax: "public boolean hasNext()"
|
|
exceptions:
|
|
- description: "if sending the request is unsuccessful because of input parameters."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "if sending the request is unsuccessful because of input parameters."
|
|
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\" />"
|
|
desc: "Returns the availability of next element in the query response."
|
|
returns:
|
|
description: "the availability of next element in the query response."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.next()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.next()"
|
|
name: "next()"
|
|
nameWithType: "Query.next()"
|
|
summary: "provides the next element in query response."
|
|
syntax: "public Object next()"
|
|
exceptions:
|
|
- description: "if sending the request is unsuccessful because of input parameters."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "if sending the request is unsuccessful because of input parameters."
|
|
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 sending the request is unsuccessful because of input parameters."
|
|
type: "<xref href=\"java.util.NoSuchElementException?alt=java.util.NoSuchElementException&text=NoSuchElementException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "provides the next element in query response."
|
|
returns:
|
|
description: "the next element in query response."
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.sendQueryRequest(com.microsoft.azure.sdk.iot.service.IotHubConnectionString,java.net.URL,com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod,int,int,java.net.Proxy)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.sendQueryRequest(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, int httpConnectTimeout, int httpReadTimeout, Proxy proxy)"
|
|
name: "sendQueryRequest(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, int httpConnectTimeout, int httpReadTimeout, Proxy proxy)"
|
|
nameWithType: "Query.sendQueryRequest(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, int httpConnectTimeout, int httpReadTimeout, Proxy proxy)"
|
|
summary: "Sends request for the query to the Iot<wbr>Hub."
|
|
parameters:
|
|
- description: "Hub Connection String."
|
|
name: "iotHubConnectionString"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.IotHubConnectionString?alt=com.microsoft.azure.sdk.iot.service.IotHubConnectionString&text=IotHubConnectionString\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "URL to Query on."
|
|
name: "url"
|
|
type: "<xref href=\"java.net.URL?alt=java.net.URL&text=URL\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "HTTP Method for the requesting a query."
|
|
name: "method"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod?alt=com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod&text=HttpMethod\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the http connect timeout to use for this request."
|
|
name: "httpConnectTimeout"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the http read timeout to use for this request."
|
|
name: "httpReadTimeout"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the proxy to use, or null if no proxy should be used."
|
|
name: "proxy"
|
|
type: "<xref href=\"java.net.Proxy?alt=java.net.Proxy&text=Proxy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public QueryResponse sendQueryRequest(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, int httpConnectTimeout, int httpReadTimeout, Proxy proxy)"
|
|
exceptions:
|
|
- description: "If any of the input parameters are not valid."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If any of the input parameters are not valid."
|
|
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\" />"
|
|
desc: "Sends request for the query to the IotHub."
|
|
returns:
|
|
description: "QueryResponse object which holds the response Iterator."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.QueryResponse?alt=com.microsoft.azure.sdk.iot.service.devicetwin.QueryResponse&text=QueryResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.sendQueryRequest(com.microsoft.azure.sdk.iot.service.IotHubConnectionString,java.net.URL,com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod,java.lang.Long)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.sendQueryRequest(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, Long timeoutInMs)"
|
|
name: "sendQueryRequest(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, Long timeoutInMs)"
|
|
nameWithType: "Query.sendQueryRequest(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, Long timeoutInMs)"
|
|
summary: "Sends request for the query to the Iot<wbr>Hub."
|
|
deprecatedTag: "use <xref uid=\"com.microsoft.azure.sdk.iot.service.devicetwin.Query.sendQueryRequest(com.microsoft.azure.sdk.iot.service.IotHubConnectionString,java.net.URL,com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod,int,int,java.net.Proxy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#sendQueryRequest(IotHubConnectionString, URL, HttpMethod, int, int, Proxy)\"></xref> instead."
|
|
parameters:
|
|
- description: "Hub Connection String."
|
|
name: "iotHubConnectionString"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.IotHubConnectionString?alt=com.microsoft.azure.sdk.iot.service.IotHubConnectionString&text=IotHubConnectionString\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "URL to Query on."
|
|
name: "url"
|
|
type: "<xref href=\"java.net.URL?alt=java.net.URL&text=URL\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "HTTP Method for the requesting a query."
|
|
name: "method"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod?alt=com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod&text=HttpMethod\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Unused."
|
|
name: "timeoutInMs"
|
|
type: "<xref href=\"java.lang.Long?alt=java.lang.Long&text=Long\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "</br>public QueryResponse sendQueryRequest(IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, Long timeoutInMs)"
|
|
exceptions:
|
|
- description: "If any of the input parameters are not valid."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If any of the input parameters are not valid."
|
|
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\" />"
|
|
desc: "Sends request for the query to the IotHub."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "QueryResponse object which holds the response Iterator."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.QueryResponse?alt=com.microsoft.azure.sdk.iot.service.devicetwin.QueryResponse&text=QueryResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.sendQueryRequest(com.microsoft.azure.sdk.iot.service.auth.TokenCredentialCache,com.azure.core.credential.AzureSasCredential,com.microsoft.azure.sdk.iot.service.IotHubConnectionString,java.net.URL,com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod,int,int,java.net.Proxy)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.devicetwin.Query.sendQueryRequest(TokenCredentialCache credentialCache, AzureSasCredential azureSasCredential, IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, int httpConnectTimeout, int httpReadTimeout, Proxy proxy)"
|
|
name: "sendQueryRequest(TokenCredentialCache credentialCache, AzureSasCredential azureSasCredential, IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, int httpConnectTimeout, int httpReadTimeout, Proxy proxy)"
|
|
nameWithType: "Query.sendQueryRequest(TokenCredentialCache credentialCache, AzureSasCredential azureSasCredential, IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, int httpConnectTimeout, int httpReadTimeout, Proxy proxy)"
|
|
summary: "Sends request for the query to the Iot<wbr>Hub."
|
|
parameters:
|
|
- description: "The RBAC authorization token provider. May be null if azureSasCredential or iotHubConnectionString is not."
|
|
name: "credentialCache"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.auth.TokenCredentialCache?alt=com.microsoft.azure.sdk.iot.service.auth.TokenCredentialCache&text=TokenCredentialCache\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The SAS authorization token provider. May be null if credential or iotHubConnectionString is not."
|
|
name: "azureSasCredential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureSasCredential?alt=com.azure.core.credential.AzureSasCredential&text=AzureSasCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The iot hub connection string that SAS tokens will be derived from. May be null if azureSasCredential or credential is not."
|
|
name: "iotHubConnectionString"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.IotHubConnectionString?alt=com.microsoft.azure.sdk.iot.service.IotHubConnectionString&text=IotHubConnectionString\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "URL to Query on."
|
|
name: "url"
|
|
type: "<xref href=\"java.net.URL?alt=java.net.URL&text=URL\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "HTTP Method for the requesting a query."
|
|
name: "method"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod?alt=com.microsoft.azure.sdk.iot.service.transport.http.HttpMethod&text=HttpMethod\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the http connect timeout to use for this request."
|
|
name: "httpConnectTimeout"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the http read timeout to use for this request."
|
|
name: "httpReadTimeout"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the proxy to use, or null if no proxy should be used."
|
|
name: "proxy"
|
|
type: "<xref href=\"java.net.Proxy?alt=java.net.Proxy&text=Proxy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public QueryResponse sendQueryRequest(TokenCredentialCache credentialCache, AzureSasCredential azureSasCredential, IotHubConnectionString iotHubConnectionString, URL url, HttpMethod method, int httpConnectTimeout, int httpReadTimeout, Proxy proxy)"
|
|
exceptions:
|
|
- description: "If any of the input parameters are not valid."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If any of the input parameters are not valid."
|
|
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\" />"
|
|
desc: "Sends request for the query to the IotHub."
|
|
returns:
|
|
description: "QueryResponse object which holds the response Iterator."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.devicetwin.QueryResponse?alt=com.microsoft.azure.sdk.iot.service.devicetwin.QueryResponse&text=QueryResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Sql style query IotHub for twin, jobs, device jobs or raw data"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.service.devicetwin"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0
|