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

Enum QueryResultType

java.lang.Object

java.lang.Enum<QueryResultType>

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

All Implemented Interfaces:

Serializable, Comparable<QueryResultType>

public enum QueryResultType
extends Enum<QueryResultType>

The Device Provisioning Service query result type

See Also:

Device Enrollment, Device Enrollment Group, Registration Status

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEVICE_REGISTRATION The query result in a list of enrollments.
ENROLLMENT The query result in a list of enrollments.
ENROLLMENT_GROUP The query result in a list of device registrations.
UNKNOWN the provisioning service cannot parse the information in the body.

Method Summary

Modifier and Type	Method and Description
static QueryResultType	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryResultType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

@SerializedName(value="unknown")
public static final QueryResultType UNKNOWN

the provisioning service cannot parse the information in the body. You shall cast the Objects in the items using String and parser it depending on the query the you sent.

ENROLLMENT

@SerializedName(value="enrollment")
public static final QueryResultType ENROLLMENT

The query result in a list of enrollments. You shall cast the Objects in the items using IndividualEnrollment.

ENROLLMENT_GROUP

@SerializedName(value="enrollmentGroup")
public static final QueryResultType ENROLLMENT_GROUP

The query result in a list of device registrations. You shall cast the Objects in the items using EnrollmentGroup.

DEVICE_REGISTRATION

@SerializedName(value="deviceRegistration")
public static final QueryResultType DEVICE_REGISTRATION

The query result in a list of enrollments. You shall cast the Objects in the items using DeviceRegistrationState.

Method Detail

values

public static QueryResultType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QueryResultType c : QueryResultType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QueryResultType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null