com.google.api.services.cloudiot.v1

Class CloudIot.Projects.Locations.Registries.Devices

java.lang.Object

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

Enclosing class:

CloudIot.Projects.Locations.Registries

public class CloudIot.Projects.Locations.Registries.Devices
extends Object

The "devices" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudIot.Projects.Locations.Registries.Devices.ConfigVersions The "configVersions" collection of methods.
class	CloudIot.Projects.Locations.Registries.Devices.Create
class	CloudIot.Projects.Locations.Registries.Devices.Delete
class	CloudIot.Projects.Locations.Registries.Devices.Get
class	CloudIot.Projects.Locations.Registries.Devices.List
class	CloudIot.Projects.Locations.Registries.Devices.ModifyCloudToDeviceConfig
class	CloudIot.Projects.Locations.Registries.Devices.Patch
class	CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice
class	CloudIot.Projects.Locations.Registries.Devices.States The "states" collection of methods.

Constructor Summary

Constructors

Constructor and Description
Devices()

Method Summary

Modifier and Type	Method and Description
CloudIot.Projects.Locations.Registries.Devices.ConfigVersions	configVersions() An accessor for creating requests from the ConfigVersions collection.
CloudIot.Projects.Locations.Registries.Devices.Create	create(String parent, Device content) Creates a device in a device registry.
CloudIot.Projects.Locations.Registries.Devices.Delete	delete(String name) Deletes a device.
CloudIot.Projects.Locations.Registries.Devices.Get	get(String name) Gets details about a device.
CloudIot.Projects.Locations.Registries.Devices.List	list(String parent) List devices in a device registry.
CloudIot.Projects.Locations.Registries.Devices.ModifyCloudToDeviceConfig	modifyCloudToDeviceConfig(String name, ModifyCloudToDeviceConfigRequest content) Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers.
CloudIot.Projects.Locations.Registries.Devices.Patch	patch(String name, Device content) Updates a device.
CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice	sendCommandToDevice(String name, SendCommandToDeviceRequest content) Sends a command to the specified device.
CloudIot.Projects.Locations.Registries.Devices.States	states() An accessor for creating requests from the States collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Devices

public Devices()

Method Detail

create

public CloudIot.Projects.Locations.Registries.Devices.Create create(String parent,
                                                                    Device content)
                                                             throws IOException

Creates a device in a device registry. Create a request for the method "devices.create". This request holds the parameters needed by the cloudiot server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the device registry where this device should be created. For example, `projects/example-project/locations/us-central1/registries/my-registry`.

content - the Device

Returns:

the request

Throws:

IOException

delete

public CloudIot.Projects.Locations.Registries.Devices.Delete delete(String name)
                                                             throws IOException

Deletes a device. Create a request for the method "devices.delete". This request holds the parameters needed by the cloudiot server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Returns:

the request

Throws:

IOException

get

public CloudIot.Projects.Locations.Registries.Devices.Get get(String name)
                                                       throws IOException

Gets details about a device. Create a request for the method "devices.get". This request holds the parameters needed by the cloudiot server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Returns:

the request

Throws:

IOException

list

public CloudIot.Projects.Locations.Registries.Devices.List list(String parent)
                                                         throws IOException

List devices in a device registry. Create a request for the method "devices.list". This request holds the parameters needed by the cloudiot server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The device registry path. Required. For example, `projects/my-project/locations/us- central1/registries/my-registry`.

Returns:

the request

Throws:

IOException

modifyCloudToDeviceConfig

public CloudIot.Projects.Locations.Registries.Devices.ModifyCloudToDeviceConfig modifyCloudToDeviceConfig(String name,
                                                                                                          ModifyCloudToDeviceConfigRequest content)
                                                                                                   throws IOException

Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata. Create a request for the method "devices.modifyCloudToDeviceConfig". This request holds the parameters needed by the cloudiot server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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 ModifyCloudToDeviceConfigRequest

Returns:

the request

Throws:

IOException

patch

public CloudIot.Projects.Locations.Registries.Devices.Patch patch(String name,
                                                                  Device content)
                                                           throws IOException

Updates a device. Create a request for the method "devices.patch". This request holds the parameters needed by the cloudiot server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource path name. For example, `projects/p1/locations/us- central1/registries/registry0/devices/dev0` or `projects/p1/locations/us- central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID.

content - the Device

Returns:

the request

Throws:

IOException

sendCommandToDevice

public CloudIot.Projects.Locations.Registries.Devices.SendCommandToDevice sendCommandToDevice(String name,
                                                                                              SendCommandToDeviceRequest content)
                                                                                       throws IOException

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 cloudiot server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Returns:

the request

Throws:

IOException

configVersions

public CloudIot.Projects.Locations.Registries.Devices.ConfigVersions configVersions()

An accessor for creating requests from the ConfigVersions collection.

The typical use is:

    CloudIot cloudiot = new CloudIot(...);
    CloudIot.ConfigVersions.List request = cloudiot.configVersions().list(parameters ...)
 

Returns:

the resource collection

states

public CloudIot.Projects.Locations.Registries.Devices.States states()

An accessor for creating requests from the States collection.

The typical use is:

    CloudIot cloudiot = new CloudIot(...);
    CloudIot.States.List request = cloudiot.states().list(parameters ...)
 

Returns:

the resource collection