Share via

RegistrationStatusManager Class

Package:
com.microsoft.azure.sdk.iot.provisioning.service
Maven Artifact:
com.microsoft.azure.sdk.iot.provisioning:provisioning-service-client:1.7.0
  • java.lang.Object
    • com.microsoft.azure.sdk.iot.provisioning.service.RegistrationStatusManager

public class RegistrationStatusManager

Registration Status Manager

This is the inner class that implements the Registration Status APIs.

For the exposed API, please see ProvisioningServiceClient.

Method Summary

Modifier and Type Method and Description
Query createEnrollmentGroupQuery(QuerySpecification querySpecification, String enrollmentGroupId, int pageSize)

Create a new registration status query for enrollmentGroup.
static RegistrationStatusManager createFromContractApiHttp(ContractApiHttp contractApiHttp)

Create a new instance of the RegistrationStatusManager using the provided connection string and https as the transport protocol.
void delete(DeviceRegistrationState DeviceRegistrationState)

Delete registration status.
void delete(String id, String eTag)

Delete registration status.
DeviceRegistrationState get(String id)

Get device registration status information.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

createEnrollmentGroupQuery

public Query createEnrollmentGroupQuery(QuerySpecification querySpecification, String enrollmentGroupId, int pageSize)

Create a new registration status query for enrollmentGroup.

Parameters:

querySpecification - is a String with the SQL query specification. It cannot be null.
enrollmentGroupId - is a String with the enrollmentGroupId of the enrollmentGroup to delete. It cannot be null or empty.
pageSize - the int with the maximum number of items per iteration. It can be 0 for default, but not negative.

Returns:

A Query iterator.

createFromContractApiHttp

public static RegistrationStatusManager createFromContractApiHttp(ContractApiHttp contractApiHttp)

Create a new instance of the RegistrationStatusManager using the provided connection string and https as the transport protocol.

Parameters:

contractApiHttp - is the class that cares the Http connection.

Returns:

The RegistrationStatusManager with the new instance of this class.

delete

public void delete(DeviceRegistrationState DeviceRegistrationState)

Delete registration status.

Parameters:

DeviceRegistrationState - is a DeviceRegistrationState that describes the registration status that will be deleted. It cannot be null.

Throws:

ProvisioningServiceClientException - if the provided parameter is not correct.

delete

public void delete(String id, String eTag)

Delete registration status.

Parameters:

id - is a String with the identification of the registration status to delete. It cannot be null or empty.
eTag - is a String with the eTag of the enrollment to delete. It can be null or empty (ignored).

Throws:

ProvisioningServiceClientException - if the provided id is not correct.

get

public DeviceRegistrationState get(String id)

Get device registration status information.

Parameters:

id - the String that identifies the registration status. It cannot be null or empty.

Returns:

An DeviceRegistrationState with the registration status information.

Throws:

ProvisioningServiceClientException - if the provided parameter is not correct.

Applies to