Cloud IoT V1 API - Class Google::Cloud::Iot::V1::SendCommandToDeviceRequest (v0.4.0)

Reference documentation and code samples for the Cloud IoT V1 API class Google::Cloud::Iot::V1::SendCommandToDeviceRequest.

Request for SendCommandToDevice.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#binary_data

def binary_data() -> ::String
Returns
  • (::String) — Required. The command data to send to the device.

#binary_data=

def binary_data=(value) -> ::String
Parameter
  • value (::String) — Required. The command data to send to the device.
Returns
  • (::String) — Required. The command data to send to the device.

#name

def name() -> ::String
Returns
  • (::String) — 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}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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}.
Returns
  • (::String) — 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}.

#subfolder

def subfolder() -> ::String
Returns
  • (::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.

#subfolder=

def subfolder=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.