DeviceManager - Documentation

Constructor

new DeviceManager(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new DeviceManager service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

bindDeviceToGateway(request, callback) → {undefined}

Calls BindDeviceToGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IBindDeviceToGatewayRequest	BindDeviceToGatewayRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.BindDeviceToGatewayCallback	Node-style callback called with the error, if any, and BindDeviceToGatewayResponse

Returns:

Type	Description
undefined

bindDeviceToGateway(request) → {Promise.<google.cloud.iot.v1.BindDeviceToGatewayResponse>}

Calls BindDeviceToGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IBindDeviceToGatewayRequest	BindDeviceToGatewayRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.BindDeviceToGatewayResponse>	Promise

createDevice(request, callback) → {undefined}

Calls CreateDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.ICreateDeviceRequest	CreateDeviceRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.CreateDeviceCallback	Node-style callback called with the error, if any, and Device

Returns:

Type	Description
undefined

createDevice(request) → {Promise.<google.cloud.iot.v1.Device>}

Calls CreateDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.ICreateDeviceRequest	CreateDeviceRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.Device>	Promise

createDeviceRegistry(request, callback) → {undefined}

Calls CreateDeviceRegistry.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.ICreateDeviceRegistryRequest	CreateDeviceRegistryRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.CreateDeviceRegistryCallback	Node-style callback called with the error, if any, and DeviceRegistry

Returns:

Type	Description
undefined

createDeviceRegistry(request) → {Promise.<google.cloud.iot.v1.DeviceRegistry>}

Calls CreateDeviceRegistry.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.ICreateDeviceRegistryRequest	CreateDeviceRegistryRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.DeviceRegistry>	Promise

deleteDevice(request, callback) → {undefined}

Calls DeleteDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IDeleteDeviceRequest	DeleteDeviceRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.DeleteDeviceCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteDevice(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IDeleteDeviceRequest	DeleteDeviceRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

deleteDeviceRegistry(request, callback) → {undefined}

Calls DeleteDeviceRegistry.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IDeleteDeviceRegistryRequest	DeleteDeviceRegistryRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.DeleteDeviceRegistryCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteDeviceRegistry(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteDeviceRegistry.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IDeleteDeviceRegistryRequest	DeleteDeviceRegistryRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

getDevice(request, callback) → {undefined}

Calls GetDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IGetDeviceRequest	GetDeviceRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.GetDeviceCallback	Node-style callback called with the error, if any, and Device

Returns:

Type	Description
undefined

getDevice(request) → {Promise.<google.cloud.iot.v1.Device>}

Calls GetDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IGetDeviceRequest	GetDeviceRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.Device>	Promise

getDeviceRegistry(request, callback) → {undefined}

Calls GetDeviceRegistry.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IGetDeviceRegistryRequest	GetDeviceRegistryRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.GetDeviceRegistryCallback	Node-style callback called with the error, if any, and DeviceRegistry

Returns:

Type	Description
undefined

getDeviceRegistry(request) → {Promise.<google.cloud.iot.v1.DeviceRegistry>}

Calls GetDeviceRegistry.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IGetDeviceRegistryRequest	GetDeviceRegistryRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.DeviceRegistry>	Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.GetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.Policy>	Promise

listDeviceConfigVersions(request, callback) → {undefined}

Calls ListDeviceConfigVersions.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IListDeviceConfigVersionsRequest	ListDeviceConfigVersionsRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.ListDeviceConfigVersionsCallback	Node-style callback called with the error, if any, and ListDeviceConfigVersionsResponse

Returns:

Type	Description
undefined

listDeviceConfigVersions(request) → {Promise.<google.cloud.iot.v1.ListDeviceConfigVersionsResponse>}

Calls ListDeviceConfigVersions.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IListDeviceConfigVersionsRequest	ListDeviceConfigVersionsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.ListDeviceConfigVersionsResponse>	Promise

listDeviceRegistries(request, callback) → {undefined}

Calls ListDeviceRegistries.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IListDeviceRegistriesRequest	ListDeviceRegistriesRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.ListDeviceRegistriesCallback	Node-style callback called with the error, if any, and ListDeviceRegistriesResponse

Returns:

Type	Description
undefined

listDeviceRegistries(request) → {Promise.<google.cloud.iot.v1.ListDeviceRegistriesResponse>}

Calls ListDeviceRegistries.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IListDeviceRegistriesRequest	ListDeviceRegistriesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.ListDeviceRegistriesResponse>	Promise

listDeviceStates(request, callback) → {undefined}

Calls ListDeviceStates.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IListDeviceStatesRequest	ListDeviceStatesRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.ListDeviceStatesCallback	Node-style callback called with the error, if any, and ListDeviceStatesResponse

Returns:

Type	Description
undefined

listDeviceStates(request) → {Promise.<google.cloud.iot.v1.ListDeviceStatesResponse>}

Calls ListDeviceStates.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IListDeviceStatesRequest	ListDeviceStatesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.ListDeviceStatesResponse>	Promise

listDevices(request, callback) → {undefined}

Calls ListDevices.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IListDevicesRequest	ListDevicesRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.ListDevicesCallback	Node-style callback called with the error, if any, and ListDevicesResponse

Returns:

Type	Description
undefined

listDevices(request) → {Promise.<google.cloud.iot.v1.ListDevicesResponse>}

Calls ListDevices.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IListDevicesRequest	ListDevicesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.ListDevicesResponse>	Promise

modifyCloudToDeviceConfig(request, callback) → {undefined}

Calls ModifyCloudToDeviceConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest	ModifyCloudToDeviceConfigRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.ModifyCloudToDeviceConfigCallback	Node-style callback called with the error, if any, and DeviceConfig

Returns:

Type	Description
undefined

modifyCloudToDeviceConfig(request) → {Promise.<google.cloud.iot.v1.DeviceConfig>}

Calls ModifyCloudToDeviceConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest	ModifyCloudToDeviceConfigRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.DeviceConfig>	Promise

sendCommandToDevice(request, callback) → {undefined}

Calls SendCommandToDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.ISendCommandToDeviceRequest	SendCommandToDeviceRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.SendCommandToDeviceCallback	Node-style callback called with the error, if any, and SendCommandToDeviceResponse

Returns:

Type	Description
undefined

sendCommandToDevice(request) → {Promise.<google.cloud.iot.v1.SendCommandToDeviceResponse>}

Calls SendCommandToDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.ISendCommandToDeviceRequest	SendCommandToDeviceRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.SendCommandToDeviceResponse>	Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.SetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.Policy>	Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.TestIamPermissionsCallback	Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns:

Type	Description
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.TestIamPermissionsResponse>	Promise

unbindDeviceFromGateway(request, callback) → {undefined}

Calls UnbindDeviceFromGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest	UnbindDeviceFromGatewayRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.UnbindDeviceFromGatewayCallback	Node-style callback called with the error, if any, and UnbindDeviceFromGatewayResponse

Returns:

Type	Description
undefined

unbindDeviceFromGateway(request) → {Promise.<google.cloud.iot.v1.UnbindDeviceFromGatewayResponse>}

Calls UnbindDeviceFromGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest	UnbindDeviceFromGatewayRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.UnbindDeviceFromGatewayResponse>	Promise

updateDevice(request, callback) → {undefined}

Calls UpdateDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IUpdateDeviceRequest	UpdateDeviceRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.UpdateDeviceCallback	Node-style callback called with the error, if any, and Device

Returns:

Type	Description
undefined

updateDevice(request) → {Promise.<google.cloud.iot.v1.Device>}

Calls UpdateDevice.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IUpdateDeviceRequest	UpdateDeviceRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.Device>	Promise

updateDeviceRegistry(request, callback) → {undefined}

Calls UpdateDeviceRegistry.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IUpdateDeviceRegistryRequest	UpdateDeviceRegistryRequest message or plain object
`callback`	google.cloud.iot.v1.DeviceManager.UpdateDeviceRegistryCallback	Node-style callback called with the error, if any, and DeviceRegistry

Returns:

Type	Description
undefined

updateDeviceRegistry(request) → {Promise.<google.cloud.iot.v1.DeviceRegistry>}

Calls UpdateDeviceRegistry.

Parameters:

Name	Type	Description
`request`	google.cloud.iot.v1.IUpdateDeviceRegistryRequest	UpdateDeviceRegistryRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.iot.v1.DeviceRegistry>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {DeviceManager}

Creates new DeviceManager service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
DeviceManager	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

BindDeviceToGatewayCallback(error, responseopt)

Callback as used by bindDeviceToGateway.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.BindDeviceToGatewayResponse	<optional>	BindDeviceToGatewayResponse

CreateDeviceCallback(error, responseopt)

Callback as used by createDevice.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.Device	<optional>	Device

CreateDeviceRegistryCallback(error, responseopt)

Callback as used by createDeviceRegistry.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.DeviceRegistry	<optional>	DeviceRegistry

DeleteDeviceCallback(error, responseopt)

Callback as used by deleteDevice.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

DeleteDeviceRegistryCallback(error, responseopt)

Callback as used by deleteDeviceRegistry.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

GetDeviceCallback(error, responseopt)

Callback as used by getDevice.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.Device	<optional>	Device

GetDeviceRegistryCallback(error, responseopt)

Callback as used by getDeviceRegistry.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.DeviceRegistry	<optional>	DeviceRegistry

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.iam.v1.Policy	<optional>	Policy

ListDeviceConfigVersionsCallback(error, responseopt)

Callback as used by listDeviceConfigVersions.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.ListDeviceConfigVersionsResponse	<optional>	ListDeviceConfigVersionsResponse

ListDeviceRegistriesCallback(error, responseopt)

Callback as used by listDeviceRegistries.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.ListDeviceRegistriesResponse	<optional>	ListDeviceRegistriesResponse

ListDeviceStatesCallback(error, responseopt)

Callback as used by listDeviceStates.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.ListDeviceStatesResponse	<optional>	ListDeviceStatesResponse

ListDevicesCallback(error, responseopt)

Callback as used by listDevices.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.ListDevicesResponse	<optional>	ListDevicesResponse

ModifyCloudToDeviceConfigCallback(error, responseopt)

Callback as used by modifyCloudToDeviceConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.DeviceConfig	<optional>	DeviceConfig

SendCommandToDeviceCallback(error, responseopt)

Callback as used by sendCommandToDevice.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.SendCommandToDeviceResponse	<optional>	SendCommandToDeviceResponse

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.iam.v1.Policy	<optional>	Policy

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.iam.v1.TestIamPermissionsResponse	<optional>	TestIamPermissionsResponse

UnbindDeviceFromGatewayCallback(error, responseopt)

Callback as used by unbindDeviceFromGateway.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.UnbindDeviceFromGatewayResponse	<optional>	UnbindDeviceFromGatewayResponse

UpdateDeviceCallback(error, responseopt)

Callback as used by updateDevice.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.Device	<optional>	Device

UpdateDeviceRegistryCallback(error, responseopt)

Callback as used by updateDeviceRegistry.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.iot.v1.DeviceRegistry	<optional>	DeviceRegistry