com.google.api.services.androiddeviceprovisioning.v1

Class AndroidProvisioningPartner.Partners.Devices

java.lang.Object

com.google.api.services.androiddeviceprovisioning.v1.AndroidProvisioningPartner.Partners.Devices

Enclosing class:

AndroidProvisioningPartner.Partners

public class AndroidProvisioningPartner.Partners.Devices
extends Object

The "devices" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AndroidProvisioningPartner.Partners.Devices.Claim
class	AndroidProvisioningPartner.Partners.Devices.ClaimAsync
class	AndroidProvisioningPartner.Partners.Devices.FindByIdentifier
class	AndroidProvisioningPartner.Partners.Devices.FindByOwner
class	AndroidProvisioningPartner.Partners.Devices.Get
class	AndroidProvisioningPartner.Partners.Devices.GetSimLockState
class	AndroidProvisioningPartner.Partners.Devices.Metadata
class	AndroidProvisioningPartner.Partners.Devices.Unclaim
class	AndroidProvisioningPartner.Partners.Devices.UnclaimAsync
class	AndroidProvisioningPartner.Partners.Devices.UpdateMetadataAsync

Constructor Summary

Constructors

Constructor and Description
Devices()

Method Summary

Modifier and Type	Method and Description
AndroidProvisioningPartner.Partners.Devices.Claim	claim(Long partnerId, ClaimDeviceRequest content) Claims a device for a customer and adds it to zero-touch enrollment.
AndroidProvisioningPartner.Partners.Devices.ClaimAsync	claimAsync(Long partnerId, ClaimDevicesRequest content) Claims a batch of devices for a customer asynchronously.
AndroidProvisioningPartner.Partners.Devices.FindByIdentifier	findByIdentifier(Long partnerId, FindDevicesByDeviceIdentifierRequest content) Finds devices by hardware identifiers, such as IMEI.
AndroidProvisioningPartner.Partners.Devices.FindByOwner	findByOwner(Long partnerId, FindDevicesByOwnerRequest content) Finds devices claimed for customers.
AndroidProvisioningPartner.Partners.Devices.Get	get(String name) Gets a device.
AndroidProvisioningPartner.Partners.Devices.GetSimLockState	getSimLockState(Long partnerId, GetDeviceSimLockStateRequest content) Gets a device's SIM lock state.
AndroidProvisioningPartner.Partners.Devices.Metadata	metadata(Long metadataOwnerId, Long deviceId, UpdateDeviceMetadataRequest content) Updates reseller metadata associated with the device.
AndroidProvisioningPartner.Partners.Devices.Unclaim	unclaim(Long partnerId, UnclaimDeviceRequest content) Unclaims a device from a customer and removes it from zero-touch enrollment.
AndroidProvisioningPartner.Partners.Devices.UnclaimAsync	unclaimAsync(Long partnerId, UnclaimDevicesRequest content) Unclaims a batch of devices for a customer asynchronously.
AndroidProvisioningPartner.Partners.Devices.UpdateMetadataAsync	updateMetadataAsync(Long partnerId, UpdateDeviceMetadataInBatchRequest content) Updates the reseller metadata attached to a batch of devices.

Methods inherited from class java.lang.Object

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

Constructor Detail

Devices

public Devices()

Method Detail

claim

public AndroidProvisioningPartner.Partners.Devices.Claim claim(Long partnerId,
                                                               ClaimDeviceRequest content)
                                                        throws IOException

Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error. Create a request for the method "devices.claim". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - Required. The ID of the reseller partner.

content - the ClaimDeviceRequest

Returns:

the request

Throws:

IOException

claimAsync

public AndroidProvisioningPartner.Partners.Devices.ClaimAsync claimAsync(Long partnerId,
                                                                         ClaimDevicesRequest content)
                                                                  throws IOException

Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it- works#operations). Create a request for the method "devices.claimAsync". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - Required. The ID of the reseller partner.

content - the ClaimDevicesRequest

Returns:

the request

Throws:

IOException

findByIdentifier

public AndroidProvisioningPartner.Partners.Devices.FindByIdentifier findByIdentifier(Long partnerId,
                                                                                     FindDevicesByDeviceIdentifierRequest content)
                                                                              throws IOException

Finds devices by hardware identifiers, such as IMEI. Create a request for the method "devices.findByIdentifier". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - Required. The ID of the reseller partner.

content - the FindDevicesByDeviceIdentifierRequest

Returns:

the request

Throws:

IOException

findByOwner

public AndroidProvisioningPartner.Partners.Devices.FindByOwner findByOwner(Long partnerId,
                                                                           FindDevicesByOwnerRequest content)
                                                                    throws IOException

Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results. Create a request for the method "devices.findByOwner". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - Required. The ID of the reseller partner.

content - the FindDevicesByOwnerRequest

Returns:

the request

Throws:

IOException

get

public AndroidProvisioningPartner.Partners.Devices.Get get(String name)
                                                    throws IOException

Gets a device. Create a request for the method "devices.get". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.

Returns:

the request

Throws:

IOException

getSimLockState

public AndroidProvisioningPartner.Partners.Devices.GetSimLockState getSimLockState(Long partnerId,
                                                                                   GetDeviceSimLockStateRequest content)
                                                                            throws IOException

Gets a device's SIM lock state. Create a request for the method "devices.getSimLockState". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - Required. The ID of the partner.

content - the GetDeviceSimLockStateRequest

Returns:

the request

Throws:

IOException

metadata

public AndroidProvisioningPartner.Partners.Devices.Metadata metadata(Long metadataOwnerId,
                                                                     Long deviceId,
                                                                     UpdateDeviceMetadataRequest content)
                                                              throws IOException

Updates reseller metadata associated with the device. Android devices only. Create a request for the method "devices.metadata". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

metadataOwnerId - Required. The owner of the newly set metadata. Set this to the partner ID.

deviceId - Required. The ID of the device.

content - the UpdateDeviceMetadataRequest

Returns:

the request

Throws:

IOException

unclaim

public AndroidProvisioningPartner.Partners.Devices.Unclaim unclaim(Long partnerId,
                                                                   UnclaimDeviceRequest content)
                                                            throws IOException

Unclaims a device from a customer and removes it from zero-touch enrollment. Create a request for the method "devices.unclaim". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - Required. The ID of the reseller partner.

content - the UnclaimDeviceRequest

Returns:

the request

Throws:

IOException

unclaimAsync

public AndroidProvisioningPartner.Partners.Devices.UnclaimAsync unclaimAsync(Long partnerId,
                                                                             UnclaimDevicesRequest content)
                                                                      throws IOException

Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it- works#operations). Create a request for the method "devices.unclaimAsync". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - Required. The reseller partner ID.

content - the UnclaimDevicesRequest

Returns:

the request

Throws:

IOException

updateMetadataAsync

public AndroidProvisioningPartner.Partners.Devices.UpdateMetadataAsync updateMetadataAsync(Long partnerId,
                                                                                           UpdateDeviceMetadataInBatchRequest content)
                                                                                    throws IOException

Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). Android Devices only. Create a request for the method "devices.updateMetadataAsync". This request holds the parameters needed by the androiddeviceprovisioning server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

partnerId - Required. The reseller partner ID.

content - the UpdateDeviceMetadataInBatchRequest

Returns:

the request

Throws:

IOException