Documentation

Google_Service_AndroidProvisioningPartner_Resource_PartnersDevices extends Google_Service_Resource
in package

Application

The "devices" collection of methods.

Typical usage is: $androiddeviceprovisioningService = new Google_Service_AndroidProvisioningPartner(...); $devices = $androiddeviceprovisioningService->devices;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
claim() : Google_Service_AndroidProvisioningPartner_ClaimDeviceResponse: 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.
claimAsync() : Google_Service_AndroidProvisioningPartner_Operation: 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). (devices.claimAsync)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
findByIdentifier() : Google_Service_AndroidProvisioningPartner_FindDevicesByDeviceIdentifierResponse: Finds devices by hardware identifiers, such as IMEI.
findByOwner() : Google_Service_AndroidProvisioningPartner_FindDevicesByOwnerResponse: 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. (devices.findByOwner)
get() : Google_Service_AndroidProvisioningPartner_Device: Gets a device. (devices.get)
metadata() : Google_Service_AndroidProvisioningPartner_DeviceMetadata: Updates reseller metadata associated with the device. (devices.metadata)
unclaim() : Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty: Unclaims a device from a customer and removes it from zero-touch enrollment.
unclaimAsync() : Google_Service_AndroidProvisioningPartner_Operation: 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).
updateMetadataAsync() : Google_Service_AndroidProvisioningPartner_Operation: 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). (devices.updateMetadataAsync)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

claim()

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.


    public
                claim(string $partnerId, Google_Service_AndroidProvisioningPartner_ClaimDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_ClaimDeviceResponse

(devices.claim)

Parameters

$partnerId : string: Required. The ID of the reseller partner.
$postBody : Google_Service_AndroidProvisioningPartner_ClaimDeviceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidProvisioningPartner_ClaimDeviceResponse —

claimAsync()

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). (devices.claimAsync)


    public
                claimAsync(string $partnerId, Google_Service_AndroidProvisioningPartner_ClaimDevicesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_Operation

Parameters

$partnerId : string: Required. The ID of the reseller partner.
$postBody : Google_Service_AndroidProvisioningPartner_ClaimDevicesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidProvisioningPartner_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

findByIdentifier()

Finds devices by hardware identifiers, such as IMEI.


    public
                findByIdentifier(string $partnerId, Google_Service_AndroidProvisioningPartner_FindDevicesByDeviceIdentifierRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_FindDevicesByDeviceIdentifierResponse

(devices.findByIdentifier)

Parameters

$partnerId : string: Required. The ID of the reseller partner.
$postBody : Google_Service_AndroidProvisioningPartner_FindDevicesByDeviceIdentifierRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidProvisioningPartner_FindDevicesByDeviceIdentifierResponse —

findByOwner()

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. (devices.findByOwner)


    public
                findByOwner(string $partnerId, Google_Service_AndroidProvisioningPartner_FindDevicesByOwnerRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_FindDevicesByOwnerResponse

Parameters

$partnerId : string: Required. The ID of the reseller partner.
$postBody : Google_Service_AndroidProvisioningPartner_FindDevicesByOwnerRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidProvisioningPartner_FindDevicesByOwnerResponse —

get()

Gets a device. (devices.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_Device

Parameters

$name : string: Required. The device API resource name in the format partners/[PARTNER_ID]/devices/[DEVICE_ID].
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidProvisioningPartner_Device —

metadata()

Updates reseller metadata associated with the device. (devices.metadata)


    public
                metadata(string $metadataOwnerId, string $deviceId, Google_Service_AndroidProvisioningPartner_UpdateDeviceMetadataRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_DeviceMetadata

Parameters

$metadataOwnerId : string: Required. The owner of the newly set metadata. Set this to the partner ID.
$deviceId : string: Required. The ID of the device.
$postBody : Google_Service_AndroidProvisioningPartner_UpdateDeviceMetadataRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidProvisioningPartner_DeviceMetadata —

unclaim()

Unclaims a device from a customer and removes it from zero-touch enrollment.


    public
                unclaim(string $partnerId, Google_Service_AndroidProvisioningPartner_UnclaimDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty

(devices.unclaim)

Parameters

$partnerId : string: Required. The ID of the reseller partner.
$postBody : Google_Service_AndroidProvisioningPartner_UnclaimDeviceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidProvisioningPartner_AndroiddeviceprovisioningEmpty —

unclaimAsync()

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).


    public
                unclaimAsync(string $partnerId, Google_Service_AndroidProvisioningPartner_UnclaimDevicesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_Operation

(devices.unclaimAsync)

Parameters

$partnerId : string: Required. The reseller partner ID.
$postBody : Google_Service_AndroidProvisioningPartner_UnclaimDevicesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidProvisioningPartner_Operation —

updateMetadataAsync()

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). (devices.updateMetadataAsync)


    public
                updateMetadataAsync(string $partnerId, Google_Service_AndroidProvisioningPartner_UpdateDeviceMetadataInBatchRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidProvisioningPartner_Operation

Parameters

$partnerId : string: Required. The reseller partner ID.
$postBody : Google_Service_AndroidProvisioningPartner_UpdateDeviceMetadataInBatchRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidProvisioningPartner_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —