Google Cloud IoT Core V1 Client - Class DeviceManagerClient (1.5.12)

$deviceManagerClient = new DeviceManagerClient();
try {
    $formattedParent = $deviceManagerClient->registryName('[PROJECT]', '[LOCATION]', '[REGISTRY]');
    $gatewayId = 'gateway_id';
    $deviceId = 'device_id';
    $response = $deviceManagerClient->bindDeviceToGateway($formattedParent, $gatewayId, $deviceId);
} finally {
    $deviceManagerClient->close();
}

Methods

deviceName

locationName

registryName

parseName

__construct

bindDeviceToGateway

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\BindDeviceToGatewayResponse;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $formattedParent The name of the registry. For example,
 *                                `projects/example-project/locations/us-central1/registries/my-registry`. Please see
 *                                {@see DeviceManagerClient::registryName()} for help formatting this field.
 * @param string $gatewayId       The value of `gateway_id` can be either the device numeric ID or the
 *                                user-defined device identifier.
 * @param string $deviceId        The device to associate with the specified gateway. The value of
 *                                `device_id` can be either the device numeric ID or the user-defined device
 *                                identifier.
 */
function bind_device_to_gateway_sample(
    string $formattedParent,
    string $gatewayId,
    string $deviceId
): void {
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var BindDeviceToGatewayResponse $response */
        $response = $deviceManagerClient->bindDeviceToGateway($formattedParent, $gatewayId, $deviceId);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DeviceManagerClient::registryName('[PROJECT]', '[LOCATION]', '[REGISTRY]');
    $gatewayId = '[GATEWAY_ID]';
    $deviceId = '[DEVICE_ID]';

    bind_device_to_gateway_sample($formattedParent, $gatewayId, $deviceId);
}

createDevice

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\Device;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $formattedParent The name of the device registry where this device should be created.
 *                                For example,
 *                                `projects/example-project/locations/us-central1/registries/my-registry`. Please see
 *                                {@see DeviceManagerClient::registryName()} for help formatting this field.
 */
function create_device_sample(string $formattedParent): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $device = new Device();

    // Call the API and handle any network failures.
    try {
        /** @var Device $response */
        $response = $deviceManagerClient->createDevice($formattedParent, $device);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DeviceManagerClient::registryName('[PROJECT]', '[LOCATION]', '[REGISTRY]');

    create_device_sample($formattedParent);
}

createDeviceRegistry

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceManagerClient;
use Google\Cloud\Iot\V1\DeviceRegistry;

/**
 * @param string $formattedParent The project and cloud region where this device registry must be created.
 *                                For example, `projects/example-project/locations/us-central1`. Please see
 *                                {@see DeviceManagerClient::locationName()} for help formatting this field.
 */
function create_device_registry_sample(string $formattedParent): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $deviceRegistry = new DeviceRegistry();

    // Call the API and handle any network failures.
    try {
        /** @var DeviceRegistry $response */
        $response = $deviceManagerClient->createDeviceRegistry($formattedParent, $deviceRegistry);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DeviceManagerClient::locationName('[PROJECT]', '[LOCATION]');

    create_device_registry_sample($formattedParent);
}

deleteDevice

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $formattedName The name of the device. For example,
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. Please see
 *                              {@see DeviceManagerClient::deviceName()} for help formatting this field.
 */
function delete_device_sample(string $formattedName): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        $deviceManagerClient->deleteDevice($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DeviceManagerClient::deviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[REGISTRY]',
        '[DEVICE]'
    );

    delete_device_sample($formattedName);
}

deleteDeviceRegistry

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $formattedName The name of the device registry. For example,
 *                              `projects/example-project/locations/us-central1/registries/my-registry`. Please see
 *                              {@see DeviceManagerClient::registryName()} for help formatting this field.
 */
function delete_device_registry_sample(string $formattedName): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        $deviceManagerClient->deleteDeviceRegistry($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DeviceManagerClient::registryName('[PROJECT]', '[LOCATION]', '[REGISTRY]');

    delete_device_registry_sample($formattedName);
}

