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

Reference documentation and code samples for the Google Cloud IoT Core V1 Client class DeviceManagerClient.

Service Description: Internet of Things (IoT) service. Securely connect and manage IoT devices.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Iot\V1\DeviceManagerClient for the stable implementation

Namespace

Google \ Cloud \ Iot \ V1 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
options array

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

bindDeviceToGateway

Associates the device with the gateway.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::bindDeviceToGatewayAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\BindDeviceToGatewayRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\BindDeviceToGatewayResponse

createDevice

Creates a device in a device registry.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::createDeviceAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\CreateDeviceRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\Device

createDeviceRegistry

Creates a device registry that contains devices.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::createDeviceRegistryAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\CreateDeviceRegistryRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\DeviceRegistry

deleteDevice

Parameters
NameDescription
request Google\Cloud\Iot\V1\DeleteDeviceRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteDeviceRegistry

Deletes a device registry configuration.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::deleteDeviceRegistryAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\DeleteDeviceRegistryRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

getDevice

Gets details about a device.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::getDeviceAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\GetDeviceRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\Device

getDeviceRegistry

Gets a device registry configuration.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::getDeviceRegistryAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\GetDeviceRegistryRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\DeviceRegistry

getIamPolicy

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::getIamPolicyAsync() .

Parameters
NameDescription
request Google\Cloud\Iam\V1\GetIamPolicyRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\Policy

listDeviceConfigVersions

Lists the last few versions of the device configuration in descending order (i.e.: newest first).

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::listDeviceConfigVersionsAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\ListDeviceConfigVersionsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\ListDeviceConfigVersionsResponse

listDeviceRegistries

Parameters
NameDescription
request Google\Cloud\Iot\V1\ListDeviceRegistriesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse

listDeviceStates

Lists the last few versions of the device state in descending order (i.e.: newest first).

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::listDeviceStatesAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\ListDeviceStatesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\ListDeviceStatesResponse

listDevices

List devices in a device registry.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::listDevicesAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\ListDevicesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse

modifyCloudToDeviceConfig

Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::modifyCloudToDeviceConfigAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\ModifyCloudToDeviceConfigRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\DeviceConfig

sendCommandToDevice

Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder.

Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::sendCommandToDeviceAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\SendCommandToDeviceRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\SendCommandToDeviceResponse

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::setIamPolicyAsync() .

Parameters
NameDescription
request Google\Cloud\Iam\V1\SetIamPolicyRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\Policy

testIamPermissions

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::testIamPermissionsAsync() .

Parameters
NameDescription
request Google\Cloud\Iam\V1\TestIamPermissionsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iam\V1\TestIamPermissionsResponse

unbindDeviceFromGateway

Deletes the association between the device and the gateway.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::unbindDeviceFromGatewayAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\UnbindDeviceFromGatewayRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\UnbindDeviceFromGatewayResponse

updateDevice

Parameters
NameDescription
request Google\Cloud\Iot\V1\UpdateDeviceRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\Device

updateDeviceRegistry

Updates a device registry configuration.

The async variant is Google\Cloud\Iot\V1\Client\DeviceManagerClient::updateDeviceRegistryAsync() .

Parameters
NameDescription
request Google\Cloud\Iot\V1\UpdateDeviceRegistryRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Iot\V1\DeviceRegistry

bindDeviceToGatewayAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\BindDeviceToGatewayRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createDeviceAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\CreateDeviceRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createDeviceRegistryAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\CreateDeviceRegistryRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteDeviceAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\DeleteDeviceRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteDeviceRegistryAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\DeleteDeviceRegistryRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getDeviceAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\GetDeviceRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getDeviceRegistryAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\GetDeviceRegistryRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
NameDescription
request Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listDeviceConfigVersionsAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\ListDeviceConfigVersionsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listDeviceRegistriesAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\ListDeviceRegistriesRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listDeviceStatesAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\ListDeviceStatesRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listDevicesAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\ListDevicesRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

modifyCloudToDeviceConfigAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\ModifyCloudToDeviceConfigRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

sendCommandToDeviceAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\SendCommandToDeviceRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
NameDescription
request Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
NameDescription
request Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

unbindDeviceFromGatewayAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\UnbindDeviceFromGatewayRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateDeviceAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\UpdateDeviceRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateDeviceRegistryAsync

Parameters
NameDescription
request Google\Cloud\Iot\V1\UpdateDeviceRegistryRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

static::deviceName

Formats a string containing the fully-qualified path to represent a device resource.

Parameters
NameDescription
project string
location string
registry string
device string
Returns
TypeDescription
stringThe formatted device resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
stringThe formatted location resource.

static::registryName

Formats a string containing the fully-qualified path to represent a registry resource.

Parameters
NameDescription
project string
location string
registry string
Returns
TypeDescription
stringThe formatted registry resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • device: projects/{project}/locations/{location}/registries/{registry}/devices/{device}
  • location: projects/{project}/locations/{location}
  • registry: projects/{project}/locations/{location}/registries/{registry}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.