Class protos.google.cloud.iot.v1.DeviceManager (2.2.0)

Represents a DeviceManager

Inheritance

$protobuf.rpc.Service > protos.google.cloud.iot.v1.DeviceManager

Package

@google-cloud/iot!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new DeviceManager service.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Methods

bindDeviceToGateway(request, callback)

public bindDeviceToGateway(request: google.cloud.iot.v1.IBindDeviceToGatewayRequest, callback: google.cloud.iot.v1.DeviceManager.BindDeviceToGatewayCallback): void;

Calls BindDeviceToGateway.

Parameters

Name	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
void

bindDeviceToGateway(request)

public bindDeviceToGateway(request: google.cloud.iot.v1.IBindDeviceToGatewayRequest): Promise<google.cloud.iot.v1.BindDeviceToGatewayResponse>;

Calls BindDeviceToGateway.

Parameter

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

Returns

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

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DeviceManager;

Creates new DeviceManager service using the specified rpc implementation.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Returns

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

createDevice(request, callback)

public createDevice(request: google.cloud.iot.v1.ICreateDeviceRequest, callback: google.cloud.iot.v1.DeviceManager.CreateDeviceCallback): void;

Calls CreateDevice.

Parameters

Name	Description
request	`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
void

createDevice(request)

public createDevice(request: google.cloud.iot.v1.ICreateDeviceRequest): Promise<google.cloud.iot.v1.Device>;

Calls CreateDevice.

Parameter

Name	Description
request	`ICreateDeviceRequest` CreateDeviceRequest message or plain object

Returns

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

createDeviceRegistry(request, callback)

public createDeviceRegistry(request: google.cloud.iot.v1.ICreateDeviceRegistryRequest, callback: google.cloud.iot.v1.DeviceManager.CreateDeviceRegistryCallback): void;

Calls CreateDeviceRegistry.

Parameters

Name	Description
request	`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
void

createDeviceRegistry(request)

public createDeviceRegistry(request: google.cloud.iot.v1.ICreateDeviceRegistryRequest): Promise<google.cloud.iot.v1.DeviceRegistry>;

Calls CreateDeviceRegistry.

Parameter

Name	Description
request	`ICreateDeviceRegistryRequest` CreateDeviceRegistryRequest message or plain object

Returns

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

deleteDevice(request, callback)

public deleteDevice(request: google.cloud.iot.v1.IDeleteDeviceRequest, callback: google.cloud.iot.v1.DeviceManager.DeleteDeviceCallback): void;

Calls DeleteDevice.

Parameters

Name	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
void

deleteDevice(request)

public deleteDevice(request: google.cloud.iot.v1.IDeleteDeviceRequest): Promise<google.protobuf.Empty>;

Calls DeleteDevice.

Parameter

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

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

deleteDeviceRegistry(request, callback)

public deleteDeviceRegistry(request: google.cloud.iot.v1.IDeleteDeviceRegistryRequest, callback: google.cloud.iot.v1.DeviceManager.DeleteDeviceRegistryCallback): void;

Calls DeleteDeviceRegistry.

Parameters

Name	Description
request	`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
void

deleteDeviceRegistry(request)

public deleteDeviceRegistry(request: google.cloud.iot.v1.IDeleteDeviceRegistryRequest): Promise<google.protobuf.Empty>;

Calls DeleteDeviceRegistry.

Parameter

Name	Description
request	`IDeleteDeviceRegistryRequest` DeleteDeviceRegistryRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

getDevice(request, callback)

public getDevice(request: google.cloud.iot.v1.IGetDeviceRequest, callback: google.cloud.iot.v1.DeviceManager.GetDeviceCallback): void;

Calls GetDevice.

Parameters

Name	Description
request	`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
void

getDevice(request)

public getDevice(request: google.cloud.iot.v1.IGetDeviceRequest): Promise<google.cloud.iot.v1.Device>;

Calls GetDevice.

Parameter

Name	Description
request	`IGetDeviceRequest` GetDeviceRequest message or plain object

Returns

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

getDeviceRegistry(request, callback)

public getDeviceRegistry(request: google.cloud.iot.v1.IGetDeviceRegistryRequest, callback: google.cloud.iot.v1.DeviceManager.GetDeviceRegistryCallback): void;

Calls GetDeviceRegistry.

Parameters

Name	Description
request	`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
void

getDeviceRegistry(request)

public getDeviceRegistry(request: google.cloud.iot.v1.IGetDeviceRegistryRequest): Promise<google.cloud.iot.v1.DeviceRegistry>;

Calls GetDeviceRegistry.

Parameter

Name	Description
request	`IGetDeviceRegistryRequest` GetDeviceRegistryRequest message or plain object

Returns

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

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.cloud.iot.v1.DeviceManager.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters

Name	Description
request	`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
void

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter

Name	Description
request	`IGetIamPolicyRequest` GetIamPolicyRequest message or plain object

Returns

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

listDeviceConfigVersions(request, callback)

public listDeviceConfigVersions(request: google.cloud.iot.v1.IListDeviceConfigVersionsRequest, callback: google.cloud.iot.v1.DeviceManager.ListDeviceConfigVersionsCallback): void;

Calls ListDeviceConfigVersions.

Parameters

Name	Description
request	`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
void

listDeviceConfigVersions(request)

public listDeviceConfigVersions(request: google.cloud.iot.v1.IListDeviceConfigVersionsRequest): Promise<google.cloud.iot.v1.ListDeviceConfigVersionsResponse>;

Calls ListDeviceConfigVersions.

Parameter

Name	Description
request	`IListDeviceConfigVersionsRequest` ListDeviceConfigVersionsRequest message or plain object

Returns

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

listDeviceRegistries(request, callback)

public listDeviceRegistries(request: google.cloud.iot.v1.IListDeviceRegistriesRequest, callback: google.cloud.iot.v1.DeviceManager.ListDeviceRegistriesCallback): void;

Calls ListDeviceRegistries.

Parameters

Name	Description
request	`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
void

