public abstract class DeviceManagerClient
DeviceManager client wrapper, for convenient use.
Inheritance
System.Object > DeviceManagerClientNamespace
Google.Cloud.Iot.V1Assembly
Google.Cloud.Iot.V1.dll
Remarks
Internet of Things (IoT) service. Securely connect and manage IoT devices.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the DeviceManager service, which is a host of "cloudiot.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
System.String |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default DeviceManager scopes.
Property Value | |
---|---|
Type | Description |
System.Collections.Generic.IReadOnlyList<System.String> |
The default DeviceManager scopes are:
GrpcClient
public virtual DeviceManager.DeviceManagerClient GrpcClient { get; }
The underlying gRPC DeviceManager client
Property Value | |
---|---|
Type | Description |
DeviceManager.DeviceManagerClient |
Methods
BindDeviceToGateway(BindDeviceToGatewayRequest, CallSettings)
public virtual BindDeviceToGatewayResponse BindDeviceToGateway(BindDeviceToGatewayRequest request, CallSettings callSettings = null)
Associates the device with the gateway.
Parameters | |
---|---|
Name | Description |
request | BindDeviceToGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
BindDeviceToGatewayResponse | The RPC response. |
BindDeviceToGateway(RegistryName, String, String, CallSettings)
public virtual BindDeviceToGatewayResponse BindDeviceToGateway(RegistryName parent, string gatewayId, string deviceId, CallSettings callSettings = null)
Associates the device with the gateway.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to associate with the specified gateway. The value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
BindDeviceToGatewayResponse | The RPC response. |
BindDeviceToGateway(String, String, String, CallSettings)
public virtual BindDeviceToGatewayResponse BindDeviceToGateway(string parent, string gatewayId, string deviceId, CallSettings callSettings = null)
Associates the device with the gateway.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to associate with the specified gateway. The value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
BindDeviceToGatewayResponse | The RPC response. |
BindDeviceToGatewayAsync(BindDeviceToGatewayRequest, CallSettings)
public virtual Task<BindDeviceToGatewayResponse> BindDeviceToGatewayAsync(BindDeviceToGatewayRequest request, CallSettings callSettings = null)
Associates the device with the gateway.
Parameters | |
---|---|
Name | Description |
request | BindDeviceToGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<BindDeviceToGatewayResponse> | A Task containing the RPC response. |
BindDeviceToGatewayAsync(BindDeviceToGatewayRequest, CancellationToken)
public virtual Task<BindDeviceToGatewayResponse> BindDeviceToGatewayAsync(BindDeviceToGatewayRequest request, CancellationToken cancellationToken)
Associates the device with the gateway.
Parameters | |
---|---|
Name | Description |
request | BindDeviceToGatewayRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<BindDeviceToGatewayResponse> | A Task containing the RPC response. |
BindDeviceToGatewayAsync(RegistryName, String, String, CallSettings)
public virtual Task<BindDeviceToGatewayResponse> BindDeviceToGatewayAsync(RegistryName parent, string gatewayId, string deviceId, CallSettings callSettings = null)
Associates the device with the gateway.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to associate with the specified gateway. The value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<BindDeviceToGatewayResponse> | A Task containing the RPC response. |
BindDeviceToGatewayAsync(RegistryName, String, String, CancellationToken)
public virtual Task<BindDeviceToGatewayResponse> BindDeviceToGatewayAsync(RegistryName parent, string gatewayId, string deviceId, CancellationToken cancellationToken)
Associates the device with the gateway.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to associate with the specified gateway. The value of
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<BindDeviceToGatewayResponse> | A Task containing the RPC response. |
BindDeviceToGatewayAsync(String, String, String, CallSettings)
public virtual Task<BindDeviceToGatewayResponse> BindDeviceToGatewayAsync(string parent, string gatewayId, string deviceId, CallSettings callSettings = null)
Associates the device with the gateway.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to associate with the specified gateway. The value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<BindDeviceToGatewayResponse> | A Task containing the RPC response. |
BindDeviceToGatewayAsync(String, String, String, CancellationToken)
public virtual Task<BindDeviceToGatewayResponse> BindDeviceToGatewayAsync(string parent, string gatewayId, string deviceId, CancellationToken cancellationToken)
Associates the device with the gateway.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to associate with the specified gateway. The value of
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<BindDeviceToGatewayResponse> | A Task containing the RPC response. |
Create()
public static DeviceManagerClient Create()
Synchronously creates a DeviceManagerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DeviceManagerClientBuilder.
Returns | |
---|---|
Type | Description |
DeviceManagerClient | The created DeviceManagerClient. |
CreateAsync(CancellationToken)
public static Task<DeviceManagerClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a DeviceManagerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DeviceManagerClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | System.Threading.CancellationToken The System.Threading.CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceManagerClient> | The task representing the created DeviceManagerClient. |
CreateDevice(CreateDeviceRequest, CallSettings)
public virtual Device CreateDevice(CreateDeviceRequest request, CallSettings callSettings = null)
Creates a device in a device registry.
Parameters | |
---|---|
Name | Description |
request | CreateDeviceRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Device | The RPC response. |
CreateDevice(RegistryName, Device, CallSettings)
public virtual Device CreateDevice(RegistryName parent, Device device, CallSettings callSettings = null)
Creates a device in a device registry.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The name of the device registry where this device should be created.
For example,
|
device | Device Required. The device registration details. The field |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Device | The RPC response. |
CreateDevice(String, Device, CallSettings)
public virtual Device CreateDevice(string parent, Device device, CallSettings callSettings = null)
Creates a device in a device registry.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The name of the device registry where this device should be created.
For example,
|
device | Device Required. The device registration details. The field |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Device | The RPC response. |
CreateDeviceAsync(CreateDeviceRequest, CallSettings)
public virtual Task<Device> CreateDeviceAsync(CreateDeviceRequest request, CallSettings callSettings = null)
Creates a device in a device registry.
Parameters | |
---|---|
Name | Description |
request | CreateDeviceRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
CreateDeviceAsync(CreateDeviceRequest, CancellationToken)
public virtual Task<Device> CreateDeviceAsync(CreateDeviceRequest request, CancellationToken cancellationToken)
Creates a device in a device registry.
Parameters | |
---|---|
Name | Description |
request | CreateDeviceRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
CreateDeviceAsync(RegistryName, Device, CallSettings)
public virtual Task<Device> CreateDeviceAsync(RegistryName parent, Device device, CallSettings callSettings = null)
Creates a device in a device registry.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The name of the device registry where this device should be created.
For example,
|
device | Device Required. The device registration details. The field |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
CreateDeviceAsync(RegistryName, Device, CancellationToken)
public virtual Task<Device> CreateDeviceAsync(RegistryName parent, Device device, CancellationToken cancellationToken)
Creates a device in a device registry.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The name of the device registry where this device should be created.
For example,
|
device | Device Required. The device registration details. The field |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
CreateDeviceAsync(String, Device, CallSettings)
public virtual Task<Device> CreateDeviceAsync(string parent, Device device, CallSettings callSettings = null)
Creates a device in a device registry.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The name of the device registry where this device should be created.
For example,
|
device | Device Required. The device registration details. The field |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
CreateDeviceAsync(String, Device, CancellationToken)
public virtual Task<Device> CreateDeviceAsync(string parent, Device device, CancellationToken cancellationToken)
Creates a device in a device registry.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The name of the device registry where this device should be created.
For example,
|
device | Device Required. The device registration details. The field |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
CreateDeviceRegistry(LocationName, DeviceRegistry, CallSettings)
public virtual DeviceRegistry CreateDeviceRegistry(LocationName parent, DeviceRegistry deviceRegistry, CallSettings callSettings = null)
Creates a device registry that contains devices.
Parameters | |
---|---|
Name | Description |
parent | Google.Api.Gax.ResourceNames.LocationName Required. The project and cloud region where this device registry must be created.
For example, |
deviceRegistry | DeviceRegistry Required. The device registry. The field |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceRegistry | The RPC response. |
CreateDeviceRegistry(CreateDeviceRegistryRequest, CallSettings)
public virtual DeviceRegistry CreateDeviceRegistry(CreateDeviceRegistryRequest request, CallSettings callSettings = null)
Creates a device registry that contains devices.
Parameters | |
---|---|
Name | Description |
request | CreateDeviceRegistryRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceRegistry | The RPC response. |
CreateDeviceRegistry(String, DeviceRegistry, CallSettings)
public virtual DeviceRegistry CreateDeviceRegistry(string parent, DeviceRegistry deviceRegistry, CallSettings callSettings = null)
Creates a device registry that contains devices.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The project and cloud region where this device registry must be created.
For example, |
deviceRegistry | DeviceRegistry Required. The device registry. The field |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceRegistry | The RPC response. |
CreateDeviceRegistryAsync(LocationName, DeviceRegistry, CallSettings)
public virtual Task<DeviceRegistry> CreateDeviceRegistryAsync(LocationName parent, DeviceRegistry deviceRegistry, CallSettings callSettings = null)
Creates a device registry that contains devices.
Parameters | |
---|---|
Name | Description |
parent | Google.Api.Gax.ResourceNames.LocationName Required. The project and cloud region where this device registry must be created.
For example, |
deviceRegistry | DeviceRegistry Required. The device registry. The field |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
CreateDeviceRegistryAsync(LocationName, DeviceRegistry, CancellationToken)
public virtual Task<DeviceRegistry> CreateDeviceRegistryAsync(LocationName parent, DeviceRegistry deviceRegistry, CancellationToken cancellationToken)
Creates a device registry that contains devices.
Parameters | |
---|---|
Name | Description |
parent | Google.Api.Gax.ResourceNames.LocationName Required. The project and cloud region where this device registry must be created.
For example, |
deviceRegistry | DeviceRegistry Required. The device registry. The field |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
CreateDeviceRegistryAsync(CreateDeviceRegistryRequest, CallSettings)
public virtual Task<DeviceRegistry> CreateDeviceRegistryAsync(CreateDeviceRegistryRequest request, CallSettings callSettings = null)
Creates a device registry that contains devices.
Parameters | |
---|---|
Name | Description |
request | CreateDeviceRegistryRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
CreateDeviceRegistryAsync(CreateDeviceRegistryRequest, CancellationToken)
public virtual Task<DeviceRegistry> CreateDeviceRegistryAsync(CreateDeviceRegistryRequest request, CancellationToken cancellationToken)
Creates a device registry that contains devices.
Parameters | |
---|---|
Name | Description |
request | CreateDeviceRegistryRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
CreateDeviceRegistryAsync(String, DeviceRegistry, CallSettings)
public virtual Task<DeviceRegistry> CreateDeviceRegistryAsync(string parent, DeviceRegistry deviceRegistry, CallSettings callSettings = null)
Creates a device registry that contains devices.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The project and cloud region where this device registry must be created.
For example, |
deviceRegistry | DeviceRegistry Required. The device registry. The field |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
CreateDeviceRegistryAsync(String, DeviceRegistry, CancellationToken)
public virtual Task<DeviceRegistry> CreateDeviceRegistryAsync(string parent, DeviceRegistry deviceRegistry, CancellationToken cancellationToken)
Creates a device registry that contains devices.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The project and cloud region where this device registry must be created.
For example, |
deviceRegistry | DeviceRegistry Required. The device registry. The field |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
DeleteDevice(DeleteDeviceRequest, CallSettings)
public virtual void DeleteDevice(DeleteDeviceRequest request, CallSettings callSettings = null)
Deletes a device.
Parameters | |
---|---|
Name | Description |
request | DeleteDeviceRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteDevice(DeviceName, CallSettings)
public virtual void DeleteDevice(DeviceName name, CallSettings callSettings = null)
Deletes a device.
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteDevice(String, CallSettings)
public virtual void DeleteDevice(string name, CallSettings callSettings = null)
Deletes a device.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteDeviceAsync(DeleteDeviceRequest, CallSettings)
public virtual Task DeleteDeviceAsync(DeleteDeviceRequest request, CallSettings callSettings = null)
Deletes a device.
Parameters | |
---|---|
Name | Description |
request | DeleteDeviceRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceAsync(DeleteDeviceRequest, CancellationToken)
public virtual Task DeleteDeviceAsync(DeleteDeviceRequest request, CancellationToken cancellationToken)
Deletes a device.
Parameters | |
---|---|
Name | Description |
request | DeleteDeviceRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceAsync(DeviceName, CallSettings)
public virtual Task DeleteDeviceAsync(DeviceName name, CallSettings callSettings = null)
Deletes a device.
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceAsync(DeviceName, CancellationToken)
public virtual Task DeleteDeviceAsync(DeviceName name, CancellationToken cancellationToken)
Deletes a device.
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceAsync(String, CallSettings)
public virtual Task DeleteDeviceAsync(string name, CallSettings callSettings = null)
Deletes a device.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceAsync(String, CancellationToken)
public virtual Task DeleteDeviceAsync(string name, CancellationToken cancellationToken)
Deletes a device.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceRegistry(DeleteDeviceRegistryRequest, CallSettings)
public virtual void DeleteDeviceRegistry(DeleteDeviceRegistryRequest request, CallSettings callSettings = null)
Deletes a device registry configuration.
Parameters | |
---|---|
Name | Description |
request | DeleteDeviceRegistryRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteDeviceRegistry(RegistryName, CallSettings)
public virtual void DeleteDeviceRegistry(RegistryName name, CallSettings callSettings = null)
Deletes a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | RegistryName Required. The name of the device registry. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteDeviceRegistry(String, CallSettings)
public virtual void DeleteDeviceRegistry(string name, CallSettings callSettings = null)
Deletes a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device registry. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteDeviceRegistryAsync(DeleteDeviceRegistryRequest, CallSettings)
public virtual Task DeleteDeviceRegistryAsync(DeleteDeviceRegistryRequest request, CallSettings callSettings = null)
Deletes a device registry configuration.
Parameters | |
---|---|
Name | Description |
request | DeleteDeviceRegistryRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceRegistryAsync(DeleteDeviceRegistryRequest, CancellationToken)
public virtual Task DeleteDeviceRegistryAsync(DeleteDeviceRegistryRequest request, CancellationToken cancellationToken)
Deletes a device registry configuration.
Parameters | |
---|---|
Name | Description |
request | DeleteDeviceRegistryRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceRegistryAsync(RegistryName, CallSettings)
public virtual Task DeleteDeviceRegistryAsync(RegistryName name, CallSettings callSettings = null)
Deletes a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | RegistryName Required. The name of the device registry. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceRegistryAsync(RegistryName, CancellationToken)
public virtual Task DeleteDeviceRegistryAsync(RegistryName name, CancellationToken cancellationToken)
Deletes a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | RegistryName Required. The name of the device registry. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceRegistryAsync(String, CallSettings)
public virtual Task DeleteDeviceRegistryAsync(string name, CallSettings callSettings = null)
Deletes a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device registry. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
DeleteDeviceRegistryAsync(String, CancellationToken)
public virtual Task DeleteDeviceRegistryAsync(string name, CancellationToken cancellationToken)
Deletes a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device registry. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A Task containing the RPC response. |
GetDevice(DeviceName, CallSettings)
public virtual Device GetDevice(DeviceName name, CallSettings callSettings = null)
Gets details about a device.
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Device | The RPC response. |
GetDevice(GetDeviceRequest, CallSettings)
public virtual Device GetDevice(GetDeviceRequest request, CallSettings callSettings = null)
Gets details about a device.
Parameters | |
---|---|
Name | Description |
request | GetDeviceRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Device | The RPC response. |
GetDevice(String, CallSettings)
public virtual Device GetDevice(string name, CallSettings callSettings = null)
Gets details about a device.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Device | The RPC response. |
GetDeviceAsync(DeviceName, CallSettings)
public virtual Task<Device> GetDeviceAsync(DeviceName name, CallSettings callSettings = null)
Gets details about a device.
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
GetDeviceAsync(DeviceName, CancellationToken)
public virtual Task<Device> GetDeviceAsync(DeviceName name, CancellationToken cancellationToken)
Gets details about a device.
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
GetDeviceAsync(GetDeviceRequest, CallSettings)
public virtual Task<Device> GetDeviceAsync(GetDeviceRequest request, CallSettings callSettings = null)
Gets details about a device.
Parameters | |
---|---|
Name | Description |
request | GetDeviceRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
GetDeviceAsync(GetDeviceRequest, CancellationToken)
public virtual Task<Device> GetDeviceAsync(GetDeviceRequest request, CancellationToken cancellationToken)
Gets details about a device.
Parameters | |
---|---|
Name | Description |
request | GetDeviceRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
GetDeviceAsync(String, CallSettings)
public virtual Task<Device> GetDeviceAsync(string name, CallSettings callSettings = null)
Gets details about a device.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
GetDeviceAsync(String, CancellationToken)
public virtual Task<Device> GetDeviceAsync(string name, CancellationToken cancellationToken)
Gets details about a device.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
GetDeviceRegistry(GetDeviceRegistryRequest, CallSettings)
public virtual DeviceRegistry GetDeviceRegistry(GetDeviceRegistryRequest request, CallSettings callSettings = null)
Gets a device registry configuration.
Parameters | |
---|---|
Name | Description |
request | GetDeviceRegistryRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceRegistry | The RPC response. |
GetDeviceRegistry(RegistryName, CallSettings)
public virtual DeviceRegistry GetDeviceRegistry(RegistryName name, CallSettings callSettings = null)
Gets a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | RegistryName Required. The name of the device registry. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceRegistry | The RPC response. |
GetDeviceRegistry(String, CallSettings)
public virtual DeviceRegistry GetDeviceRegistry(string name, CallSettings callSettings = null)
Gets a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device registry. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceRegistry | The RPC response. |
GetDeviceRegistryAsync(GetDeviceRegistryRequest, CallSettings)
public virtual Task<DeviceRegistry> GetDeviceRegistryAsync(GetDeviceRegistryRequest request, CallSettings callSettings = null)
Gets a device registry configuration.
Parameters | |
---|---|
Name | Description |
request | GetDeviceRegistryRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
GetDeviceRegistryAsync(GetDeviceRegistryRequest, CancellationToken)
public virtual Task<DeviceRegistry> GetDeviceRegistryAsync(GetDeviceRegistryRequest request, CancellationToken cancellationToken)
Gets a device registry configuration.
Parameters | |
---|---|
Name | Description |
request | GetDeviceRegistryRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
GetDeviceRegistryAsync(RegistryName, CallSettings)
public virtual Task<DeviceRegistry> GetDeviceRegistryAsync(RegistryName name, CallSettings callSettings = null)
Gets a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | RegistryName Required. The name of the device registry. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
GetDeviceRegistryAsync(RegistryName, CancellationToken)
public virtual Task<DeviceRegistry> GetDeviceRegistryAsync(RegistryName name, CancellationToken cancellationToken)
Gets a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | RegistryName Required. The name of the device registry. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
GetDeviceRegistryAsync(String, CallSettings)
public virtual Task<DeviceRegistry> GetDeviceRegistryAsync(string name, CallSettings callSettings = null)
Gets a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device registry. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
GetDeviceRegistryAsync(String, CancellationToken)
public virtual Task<DeviceRegistry> GetDeviceRegistryAsync(string name, CancellationToken cancellationToken)
Gets a device registry configuration.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device registry. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
GetIamPolicy(IResourceName, CallSettings)
public virtual Policy GetIamPolicy(IResourceName resource, CallSettings callSettings = null)
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 |
resource | Google.Api.Gax.IResourceName REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The RPC response. |
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)
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 | Google.Cloud.Iam.V1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The RPC response. |
GetIamPolicy(String, CallSettings)
public virtual Policy GetIamPolicy(string resource, CallSettings callSettings = null)
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 |
resource | System.String REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The RPC response. |
GetIamPolicyAsync(IResourceName, CallSettings)
public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, CallSettings callSettings = null)
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 |
resource | Google.Api.Gax.IResourceName REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
GetIamPolicyAsync(IResourceName, CancellationToken)
public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, CancellationToken cancellationToken)
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 |
resource | Google.Api.Gax.IResourceName REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)
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 | Google.Cloud.Iam.V1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)
public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CancellationToken cancellationToken)
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 | Google.Cloud.Iam.V1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
GetIamPolicyAsync(String, CallSettings)
public virtual Task<Policy> GetIamPolicyAsync(string resource, CallSettings callSettings = null)
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 |
resource | System.String REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
GetIamPolicyAsync(String, CancellationToken)
public virtual Task<Policy> GetIamPolicyAsync(string resource, CancellationToken cancellationToken)
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 |
resource | System.String REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
ListDeviceConfigVersions(DeviceName, CallSettings)
public virtual ListDeviceConfigVersionsResponse ListDeviceConfigVersions(DeviceName name, CallSettings callSettings = null)
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ListDeviceConfigVersionsResponse | The RPC response. |
ListDeviceConfigVersions(ListDeviceConfigVersionsRequest, CallSettings)
public virtual ListDeviceConfigVersionsResponse ListDeviceConfigVersions(ListDeviceConfigVersionsRequest request, CallSettings callSettings = null)
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
request | ListDeviceConfigVersionsRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ListDeviceConfigVersionsResponse | The RPC response. |
ListDeviceConfigVersions(String, CallSettings)
public virtual ListDeviceConfigVersionsResponse ListDeviceConfigVersions(string name, CallSettings callSettings = null)
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ListDeviceConfigVersionsResponse | The RPC response. |
ListDeviceConfigVersionsAsync(DeviceName, CallSettings)
public virtual Task<ListDeviceConfigVersionsResponse> ListDeviceConfigVersionsAsync(DeviceName name, CallSettings callSettings = null)
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceConfigVersionsResponse> | A Task containing the RPC response. |
ListDeviceConfigVersionsAsync(DeviceName, CancellationToken)
public virtual Task<ListDeviceConfigVersionsResponse> ListDeviceConfigVersionsAsync(DeviceName name, CancellationToken cancellationToken)
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceConfigVersionsResponse> | A Task containing the RPC response. |
ListDeviceConfigVersionsAsync(ListDeviceConfigVersionsRequest, CallSettings)
public virtual Task<ListDeviceConfigVersionsResponse> ListDeviceConfigVersionsAsync(ListDeviceConfigVersionsRequest request, CallSettings callSettings = null)
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
request | ListDeviceConfigVersionsRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceConfigVersionsResponse> | A Task containing the RPC response. |
ListDeviceConfigVersionsAsync(ListDeviceConfigVersionsRequest, CancellationToken)
public virtual Task<ListDeviceConfigVersionsResponse> ListDeviceConfigVersionsAsync(ListDeviceConfigVersionsRequest request, CancellationToken cancellationToken)
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
request | ListDeviceConfigVersionsRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceConfigVersionsResponse> | A Task containing the RPC response. |
ListDeviceConfigVersionsAsync(String, CallSettings)
public virtual Task<ListDeviceConfigVersionsResponse> ListDeviceConfigVersionsAsync(string name, CallSettings callSettings = null)
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceConfigVersionsResponse> | A Task containing the RPC response. |
ListDeviceConfigVersionsAsync(String, CancellationToken)
public virtual Task<ListDeviceConfigVersionsResponse> ListDeviceConfigVersionsAsync(string name, CancellationToken cancellationToken)
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceConfigVersionsResponse> | A Task containing the RPC response. |
ListDeviceRegistries(LocationName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> ListDeviceRegistries(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Lists device registries.
Parameters | |
---|---|
Name | Description |
parent | Google.Api.Gax.ResourceNames.LocationName Required. The project and cloud region path. For example,
|
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> | A pageable sequence of DeviceRegistry resources. |
ListDeviceRegistries(ListDeviceRegistriesRequest, CallSettings)
public virtual PagedEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> ListDeviceRegistries(ListDeviceRegistriesRequest request, CallSettings callSettings = null)
Lists device registries.
Parameters | |
---|---|
Name | Description |
request | ListDeviceRegistriesRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> | A pageable sequence of DeviceRegistry resources. |
ListDeviceRegistries(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> ListDeviceRegistries(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Lists device registries.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The project and cloud region path. For example,
|
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> | A pageable sequence of DeviceRegistry resources. |
ListDeviceRegistriesAsync(LocationName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> ListDeviceRegistriesAsync(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Lists device registries.
Parameters | |
---|---|
Name | Description |
parent | Google.Api.Gax.ResourceNames.LocationName Required. The project and cloud region path. For example,
|
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> | A pageable asynchronous sequence of DeviceRegistry resources. |
ListDeviceRegistriesAsync(ListDeviceRegistriesRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> ListDeviceRegistriesAsync(ListDeviceRegistriesRequest request, CallSettings callSettings = null)
Lists device registries.
Parameters | |
---|---|
Name | Description |
request | ListDeviceRegistriesRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> | A pageable asynchronous sequence of DeviceRegistry resources. |
ListDeviceRegistriesAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> ListDeviceRegistriesAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Lists device registries.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The project and cloud region path. For example,
|
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListDeviceRegistriesResponse, DeviceRegistry> | A pageable asynchronous sequence of DeviceRegistry resources. |
ListDevices(ListDevicesRequest, CallSettings)
public virtual PagedEnumerable<ListDevicesResponse, Device> ListDevices(ListDevicesRequest request, CallSettings callSettings = null)
List devices in a device registry.
Parameters | |
---|---|
Name | Description |
request | ListDevicesRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListDevicesResponse, Device> | A pageable sequence of Device resources. |
ListDevices(RegistryName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListDevicesResponse, Device> ListDevices(RegistryName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
List devices in a device registry.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The device registry path. Required. For example,
|
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListDevicesResponse, Device> | A pageable sequence of Device resources. |
ListDevices(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListDevicesResponse, Device> ListDevices(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
List devices in a device registry.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The device registry path. Required. For example,
|
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListDevicesResponse, Device> | A pageable sequence of Device resources. |
ListDevicesAsync(ListDevicesRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListDevicesResponse, Device> ListDevicesAsync(ListDevicesRequest request, CallSettings callSettings = null)
List devices in a device registry.
Parameters | |
---|---|
Name | Description |
request | ListDevicesRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListDevicesResponse, Device> | A pageable asynchronous sequence of Device resources. |
ListDevicesAsync(RegistryName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListDevicesResponse, Device> ListDevicesAsync(RegistryName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
List devices in a device registry.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The device registry path. Required. For example,
|
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListDevicesResponse, Device> | A pageable asynchronous sequence of Device resources. |
ListDevicesAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListDevicesResponse, Device> ListDevicesAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
List devices in a device registry.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The device registry path. Required. For example,
|
pageToken | System.String The token returned from the previous request. A value of |
pageSize | System.Nullable<System.Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListDevicesResponse, Device> | A pageable asynchronous sequence of Device resources. |
ListDeviceStates(DeviceName, CallSettings)
public virtual ListDeviceStatesResponse ListDeviceStates(DeviceName name, CallSettings callSettings = null)
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ListDeviceStatesResponse | The RPC response. |
ListDeviceStates(ListDeviceStatesRequest, CallSettings)
public virtual ListDeviceStatesResponse ListDeviceStates(ListDeviceStatesRequest request, CallSettings callSettings = null)
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
request | ListDeviceStatesRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ListDeviceStatesResponse | The RPC response. |
ListDeviceStates(String, CallSettings)
public virtual ListDeviceStatesResponse ListDeviceStates(string name, CallSettings callSettings = null)
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ListDeviceStatesResponse | The RPC response. |
ListDeviceStatesAsync(DeviceName, CallSettings)
public virtual Task<ListDeviceStatesResponse> ListDeviceStatesAsync(DeviceName name, CallSettings callSettings = null)
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceStatesResponse> | A Task containing the RPC response. |
ListDeviceStatesAsync(DeviceName, CancellationToken)
public virtual Task<ListDeviceStatesResponse> ListDeviceStatesAsync(DeviceName name, CancellationToken cancellationToken)
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | DeviceName Required. The name of the device. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceStatesResponse> | A Task containing the RPC response. |
ListDeviceStatesAsync(ListDeviceStatesRequest, CallSettings)
public virtual Task<ListDeviceStatesResponse> ListDeviceStatesAsync(ListDeviceStatesRequest request, CallSettings callSettings = null)
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
request | ListDeviceStatesRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceStatesResponse> | A Task containing the RPC response. |
ListDeviceStatesAsync(ListDeviceStatesRequest, CancellationToken)
public virtual Task<ListDeviceStatesResponse> ListDeviceStatesAsync(ListDeviceStatesRequest request, CancellationToken cancellationToken)
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
request | ListDeviceStatesRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceStatesResponse> | A Task containing the RPC response. |
ListDeviceStatesAsync(String, CallSettings)
public virtual Task<ListDeviceStatesResponse> ListDeviceStatesAsync(string name, CallSettings callSettings = null)
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceStatesResponse> | A Task containing the RPC response. |
ListDeviceStatesAsync(String, CancellationToken)
public virtual Task<ListDeviceStatesResponse> ListDeviceStatesAsync(string name, CancellationToken cancellationToken)
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the device. For example,
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<ListDeviceStatesResponse> | A Task containing the RPC response. |
ModifyCloudToDeviceConfig(DeviceName, ByteString, CallSettings)
public virtual DeviceConfig ModifyCloudToDeviceConfig(DeviceName name, ByteString binaryData, CallSettings callSettings = null)
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 |
name | DeviceName Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The configuration data for the device. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceConfig | The RPC response. |
ModifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest, CallSettings)
public virtual DeviceConfig ModifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceConfig | The RPC response. |
ModifyCloudToDeviceConfig(String, ByteString, CallSettings)
public virtual DeviceConfig ModifyCloudToDeviceConfig(string name, ByteString binaryData, CallSettings callSettings = null)
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 |
name | System.String Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The configuration data for the device. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceConfig | The RPC response. |
ModifyCloudToDeviceConfigAsync(DeviceName, ByteString, CallSettings)
public virtual Task<DeviceConfig> ModifyCloudToDeviceConfigAsync(DeviceName name, ByteString binaryData, CallSettings callSettings = null)
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 |
name | DeviceName Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The configuration data for the device. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceConfig> | A Task containing the RPC response. |
ModifyCloudToDeviceConfigAsync(DeviceName, ByteString, CancellationToken)
public virtual Task<DeviceConfig> ModifyCloudToDeviceConfigAsync(DeviceName name, ByteString binaryData, CancellationToken cancellationToken)
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 |
name | DeviceName Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The configuration data for the device. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceConfig> | A Task containing the RPC response. |
ModifyCloudToDeviceConfigAsync(ModifyCloudToDeviceConfigRequest, CallSettings)
public virtual Task<DeviceConfig> ModifyCloudToDeviceConfigAsync(ModifyCloudToDeviceConfigRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceConfig> | A Task containing the RPC response. |
ModifyCloudToDeviceConfigAsync(ModifyCloudToDeviceConfigRequest, CancellationToken)
public virtual Task<DeviceConfig> ModifyCloudToDeviceConfigAsync(ModifyCloudToDeviceConfigRequest request, CancellationToken cancellationToken)
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 object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceConfig> | A Task containing the RPC response. |
ModifyCloudToDeviceConfigAsync(String, ByteString, CallSettings)
public virtual Task<DeviceConfig> ModifyCloudToDeviceConfigAsync(string name, ByteString binaryData, CallSettings callSettings = null)
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 |
name | System.String Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The configuration data for the device. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceConfig> | A Task containing the RPC response. |
ModifyCloudToDeviceConfigAsync(String, ByteString, CancellationToken)
public virtual Task<DeviceConfig> ModifyCloudToDeviceConfigAsync(string name, ByteString binaryData, CancellationToken cancellationToken)
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 |
name | System.String Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The configuration data for the device. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceConfig> | A Task containing the RPC response. |
SendCommandToDevice(DeviceName, ByteString, CallSettings)
public virtual SendCommandToDeviceResponse SendCommandToDevice(DeviceName name, ByteString binaryData, CallSettings callSettings = null)
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 |
name | DeviceName Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SendCommandToDeviceResponse | The RPC response. |
SendCommandToDevice(DeviceName, ByteString, String, CallSettings)
public virtual SendCommandToDeviceResponse SendCommandToDevice(DeviceName name, ByteString binaryData, string subfolder, CallSettings callSettings = null)
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 |
name | DeviceName Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
subfolder | System.String Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SendCommandToDeviceResponse | The RPC response. |
SendCommandToDevice(SendCommandToDeviceRequest, CallSettings)
public virtual SendCommandToDeviceResponse SendCommandToDevice(SendCommandToDeviceRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SendCommandToDeviceResponse | The RPC response. |
SendCommandToDevice(String, ByteString, CallSettings)
public virtual SendCommandToDeviceResponse SendCommandToDevice(string name, ByteString binaryData, CallSettings callSettings = null)
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 |
name | System.String Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SendCommandToDeviceResponse | The RPC response. |
SendCommandToDevice(String, ByteString, String, CallSettings)
public virtual SendCommandToDeviceResponse SendCommandToDevice(string name, ByteString binaryData, string subfolder, CallSettings callSettings = null)
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 |
name | System.String Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
subfolder | System.String Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SendCommandToDeviceResponse | The RPC response. |
SendCommandToDeviceAsync(DeviceName, ByteString, CallSettings)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(DeviceName name, ByteString binaryData, CallSettings callSettings = null)
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 |
name | DeviceName Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SendCommandToDeviceAsync(DeviceName, ByteString, String, CallSettings)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(DeviceName name, ByteString binaryData, string subfolder, CallSettings callSettings = null)
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 |
name | DeviceName Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
subfolder | System.String Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SendCommandToDeviceAsync(DeviceName, ByteString, String, CancellationToken)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(DeviceName name, ByteString binaryData, string subfolder, CancellationToken cancellationToken)
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 |
name | DeviceName Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
subfolder | System.String Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SendCommandToDeviceAsync(DeviceName, ByteString, CancellationToken)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(DeviceName name, ByteString binaryData, CancellationToken cancellationToken)
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 |
name | DeviceName Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SendCommandToDeviceAsync(SendCommandToDeviceRequest, CallSettings)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(SendCommandToDeviceRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SendCommandToDeviceAsync(SendCommandToDeviceRequest, CancellationToken)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(SendCommandToDeviceRequest request, CancellationToken cancellationToken)
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 object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SendCommandToDeviceAsync(String, ByteString, CallSettings)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(string name, ByteString binaryData, CallSettings callSettings = null)
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 |
name | System.String Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SendCommandToDeviceAsync(String, ByteString, String, CallSettings)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(string name, ByteString binaryData, string subfolder, CallSettings callSettings = null)
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 |
name | System.String Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
subfolder | System.String Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SendCommandToDeviceAsync(String, ByteString, String, CancellationToken)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(string name, ByteString binaryData, string subfolder, CancellationToken cancellationToken)
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 |
name | System.String Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
subfolder | System.String Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SendCommandToDeviceAsync(String, ByteString, CancellationToken)
public virtual Task<SendCommandToDeviceResponse> SendCommandToDeviceAsync(string name, ByteString binaryData, CancellationToken cancellationToken)
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 |
name | System.String Required. The name of the device. For example,
|
binaryData | Google.Protobuf.ByteString Required. The command data to send to the device. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<SendCommandToDeviceResponse> | A Task containing the RPC response. |
SetIamPolicy(IResourceName, Policy, CallSettings)
public virtual Policy SetIamPolicy(IResourceName resource, Policy policy, CallSettings callSettings = null)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
resource | Google.Api.Gax.IResourceName REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Google.Cloud.Iam.V1.Policy REQUIRED: The complete policy to be applied to the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The RPC response. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The RPC response. |
SetIamPolicy(String, Policy, CallSettings)
public virtual Policy SetIamPolicy(string resource, Policy policy, CallSettings callSettings = null)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
resource | System.String REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Google.Cloud.Iam.V1.Policy REQUIRED: The complete policy to be applied to the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.Policy | The RPC response. |
SetIamPolicyAsync(IResourceName, Policy, CallSettings)
public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, Policy policy, CallSettings callSettings = null)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
resource | Google.Api.Gax.IResourceName REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Google.Cloud.Iam.V1.Policy REQUIRED: The complete policy to be applied to the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
SetIamPolicyAsync(IResourceName, Policy, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, Policy policy, CancellationToken cancellationToken)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
resource | Google.Api.Gax.IResourceName REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Google.Cloud.Iam.V1.Policy REQUIRED: The complete policy to be applied to the |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CancellationToken cancellationToken)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
SetIamPolicyAsync(String, Policy, CallSettings)
public virtual Task<Policy> SetIamPolicyAsync(string resource, Policy policy, CallSettings callSettings = null)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
resource | System.String REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Google.Cloud.Iam.V1.Policy REQUIRED: The complete policy to be applied to the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
SetIamPolicyAsync(String, Policy, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(string resource, Policy policy, CancellationToken cancellationToken)
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
resource | System.String REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Google.Cloud.Iam.V1.Policy REQUIRED: The complete policy to be applied to the |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> | A Task containing the RPC response. |
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task | A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
TestIamPermissions(IResourceName, IEnumerable<String>, CallSettings)
public virtual TestIamPermissionsResponse TestIamPermissions(IResourceName resource, IEnumerable<string> permissions, CallSettings callSettings = null)
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 |
resource | Google.Api.Gax.IResourceName REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | System.Collections.Generic.IEnumerable<System.String> The set of permissions to check for the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.TestIamPermissionsResponse | The RPC response. |
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)
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 | Google.Cloud.Iam.V1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.TestIamPermissionsResponse | The RPC response. |
TestIamPermissions(String, IEnumerable<String>, CallSettings)
public virtual TestIamPermissionsResponse TestIamPermissions(string resource, IEnumerable<string> permissions, CallSettings callSettings = null)
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 |
resource | System.String REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | System.Collections.Generic.IEnumerable<System.String> The set of permissions to check for the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Cloud.Iam.V1.TestIamPermissionsResponse | The RPC response. |
TestIamPermissionsAsync(IResourceName, IEnumerable<String>, CallSettings)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(IResourceName resource, IEnumerable<string> permissions, CallSettings callSettings = null)
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 |
resource | Google.Api.Gax.IResourceName REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | System.Collections.Generic.IEnumerable<System.String> The set of permissions to check for the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | A Task containing the RPC response. |
TestIamPermissionsAsync(IResourceName, IEnumerable<String>, CancellationToken)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(IResourceName resource, IEnumerable<string> permissions, CancellationToken cancellationToken)
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 |
resource | Google.Api.Gax.IResourceName REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | System.Collections.Generic.IEnumerable<System.String> The set of permissions to check for the |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | A Task containing the RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)
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 | Google.Cloud.Iam.V1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | A Task containing the RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CancellationToken cancellationToken)
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 | Google.Cloud.Iam.V1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | A Task containing the RPC response. |
TestIamPermissionsAsync(String, IEnumerable<String>, CallSettings)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(string resource, IEnumerable<string> permissions, CallSettings callSettings = null)
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 |
resource | System.String REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | System.Collections.Generic.IEnumerable<System.String> The set of permissions to check for the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | A Task containing the RPC response. |
TestIamPermissionsAsync(String, IEnumerable<String>, CancellationToken)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(string resource, IEnumerable<string> permissions, CancellationToken cancellationToken)
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 |
resource | System.String REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions | System.Collections.Generic.IEnumerable<System.String> The set of permissions to check for the |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | A Task containing the RPC response. |
UnbindDeviceFromGateway(RegistryName, String, String, CallSettings)
public virtual UnbindDeviceFromGatewayResponse UnbindDeviceFromGateway(RegistryName parent, string gatewayId, string deviceId, CallSettings callSettings = null)
Deletes the association between the device and the gateway.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to disassociate from the specified gateway. The value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
UnbindDeviceFromGatewayResponse | The RPC response. |
UnbindDeviceFromGateway(UnbindDeviceFromGatewayRequest, CallSettings)
public virtual UnbindDeviceFromGatewayResponse UnbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request, CallSettings callSettings = null)
Deletes the association between the device and the gateway.
Parameters | |
---|---|
Name | Description |
request | UnbindDeviceFromGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
UnbindDeviceFromGatewayResponse | The RPC response. |
UnbindDeviceFromGateway(String, String, String, CallSettings)
public virtual UnbindDeviceFromGatewayResponse UnbindDeviceFromGateway(string parent, string gatewayId, string deviceId, CallSettings callSettings = null)
Deletes the association between the device and the gateway.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to disassociate from the specified gateway. The value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
UnbindDeviceFromGatewayResponse | The RPC response. |
UnbindDeviceFromGatewayAsync(RegistryName, String, String, CallSettings)
public virtual Task<UnbindDeviceFromGatewayResponse> UnbindDeviceFromGatewayAsync(RegistryName parent, string gatewayId, string deviceId, CallSettings callSettings = null)
Deletes the association between the device and the gateway.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to disassociate from the specified gateway. The value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<UnbindDeviceFromGatewayResponse> | A Task containing the RPC response. |
UnbindDeviceFromGatewayAsync(RegistryName, String, String, CancellationToken)
public virtual Task<UnbindDeviceFromGatewayResponse> UnbindDeviceFromGatewayAsync(RegistryName parent, string gatewayId, string deviceId, CancellationToken cancellationToken)
Deletes the association between the device and the gateway.
Parameters | |
---|---|
Name | Description |
parent | RegistryName Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to disassociate from the specified gateway. The value of
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<UnbindDeviceFromGatewayResponse> | A Task containing the RPC response. |
UnbindDeviceFromGatewayAsync(UnbindDeviceFromGatewayRequest, CallSettings)
public virtual Task<UnbindDeviceFromGatewayResponse> UnbindDeviceFromGatewayAsync(UnbindDeviceFromGatewayRequest request, CallSettings callSettings = null)
Deletes the association between the device and the gateway.
Parameters | |
---|---|
Name | Description |
request | UnbindDeviceFromGatewayRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<UnbindDeviceFromGatewayResponse> | A Task containing the RPC response. |
UnbindDeviceFromGatewayAsync(UnbindDeviceFromGatewayRequest, CancellationToken)
public virtual Task<UnbindDeviceFromGatewayResponse> UnbindDeviceFromGatewayAsync(UnbindDeviceFromGatewayRequest request, CancellationToken cancellationToken)
Deletes the association between the device and the gateway.
Parameters | |
---|---|
Name | Description |
request | UnbindDeviceFromGatewayRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<UnbindDeviceFromGatewayResponse> | A Task containing the RPC response. |
UnbindDeviceFromGatewayAsync(String, String, String, CallSettings)
public virtual Task<UnbindDeviceFromGatewayResponse> UnbindDeviceFromGatewayAsync(string parent, string gatewayId, string deviceId, CallSettings callSettings = null)
Deletes the association between the device and the gateway.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to disassociate from the specified gateway. The value of
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<UnbindDeviceFromGatewayResponse> | A Task containing the RPC response. |
UnbindDeviceFromGatewayAsync(String, String, String, CancellationToken)
public virtual Task<UnbindDeviceFromGatewayResponse> UnbindDeviceFromGatewayAsync(string parent, string gatewayId, string deviceId, CancellationToken cancellationToken)
Deletes the association between the device and the gateway.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The name of the registry. For example,
|
gatewayId | System.String Required. The value of |
deviceId | System.String Required. The device to disassociate from the specified gateway. The value of
|
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<UnbindDeviceFromGatewayResponse> | A Task containing the RPC response. |
UpdateDevice(Device, FieldMask, CallSettings)
public virtual Device UpdateDevice(Device device, FieldMask updateMask, CallSettings callSettings = null)
Updates a device.
Parameters | |
---|---|
Name | Description |
device | Device Required. The new values for the device. The |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask Required. Only updates the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Device | The RPC response. |
UpdateDevice(UpdateDeviceRequest, CallSettings)
public virtual Device UpdateDevice(UpdateDeviceRequest request, CallSettings callSettings = null)
Updates a device.
Parameters | |
---|---|
Name | Description |
request | UpdateDeviceRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Device | The RPC response. |
UpdateDeviceAsync(Device, FieldMask, CallSettings)
public virtual Task<Device> UpdateDeviceAsync(Device device, FieldMask updateMask, CallSettings callSettings = null)
Updates a device.
Parameters | |
---|---|
Name | Description |
device | Device Required. The new values for the device. The |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask Required. Only updates the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
UpdateDeviceAsync(Device, FieldMask, CancellationToken)
public virtual Task<Device> UpdateDeviceAsync(Device device, FieldMask updateMask, CancellationToken cancellationToken)
Updates a device.
Parameters | |
---|---|
Name | Description |
device | Device Required. The new values for the device. The |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask Required. Only updates the |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
UpdateDeviceAsync(UpdateDeviceRequest, CallSettings)
public virtual Task<Device> UpdateDeviceAsync(UpdateDeviceRequest request, CallSettings callSettings = null)
Updates a device.
Parameters | |
---|---|
Name | Description |
request | UpdateDeviceRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
UpdateDeviceAsync(UpdateDeviceRequest, CancellationToken)
public virtual Task<Device> UpdateDeviceAsync(UpdateDeviceRequest request, CancellationToken cancellationToken)
Updates a device.
Parameters | |
---|---|
Name | Description |
request | UpdateDeviceRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Device> | A Task containing the RPC response. |
UpdateDeviceRegistry(DeviceRegistry, FieldMask, CallSettings)
public virtual DeviceRegistry UpdateDeviceRegistry(DeviceRegistry deviceRegistry, FieldMask updateMask, CallSettings callSettings = null)
Updates a device registry configuration.
Parameters | |
---|---|
Name | Description |
deviceRegistry | DeviceRegistry Required. The new values for the device registry. The |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask Required. Only updates the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceRegistry | The RPC response. |
UpdateDeviceRegistry(UpdateDeviceRegistryRequest, CallSettings)
public virtual DeviceRegistry UpdateDeviceRegistry(UpdateDeviceRegistryRequest request, CallSettings callSettings = null)
Updates a device registry configuration.
Parameters | |
---|---|
Name | Description |
request | UpdateDeviceRegistryRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
DeviceRegistry | The RPC response. |
UpdateDeviceRegistryAsync(DeviceRegistry, FieldMask, CallSettings)
public virtual Task<DeviceRegistry> UpdateDeviceRegistryAsync(DeviceRegistry deviceRegistry, FieldMask updateMask, CallSettings callSettings = null)
Updates a device registry configuration.
Parameters | |
---|---|
Name | Description |
deviceRegistry | DeviceRegistry Required. The new values for the device registry. The |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask Required. Only updates the |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
UpdateDeviceRegistryAsync(DeviceRegistry, FieldMask, CancellationToken)
public virtual Task<DeviceRegistry> UpdateDeviceRegistryAsync(DeviceRegistry deviceRegistry, FieldMask updateMask, CancellationToken cancellationToken)
Updates a device registry configuration.
Parameters | |
---|---|
Name | Description |
deviceRegistry | DeviceRegistry Required. The new values for the device registry. The |
updateMask | Google.Protobuf.WellKnownTypes.FieldMask Required. Only updates the |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
UpdateDeviceRegistryAsync(UpdateDeviceRegistryRequest, CallSettings)
public virtual Task<DeviceRegistry> UpdateDeviceRegistryAsync(UpdateDeviceRegistryRequest request, CallSettings callSettings = null)
Updates a device registry configuration.
Parameters | |
---|---|
Name | Description |
request | UpdateDeviceRegistryRequest The request object containing all of the parameters for the API call. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |
UpdateDeviceRegistryAsync(UpdateDeviceRegistryRequest, CancellationToken)
public virtual Task<DeviceRegistry> UpdateDeviceRegistryAsync(UpdateDeviceRegistryRequest request, CancellationToken cancellationToken)
Updates a device registry configuration.
Parameters | |
---|---|
Name | Description |
request | UpdateDeviceRegistryRequest The request object containing all of the parameters for the API call. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<DeviceRegistry> | A Task containing the RPC response. |