Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.RegistriesResource.DevicesResource.SendCommandToDeviceRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SendCommandToDeviceResponse>
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>
ProjectsResource.LocationsResource.RegistriesResource.DevicesResource.SendCommandToDeviceRequest
Implements
IClientServiceRequest<SendCommandToDeviceResponse>
IClientServiceRequest
Inherited Members
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.Xgafv
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.AccessToken
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.Alt
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.Callback
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.Fields
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.Key
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.OauthToken
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.PrettyPrint
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.QuotaUser
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.UploadType
CloudIotBaseServiceRequest<SendCommandToDeviceResponse>.UploadProtocol
ClientServiceRequest<SendCommandToDeviceResponse>.Execute()
ClientServiceRequest<SendCommandToDeviceResponse>.ExecuteAsStream()
ClientServiceRequest<SendCommandToDeviceResponse>.ExecuteAsync()
ClientServiceRequest<SendCommandToDeviceResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<SendCommandToDeviceResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<SendCommandToDeviceResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<SendCommandToDeviceResponse>.CreateRequest(bool?)
ClientServiceRequest<SendCommandToDeviceResponse>.GenerateRequestUri()
ClientServiceRequest<SendCommandToDeviceResponse>.GetDefaultETagAction(string)
ClientServiceRequest<SendCommandToDeviceResponse>.ETagAction
ClientServiceRequest<SendCommandToDeviceResponse>.ModifyRequest
ClientServiceRequest<SendCommandToDeviceResponse>.ValidateParameters
ClientServiceRequest<SendCommandToDeviceResponse>.RequestParameters
ClientServiceRequest<SendCommandToDeviceResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudIot.v1
Assembly: Google.Apis.CloudIot.v1.dll
Syntax
public class ProjectsResource.LocationsResource.RegistriesResource.DevicesResource.SendCommandToDeviceRequest : CloudIotBaseServiceRequest<SendCommandToDeviceResponse>, IClientServiceRequest<SendCommandToDeviceResponse>, IClientServiceRequest

Constructors

SendCommandToDeviceRequest(IClientService, SendCommandToDeviceRequest, string)

Constructs a new SendCommandToDevice request.

Declaration
public SendCommandToDeviceRequest(IClientService service, SendCommandToDeviceRequest body, string name)
Parameters
Type Name Description
IClientService service
SendCommandToDeviceRequest body
string name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudIot.v1.Data.SendCommandToDeviceResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudIot.v1.Data.SendCommandToDeviceResponse>.MethodName

Name

Required. The name of the device. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0 or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudIot.v1.Data.SendCommandToDeviceResponse>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudIot.v1.Data.SendCommandToDeviceResponse>.GetBody()

InitParameters()

Initializes SendCommandToDevice parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.CloudIot.v1.CloudIotBaseServiceRequest<Google.Apis.CloudIot.v1.Data.SendCommandToDeviceResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In This Article
Back to top Generated by DocFX