Cloud IoT v1 API - Class DeviceManager.DeviceManagerClient (2.2.0)

Version latest

• 2.2.0 (latest)
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

public class DeviceManager.DeviceManagerClient : ClientBase<DeviceManager.DeviceManagerClient>

Reference documentation and code samples for the Cloud IoT v1 API class DeviceManager.DeviceManagerClient.

Client for DeviceManager

Inheritance

object > ClientBase > ClientBaseDeviceManagerDeviceManagerClient > DeviceManager.DeviceManagerClient

Inherited Members

ClientBase<DeviceManager.DeviceManagerClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Iot.V1

Assembly

Google.Cloud.Iot.V1.dll

Constructors

DeviceManagerClient()

protected DeviceManagerClient()

Protected parameterless constructor to allow creation of test doubles.

DeviceManagerClient(CallInvoker)

public DeviceManagerClient(CallInvoker callInvoker)

Creates a new client for DeviceManager that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

DeviceManagerClient(ChannelBase)

public DeviceManagerClient(ChannelBase channel)

Creates a new client for DeviceManager

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

DeviceManagerClient(ClientBaseConfiguration)

protected DeviceManagerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

BindDeviceToGateway(BindDeviceToGatewayRequest, CallOptions)

public virtual BindDeviceToGatewayResponse BindDeviceToGateway(BindDeviceToGatewayRequest request, CallOptions options)

Associates the device with the gateway.

Parameters
Name	Description
request	BindDeviceToGatewayRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
BindDeviceToGatewayResponse	The response received from the server.

BindDeviceToGateway(BindDeviceToGatewayRequest, Metadata, DateTime?, CancellationToken)