getDevice

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\Device;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $formattedName The name of the device. For example,
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. Please see
 *                              {@see DeviceManagerClient::deviceName()} for help formatting this field.
 */
function get_device_sample(string $formattedName): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var Device $response */
        $response = $deviceManagerClient->getDevice($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DeviceManagerClient::deviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[REGISTRY]',
        '[DEVICE]'
    );

    get_device_sample($formattedName);
}

getDeviceRegistry

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceManagerClient;
use Google\Cloud\Iot\V1\DeviceRegistry;

/**
 * @param string $formattedName The name of the device registry. For example,
 *                              `projects/example-project/locations/us-central1/registries/my-registry`. Please see
 *                              {@see DeviceManagerClient::registryName()} for help formatting this field.
 */
function get_device_registry_sample(string $formattedName): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var DeviceRegistry $response */
        $response = $deviceManagerClient->getDeviceRegistry($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DeviceManagerClient::registryName('[PROJECT]', '[LOCATION]', '[REGISTRY]');

    get_device_registry_sample($formattedName);
}

getIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $deviceManagerClient->getIamPolicy($resource);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

listDeviceConfigVersions

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceManagerClient;
use Google\Cloud\Iot\V1\ListDeviceConfigVersionsResponse;

/**
 * @param string $formattedName The name of the device. For example,
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. Please see
 *                              {@see DeviceManagerClient::deviceName()} for help formatting this field.
 */
function list_device_config_versions_sample(string $formattedName): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var ListDeviceConfigVersionsResponse $response */
        $response = $deviceManagerClient->listDeviceConfigVersions($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DeviceManagerClient::deviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[REGISTRY]',
        '[DEVICE]'
    );

    list_device_config_versions_sample($formattedName);
}

listDeviceRegistries

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Iot\V1\DeviceManagerClient;
use Google\Cloud\Iot\V1\DeviceRegistry;

/**
 * @param string $formattedParent The project and cloud region path. For example,
 *                                `projects/example-project/locations/us-central1`. Please see
 *                                {@see DeviceManagerClient::locationName()} for help formatting this field.
 */
function list_device_registries_sample(string $formattedParent): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $deviceManagerClient->listDeviceRegistries($formattedParent);

        /** @var DeviceRegistry $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DeviceManagerClient::locationName('[PROJECT]', '[LOCATION]');

    list_device_registries_sample($formattedParent);
}

listDeviceStates

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceManagerClient;
use Google\Cloud\Iot\V1\ListDeviceStatesResponse;

/**
 * @param string $formattedName The name of the device. For example,
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. Please see
 *                              {@see DeviceManagerClient::deviceName()} for help formatting this field.
 */
function list_device_states_sample(string $formattedName): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var ListDeviceStatesResponse $response */
        $response = $deviceManagerClient->listDeviceStates($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DeviceManagerClient::deviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[REGISTRY]',
        '[DEVICE]'
    );

    list_device_states_sample($formattedName);
}

listDevices

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Iot\V1\Device;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $formattedParent The device registry path. Required. For example,
 *                                `projects/my-project/locations/us-central1/registries/my-registry`. Please see
 *                                {@see DeviceManagerClient::registryName()} for help formatting this field.
 */
function list_devices_sample(string $formattedParent): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $deviceManagerClient->listDevices($formattedParent);

        /** @var Device $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DeviceManagerClient::registryName('[PROJECT]', '[LOCATION]', '[REGISTRY]');

    list_devices_sample($formattedParent);
}

modifyCloudToDeviceConfig

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceConfig;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $formattedName The name of the device. For example,
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. Please see
 *                              {@see DeviceManagerClient::deviceName()} for help formatting this field.
 * @param string $binaryData    The configuration data for the device.
 */
