com.google.api.services.cloudiot.v1

Class CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.cloudiot.v1.CloudIotRequest<SendCommandToDeviceResponse>

com.google.api.services.cloudiot.v1.CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudIot.Projects.Locations.Registries.Devices

public class CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice
extends CloudIotRequest<SendCommandToDeviceResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SendCommandToDevice(String name, SendCommandToDeviceRequest content) Sends a command to the specified device.

Method Summary

Modifier and Type	Method and Description
String	getName() Required.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	set(String parameterName, Object value)
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	set$Xgafv(String $Xgafv) V1 error format.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setAccessToken(String accessToken) OAuth access token.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setAlt(String alt) Data format for response.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setCallback(String callback) JSONP
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setKey(String key) API key.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setName(String name) Required.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudiot.v1.CloudIotRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SendCommandToDevice

protected SendCommandToDevice(String name,
                              SendCommandToDeviceRequest content)

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. Create a request for the method "devices.sendCommandToDevice". This request holds the parameters needed by the the cloudiot server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

SendCommandToDevice#initialize(com.google.api.client.googleapis.services. AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

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}`.

content - the SendCommandToDeviceRequest

Since:

1.13

Method Detail

set$Xgafv

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice set$Xgafv(String $Xgafv)

Description copied from class: CloudIotRequest

V1 error format.

Overrides:

set$Xgafv in class CloudIotRequest<SendCommandToDeviceResponse>

setAccessToken

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setAccessToken(String accessToken)

Description copied from class: CloudIotRequest

OAuth access token.

Overrides:

setAccessToken in class CloudIotRequest<SendCommandToDeviceResponse>

setAlt

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setAlt(String alt)

Description copied from class: CloudIotRequest

Data format for response.

Overrides:

setAlt in class CloudIotRequest<SendCommandToDeviceResponse>

setCallback

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setCallback(String callback)

Description copied from class: CloudIotRequest

JSONP

Overrides:

setCallback in class CloudIotRequest<SendCommandToDeviceResponse>

setFields

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setFields(String fields)

Description copied from class: CloudIotRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudIotRequest<SendCommandToDeviceResponse>

setKey

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setKey(String key)

Description copied from class: CloudIotRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class CloudIotRequest<SendCommandToDeviceResponse>

setOauthToken

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setOauthToken(String oauthToken)

Description copied from class: CloudIotRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudIotRequest<SendCommandToDeviceResponse>

setPrettyPrint

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudIotRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudIotRequest<SendCommandToDeviceResponse>

setQuotaUser

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setQuotaUser(String quotaUser)

Description copied from class: CloudIotRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class CloudIotRequest<SendCommandToDeviceResponse>

setUploadType

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setUploadType(String uploadType)

Description copied from class: CloudIotRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class CloudIotRequest<SendCommandToDeviceResponse>

setUploadProtocol

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setUploadProtocol(String uploadProtocol)

Description copied from class: CloudIotRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class CloudIotRequest<SendCommandToDeviceResponse>

getName

public String getName()

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}`.

setName

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice setName(String 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}`.

set

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice set(String parameterName,
                                                                              Object value)

Overrides:

set in class CloudIotRequest<SendCommandToDeviceResponse>