public virtual BindDeviceToGatewayResponse BindDeviceToGateway(BindDeviceToGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Associates the device with the gateway.

Parameters
Name	Description
request	BindDeviceToGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
BindDeviceToGatewayResponse	The response received from the server.

BindDeviceToGatewayAsync(BindDeviceToGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<BindDeviceToGatewayResponse> BindDeviceToGatewayAsync(BindDeviceToGatewayRequest request, CallOptions options)

Associates the device with the gateway.

Parameters
Name	Description
request	BindDeviceToGatewayRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBindDeviceToGatewayResponse	The call object.

BindDeviceToGatewayAsync(BindDeviceToGatewayRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BindDeviceToGatewayResponse> BindDeviceToGatewayAsync(BindDeviceToGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Associates the device with the gateway.

Parameters
Name	Description
request	BindDeviceToGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBindDeviceToGatewayResponse	The call object.

CreateDevice(CreateDeviceRequest, CallOptions)

public virtual Device CreateDevice(CreateDeviceRequest request, CallOptions options)

Creates a device in a device registry.

Parameters
Name	Description
request	CreateDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Device	The response received from the server.

CreateDevice(CreateDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual Device CreateDevice(CreateDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a device in a device registry.

Parameters
Name	Description
request	CreateDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Device	The response received from the server.

CreateDeviceAsync(CreateDeviceRequest, CallOptions)

public virtual AsyncUnaryCall<Device> CreateDeviceAsync(CreateDeviceRequest request, CallOptions options)

Creates a device in a device registry.

Parameters
Name	Description
request	CreateDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDevice	The call object.

CreateDeviceAsync(CreateDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Device> CreateDeviceAsync(CreateDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a device in a device registry.

Parameters
Name	Description
request	CreateDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDevice	The call object.

CreateDeviceRegistry(CreateDeviceRegistryRequest, CallOptions)

public virtual DeviceRegistry CreateDeviceRegistry(CreateDeviceRegistryRequest request, CallOptions options)

Creates a device registry that contains devices.

Parameters
Name	Description
request	CreateDeviceRegistryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
DeviceRegistry	The response received from the server.

CreateDeviceRegistry(CreateDeviceRegistryRequest, Metadata, DateTime?, CancellationToken)

public virtual DeviceRegistry CreateDeviceRegistry(CreateDeviceRegistryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a device registry that contains devices.

Parameters
Name	Description
request	CreateDeviceRegistryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
DeviceRegistry	The response received from the server.

CreateDeviceRegistryAsync(CreateDeviceRegistryRequest, CallOptions)

public virtual AsyncUnaryCall<DeviceRegistry> CreateDeviceRegistryAsync(CreateDeviceRegistryRequest request, CallOptions options)

Creates a device registry that contains devices.

Parameters
Name	Description
request	CreateDeviceRegistryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDeviceRegistry	The call object.

CreateDeviceRegistryAsync(CreateDeviceRegistryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DeviceRegistry> CreateDeviceRegistryAsync(CreateDeviceRegistryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a device registry that contains devices.

Parameters
Name	Description
request	CreateDeviceRegistryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDeviceRegistry	The call object.

DeleteDevice(DeleteDeviceRequest, CallOptions)

public virtual Empty DeleteDevice(DeleteDeviceRequest request, CallOptions options)

Deletes a device.

Parameters
Name	Description
request	DeleteDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteDevice(DeleteDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteDevice(DeleteDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a device.

Parameters
Name	Description
request	DeleteDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteDeviceAsync(DeleteDeviceRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteDeviceAsync(DeleteDeviceRequest request, CallOptions options)

Deletes a device.

Parameters
Name	Description
request	DeleteDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteDeviceAsync(DeleteDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteDeviceAsync(DeleteDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a device.

Parameters
Name	Description
request	DeleteDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteDeviceRegistry(DeleteDeviceRegistryRequest, CallOptions)

public virtual Empty DeleteDeviceRegistry(DeleteDeviceRegistryRequest request, CallOptions options)

Deletes a device registry configuration.

Parameters
Name	Description
request	DeleteDeviceRegistryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteDeviceRegistry(DeleteDeviceRegistryRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteDeviceRegistry(DeleteDeviceRegistryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a device registry configuration.

Parameters
Name	Description
request	DeleteDeviceRegistryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteDeviceRegistryAsync(DeleteDeviceRegistryRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteDeviceRegistryAsync(DeleteDeviceRegistryRequest request, CallOptions options)

Deletes a device registry configuration.

Parameters
Name	Description
request	DeleteDeviceRegistryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteDeviceRegistryAsync(DeleteDeviceRegistryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteDeviceRegistryAsync(DeleteDeviceRegistryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a device registry configuration.

Parameters
Name	Description
request	DeleteDeviceRegistryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetDevice(GetDeviceRequest, CallOptions)

public virtual Device GetDevice(GetDeviceRequest request, CallOptions options)

Gets details about a device.

Parameters
Name	Description
request	GetDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Device	The response received from the server.

GetDevice(GetDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual Device GetDevice(GetDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details about a device.

Parameters
Name	Description
request	GetDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Device	The response received from the server.

GetDeviceAsync(GetDeviceRequest, CallOptions)

public virtual AsyncUnaryCall<Device> GetDeviceAsync(GetDeviceRequest request, CallOptions options)

Gets details about a device.

Parameters
Name	Description
request	GetDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDevice	The call object.

GetDeviceAsync(GetDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Device> GetDeviceAsync(GetDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details about a device.

Parameters
Name	Description
request	GetDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDevice	The call object.

GetDeviceRegistry(GetDeviceRegistryRequest, CallOptions)

public virtual DeviceRegistry GetDeviceRegistry(GetDeviceRegistryRequest request, CallOptions options)

Gets a device registry configuration.

Parameters
Name	Description
request	GetDeviceRegistryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
DeviceRegistry	The response received from the server.

GetDeviceRegistry(GetDeviceRegistryRequest, Metadata, DateTime?, CancellationToken)

public virtual DeviceRegistry GetDeviceRegistry(GetDeviceRegistryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a device registry configuration.

Parameters
Name	Description
request	GetDeviceRegistryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
DeviceRegistry	The response received from the server.

GetDeviceRegistryAsync(GetDeviceRegistryRequest, CallOptions)

public virtual AsyncUnaryCall<DeviceRegistry> GetDeviceRegistryAsync(GetDeviceRegistryRequest request, CallOptions options)

Gets a device registry configuration.

Parameters
Name	Description
request	GetDeviceRegistryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDeviceRegistry	The call object.

GetDeviceRegistryAsync(GetDeviceRegistryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DeviceRegistry> GetDeviceRegistryAsync(GetDeviceRegistryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a device registry configuration.

Parameters
Name	Description
request	GetDeviceRegistryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDeviceRegistry	The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

ListDeviceConfigVersions(ListDeviceConfigVersionsRequest, CallOptions)

public virtual ListDeviceConfigVersionsResponse ListDeviceConfigVersions(ListDeviceConfigVersionsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListDeviceConfigVersionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListDeviceConfigVersionsResponse	The response received from the server.

ListDeviceConfigVersions(ListDeviceConfigVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDeviceConfigVersionsResponse ListDeviceConfigVersions(ListDeviceConfigVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListDeviceConfigVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListDeviceConfigVersionsResponse	The response received from the server.

ListDeviceConfigVersionsAsync(ListDeviceConfigVersionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDeviceConfigVersionsResponse> ListDeviceConfigVersionsAsync(ListDeviceConfigVersionsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListDeviceConfigVersionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListDeviceConfigVersionsResponse	The call object.

ListDeviceConfigVersionsAsync(ListDeviceConfigVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDeviceConfigVersionsResponse> ListDeviceConfigVersionsAsync(ListDeviceConfigVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListDeviceConfigVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListDeviceConfigVersionsResponse	The call object.

ListDeviceRegistries(ListDeviceRegistriesRequest, CallOptions)

public virtual ListDeviceRegistriesResponse ListDeviceRegistries(ListDeviceRegistriesRequest request, CallOptions options)

Lists device registries.

Parameters
Name	Description
request	ListDeviceRegistriesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListDeviceRegistriesResponse	The response received from the server.

ListDeviceRegistries(ListDeviceRegistriesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDeviceRegistriesResponse ListDeviceRegistries(ListDeviceRegistriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists device registries.

Parameters
Name	Description
request	ListDeviceRegistriesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListDeviceRegistriesResponse	The response received from the server.

ListDeviceRegistriesAsync(ListDeviceRegistriesRequest, CallOptions)

public virtual AsyncUnaryCall<ListDeviceRegistriesResponse> ListDeviceRegistriesAsync(ListDeviceRegistriesRequest request, CallOptions options)

Lists device registries.

Parameters
Name	Description
request	ListDeviceRegistriesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListDeviceRegistriesResponse	The call object.

ListDeviceRegistriesAsync(ListDeviceRegistriesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDeviceRegistriesResponse> ListDeviceRegistriesAsync(ListDeviceRegistriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists device registries.

Parameters
Name	Description
request	ListDeviceRegistriesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListDeviceRegistriesResponse	The call object.

ListDevices(ListDevicesRequest, CallOptions)

public virtual ListDevicesResponse ListDevices(ListDevicesRequest request, CallOptions options)

List devices in a device registry.

Parameters
Name	Description
request	ListDevicesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListDevicesResponse	The response received from the server.

ListDevices(ListDevicesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDevicesResponse ListDevices(ListDevicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List devices in a device registry.

Parameters
Name	Description
request	ListDevicesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListDevicesResponse	The response received from the server.

ListDevicesAsync(ListDevicesRequest, CallOptions)

public virtual AsyncUnaryCall<ListDevicesResponse> ListDevicesAsync(ListDevicesRequest request, CallOptions options)

List devices in a device registry.

Parameters
Name	Description
request	ListDevicesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListDevicesResponse	The call object.

ListDevicesAsync(ListDevicesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDevicesResponse> ListDevicesAsync(ListDevicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List devices in a device registry.

Parameters
Name	Description
request	ListDevicesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListDevicesResponse	The call object.

ListDeviceStates(ListDeviceStatesRequest, CallOptions)

public virtual ListDeviceStatesResponse ListDeviceStates(ListDeviceStatesRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListDeviceStatesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListDeviceStatesResponse	The response received from the server.

ListDeviceStates(ListDeviceStatesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDeviceStatesResponse ListDeviceStates(ListDeviceStatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListDeviceStatesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListDeviceStatesResponse	The response received from the server.

ListDeviceStatesAsync(ListDeviceStatesRequest, CallOptions)

public virtual AsyncUnaryCall<ListDeviceStatesResponse> ListDeviceStatesAsync(ListDeviceStatesRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListDeviceStatesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListDeviceStatesResponse	The call object.

ListDeviceStatesAsync(ListDeviceStatesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDeviceStatesResponse> ListDeviceStatesAsync(ListDeviceStatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListDeviceStatesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListDeviceStatesResponse	The call object.

ModifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest, CallOptions)

public virtual DeviceConfig ModifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	ModifyCloudToDeviceConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
DeviceConfig	The response received from the server.

ModifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual DeviceConfig ModifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ModifyCloudToDeviceConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
DeviceConfig	The response received from the server.

ModifyCloudToDeviceConfigAsync(ModifyCloudToDeviceConfigRequest, CallOptions)

public virtual AsyncUnaryCall<DeviceConfig> ModifyCloudToDeviceConfigAsync(ModifyCloudToDeviceConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	ModifyCloudToDeviceConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDeviceConfig	The call object.

ModifyCloudToDeviceConfigAsync(ModifyCloudToDeviceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DeviceConfig> ModifyCloudToDeviceConfigAsync(ModifyCloudToDeviceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ModifyCloudToDeviceConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDeviceConfig	The call object.

NewInstance(ClientBaseConfiguration)

protected override DeviceManager.DeviceManagerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DeviceManagerDeviceManagerClient

Overrides

ClientBase<DeviceManager.DeviceManagerClient>.NewInstance(ClientBase.ClientBaseConfiguration)

SendCommandToDevice(SendCommandToDeviceRequest, CallOptions)

public virtual SendCommandToDeviceResponse SendCommandToDevice(SendCommandToDeviceRequest request, CallOptions options)

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.

Parameters
Name	Description
request	SendCommandToDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
SendCommandToDeviceResponse	The response received from the server.

SendCommandToDevice(SendCommandToDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual SendCommandToDeviceResponse SendCommandToDevice(SendCommandToDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	SendCommandToDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
SendCommandToDeviceResponse	The response received from the server.

SendCommandToDeviceAsync(SendCommandToDeviceRequest, CallOptions)

public virtual AsyncUnaryCall<SendCommandToDeviceResponse> SendCommandToDeviceAsync(SendCommandToDeviceRequest request, CallOptions options)

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.

Parameters
Name	Description
request	SendCommandToDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSendCommandToDeviceResponse	The call object.

SendCommandToDeviceAsync(SendCommandToDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SendCommandToDeviceResponse> SendCommandToDeviceAsync(SendCommandToDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	SendCommandToDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSendCommandToDeviceResponse	The call object.

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

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.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)

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.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

UnbindDeviceFromGateway(UnbindDeviceFromGatewayRequest, CallOptions)

public virtual UnbindDeviceFromGatewayResponse UnbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request, CallOptions options)

Deletes the association between the device and the gateway.

Parameters
Name	Description
request	UnbindDeviceFromGatewayRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
UnbindDeviceFromGatewayResponse	The response received from the server.

UnbindDeviceFromGateway(UnbindDeviceFromGatewayRequest, Metadata, DateTime?, CancellationToken)

public virtual UnbindDeviceFromGatewayResponse UnbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the association between the device and the gateway.

Parameters
Name	Description
request	UnbindDeviceFromGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
UnbindDeviceFromGatewayResponse	The response received from the server.

UnbindDeviceFromGatewayAsync(UnbindDeviceFromGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<UnbindDeviceFromGatewayResponse> UnbindDeviceFromGatewayAsync(UnbindDeviceFromGatewayRequest request, CallOptions options)

Deletes the association between the device and the gateway.

Parameters
Name	Description
request	UnbindDeviceFromGatewayRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallUnbindDeviceFromGatewayResponse	The call object.

UnbindDeviceFromGatewayAsync(UnbindDeviceFromGatewayRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UnbindDeviceFromGatewayResponse> UnbindDeviceFromGatewayAsync(UnbindDeviceFromGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the association between the device and the gateway.

Parameters
Name	Description
request	UnbindDeviceFromGatewayRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallUnbindDeviceFromGatewayResponse	The call object.

UpdateDevice(UpdateDeviceRequest, CallOptions)

public virtual Device UpdateDevice(UpdateDeviceRequest request, CallOptions options)

Updates a device.

Parameters
Name	Description
request	UpdateDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Device	The response received from the server.

UpdateDevice(UpdateDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual Device UpdateDevice(UpdateDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a device.

Parameters
Name	Description
request	UpdateDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Device	The response received from the server.

UpdateDeviceAsync(UpdateDeviceRequest, CallOptions)

public virtual AsyncUnaryCall<Device> UpdateDeviceAsync(UpdateDeviceRequest request, CallOptions options)

Updates a device.

Parameters
Name	Description
request	UpdateDeviceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDevice	The call object.

UpdateDeviceAsync(UpdateDeviceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Device> UpdateDeviceAsync(UpdateDeviceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a device.

Parameters
Name	Description
request	UpdateDeviceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDevice	The call object.

UpdateDeviceRegistry(UpdateDeviceRegistryRequest, CallOptions)

public virtual DeviceRegistry UpdateDeviceRegistry(UpdateDeviceRegistryRequest request, CallOptions options)

Updates a device registry configuration.

Parameters
Name	Description
request	UpdateDeviceRegistryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
DeviceRegistry	The response received from the server.

UpdateDeviceRegistry(UpdateDeviceRegistryRequest, Metadata, DateTime?, CancellationToken)

public virtual DeviceRegistry UpdateDeviceRegistry(UpdateDeviceRegistryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a device registry configuration.

Parameters
Name	Description
request	UpdateDeviceRegistryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
DeviceRegistry	The response received from the server.

UpdateDeviceRegistryAsync(UpdateDeviceRegistryRequest, CallOptions)

public virtual AsyncUnaryCall<DeviceRegistry> UpdateDeviceRegistryAsync(UpdateDeviceRegistryRequest request, CallOptions options)

Updates a device registry configuration.

Parameters
Name	Description
request	UpdateDeviceRegistryRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDeviceRegistry	The call object.

UpdateDeviceRegistryAsync(UpdateDeviceRegistryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DeviceRegistry> UpdateDeviceRegistryAsync(UpdateDeviceRegistryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a device registry configuration.

Parameters
Name	Description
request	UpdateDeviceRegistryRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDeviceRegistry	The call object.