function modify_cloud_to_device_config_sample(string $formattedName, string $binaryData): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var DeviceConfig $response */
        $response = $deviceManagerClient->modifyCloudToDeviceConfig($formattedName, $binaryData);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DeviceManagerClient::deviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[REGISTRY]',
        '[DEVICE]'
    );
    $binaryData = '...';

    modify_cloud_to_device_config_sample($formattedName, $binaryData);
}

sendCommandToDevice

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceManagerClient;
use Google\Cloud\Iot\V1\SendCommandToDeviceResponse;

/**
 * @param string $formattedName The name of the device. For example,
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
 *                              `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. Please see
 *                              {@see DeviceManagerClient::deviceName()} for help formatting this field.
 * @param string $binaryData    The command data to send to the device.
 */
function send_command_to_device_sample(string $formattedName, string $binaryData): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var SendCommandToDeviceResponse $response */
        $response = $deviceManagerClient->sendCommandToDevice($formattedName, $binaryData);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DeviceManagerClient::deviceName(
        '[PROJECT]',
        '[LOCATION]',
        '[REGISTRY]',
        '[DEVICE]'
    );
    $binaryData = '...';

    send_command_to_device_sample($formattedName, $binaryData);
}

setIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $policy = new Policy();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $deviceManagerClient->setIamPolicy($resource, $policy);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Iot\V1\DeviceManagerClient;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $permissions = [$permissionsElement,];

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $deviceManagerClient->testIamPermissions($resource, $permissions);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

unbindDeviceFromGateway

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceManagerClient;
use Google\Cloud\Iot\V1\UnbindDeviceFromGatewayResponse;

/**
 * @param string $formattedParent The name of the registry. For example,
 *                                `projects/example-project/locations/us-central1/registries/my-registry`. Please see
 *                                {@see DeviceManagerClient::registryName()} for help formatting this field.
 * @param string $gatewayId       The value of `gateway_id` can be either the device numeric ID or the
 *                                user-defined device identifier.
 * @param string $deviceId        The device to disassociate from the specified gateway. The value of
 *                                `device_id` can be either the device numeric ID or the user-defined device
 *                                identifier.
 */
function unbind_device_from_gateway_sample(
    string $formattedParent,
    string $gatewayId,
    string $deviceId
): void {
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Call the API and handle any network failures.
    try {
        /** @var UnbindDeviceFromGatewayResponse $response */
        $response = $deviceManagerClient->unbindDeviceFromGateway($formattedParent, $gatewayId, $deviceId);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DeviceManagerClient::registryName('[PROJECT]', '[LOCATION]', '[REGISTRY]');
    $gatewayId = '[GATEWAY_ID]';
    $deviceId = '[DEVICE_ID]';

    unbind_device_from_gateway_sample($formattedParent, $gatewayId, $deviceId);
}

updateDevice

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\Device;
use Google\Cloud\Iot\V1\DeviceManagerClient;
use Google\Protobuf\FieldMask;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_device_sample(): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $device = new Device();
    $updateMask = new FieldMask();

    // Call the API and handle any network failures.
    try {
        /** @var Device $response */
        $response = $deviceManagerClient->updateDevice($device, $updateMask);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

updateDeviceRegistry

use Google\ApiCore\ApiException;
use Google\Cloud\Iot\V1\DeviceManagerClient;
use Google\Cloud\Iot\V1\DeviceRegistry;
use Google\Protobuf\FieldMask;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_device_registry_sample(): void
{
    // Create a client.
    $deviceManagerClient = new DeviceManagerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $deviceRegistry = new DeviceRegistry();
    $updateMask = new FieldMask();

    // Call the API and handle any network failures.
    try {
        /** @var DeviceRegistry $response */
        $response = $deviceManagerClient->updateDeviceRegistry($deviceRegistry, $updateMask);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

Constants

SERVICE_NAME

Value: 'google.cloud.iot.v1.DeviceManager'

SERVICE_ADDRESS

Value: 'cloudiot.googleapis.com'

DEFAULT_SERVICE_PORT

Value: 443

CODEGEN_NAME

Value: 'gapic'