com.microsoft.azure.sdk.iot.provisioning.service.configs

Class QuerySpecification

java.lang.Object

com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable

com.microsoft.azure.sdk.iot.provisioning.service.configs.QuerySpecification

All Implemented Interfaces:

Serializable

public class QuerySpecification
extends Serializable

Representation of a single Device Provisioning Service query specification with a JSON serializer.

See Also:

Device Enrollment, Query Language, Serialized Form

Constructor Summary

Constructors

Constructor and Description
QuerySpecification(String query) CONSTRUCTOR

Method Summary

Modifier and Type	Method and Description
String	getQuery() Getter for the query.
com.google.gson.JsonElement	toJsonElement() Serializer

Methods inherited from class com.microsoft.azure.sdk.iot.provisioning.service.configs.Serializable

toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

QuerySpecification

public QuerySpecification(String query)

CONSTRUCTOR

This constructor creates an instance of the query specification.

The query must follow the provisioning service Query Language

When serialized, this class will look like the following example:

 
 {
     "query":"SELECT * FROM enrollments",
 }
 
 

Parameters:

query - the String with the query. It cannot be null, empty or a invalid query.

Throws:

IllegalArgumentException - If the provided query is not a valid query.

Method Detail

toJsonElement

public com.google.gson.JsonElement toJsonElement()

Serializer

Creates a JsonElement, which the content represents the information in this class and its subclasses in a JSON format. This is useful if the caller will integrate this JSON with jsons from other classes to generate a consolidated JSON.

Specified by:

toJsonElement in class Serializable

Returns:

The JsonElement with the content of this class.

getQuery

public String getQuery()

Getter for the query.

Returns:

The String with the information stored in the query. It cannot be null.