listDeviceRegistries(request)

public listDeviceRegistries(request: google.cloud.iot.v1.IListDeviceRegistriesRequest): Promise<google.cloud.iot.v1.ListDeviceRegistriesResponse>;

Calls ListDeviceRegistries.

Parameter

Name	Description
request	`IListDeviceRegistriesRequest` ListDeviceRegistriesRequest message or plain object

Returns

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

listDevices(request, callback)

public listDevices(request: google.cloud.iot.v1.IListDevicesRequest, callback: google.cloud.iot.v1.DeviceManager.ListDevicesCallback): void;

Calls ListDevices.

Parameters

Name	Description
request	`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
void

listDevices(request)

public listDevices(request: google.cloud.iot.v1.IListDevicesRequest): Promise<google.cloud.iot.v1.ListDevicesResponse>;

Calls ListDevices.

Parameter

Name	Description
request	`IListDevicesRequest` ListDevicesRequest message or plain object

Returns

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

listDeviceStates(request, callback)

public listDeviceStates(request: google.cloud.iot.v1.IListDeviceStatesRequest, callback: google.cloud.iot.v1.DeviceManager.ListDeviceStatesCallback): void;

Calls ListDeviceStates.

Parameters

Name	Description
request	`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
void

listDeviceStates(request)

public listDeviceStates(request: google.cloud.iot.v1.IListDeviceStatesRequest): Promise<google.cloud.iot.v1.ListDeviceStatesResponse>;

Calls ListDeviceStates.

Parameter

Name	Description
request	`IListDeviceStatesRequest` ListDeviceStatesRequest message or plain object

Returns

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

modifyCloudToDeviceConfig(request, callback)

public modifyCloudToDeviceConfig(request: google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest, callback: google.cloud.iot.v1.DeviceManager.ModifyCloudToDeviceConfigCallback): void;

Calls ModifyCloudToDeviceConfig.

Parameters

Name	Description
request	`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
void

modifyCloudToDeviceConfig(request)

public modifyCloudToDeviceConfig(request: google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest): Promise<google.cloud.iot.v1.DeviceConfig>;

Calls ModifyCloudToDeviceConfig.

Parameter

Name	Description
request	`IModifyCloudToDeviceConfigRequest` ModifyCloudToDeviceConfigRequest message or plain object

Returns

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

sendCommandToDevice(request, callback)

public sendCommandToDevice(request: google.cloud.iot.v1.ISendCommandToDeviceRequest, callback: google.cloud.iot.v1.DeviceManager.SendCommandToDeviceCallback): void;

Calls SendCommandToDevice.

Parameters

Name	Description
request	`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
void

sendCommandToDevice(request)

public sendCommandToDevice(request: google.cloud.iot.v1.ISendCommandToDeviceRequest): Promise<google.cloud.iot.v1.SendCommandToDeviceResponse>;

Calls SendCommandToDevice.

Parameter

Name	Description
request	`ISendCommandToDeviceRequest` SendCommandToDeviceRequest message or plain object

Returns

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

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.cloud.iot.v1.DeviceManager.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters

Name	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
void

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter

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

Returns

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

testIamPermissions(request, callback)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.cloud.iot.v1.DeviceManager.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters

Name	Description
request	`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
void

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter

Name	Description
request	`ITestIamPermissionsRequest` TestIamPermissionsRequest message or plain object

Returns

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

unbindDeviceFromGateway(request, callback)

public unbindDeviceFromGateway(request: google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest, callback: google.cloud.iot.v1.DeviceManager.UnbindDeviceFromGatewayCallback): void;

Calls UnbindDeviceFromGateway.

Parameters

Name	Description
request	`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
void

unbindDeviceFromGateway(request)

public unbindDeviceFromGateway(request: google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest): Promise<google.cloud.iot.v1.UnbindDeviceFromGatewayResponse>;

Calls UnbindDeviceFromGateway.

Parameter

Name	Description
request	`IUnbindDeviceFromGatewayRequest` UnbindDeviceFromGatewayRequest message or plain object

Returns

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

updateDevice(request, callback)

public updateDevice(request: google.cloud.iot.v1.IUpdateDeviceRequest, callback: google.cloud.iot.v1.DeviceManager.UpdateDeviceCallback): void;

Calls UpdateDevice.

Parameters

Name	Description
request	`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
void

updateDevice(request)

public updateDevice(request: google.cloud.iot.v1.IUpdateDeviceRequest): Promise<google.cloud.iot.v1.Device>;

Calls UpdateDevice.

Parameter

Name	Description
request	`IUpdateDeviceRequest` UpdateDeviceRequest message or plain object

Returns

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

updateDeviceRegistry(request, callback)

public updateDeviceRegistry(request: google.cloud.iot.v1.IUpdateDeviceRegistryRequest, callback: google.cloud.iot.v1.DeviceManager.UpdateDeviceRegistryCallback): void;

Calls UpdateDeviceRegistry.

Parameters

Name	Description
request	`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
void

updateDeviceRegistry(request)

public updateDeviceRegistry(request: google.cloud.iot.v1.IUpdateDeviceRegistryRequest): Promise<google.cloud.iot.v1.DeviceRegistry>;

Calls UpdateDeviceRegistry.

Parameter

Name	Description
request	`IUpdateDeviceRegistryRequest` UpdateDeviceRegistryRequest message or plain object

Returns

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