Package com.google.cloud.iot.v1 (2.13.0)

A client to Cloud IoT API

The interfaces provided are listed below, along with usage samples.

DeviceManagerClient

Service Description: Internet of Things (IoT) service. Securely connect and manage IoT devices.

Sample for DeviceManagerClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeviceRegistry deviceRegistry = DeviceRegistry.newBuilder().build();
   DeviceRegistry response = deviceManagerClient.createDeviceRegistry(parent, deviceRegistry);
 }

Classes

BindDeviceToGatewayRequest

Request for BindDeviceToGateway.

Protobuf type google.cloud.iot.v1.BindDeviceToGatewayRequest

BindDeviceToGatewayRequest.Builder

Request for BindDeviceToGateway.

Protobuf type google.cloud.iot.v1.BindDeviceToGatewayRequest

BindDeviceToGatewayResponse

Response for BindDeviceToGateway.

Protobuf type google.cloud.iot.v1.BindDeviceToGatewayResponse

BindDeviceToGatewayResponse.Builder

Response for BindDeviceToGateway.

Protobuf type google.cloud.iot.v1.BindDeviceToGatewayResponse

CreateDeviceRegistryRequest

Request for CreateDeviceRegistry.

Protobuf type google.cloud.iot.v1.CreateDeviceRegistryRequest

CreateDeviceRegistryRequest.Builder

Request for CreateDeviceRegistry.

Protobuf type google.cloud.iot.v1.CreateDeviceRegistryRequest

CreateDeviceRequest

Request for CreateDevice.

Protobuf type google.cloud.iot.v1.CreateDeviceRequest

CreateDeviceRequest.Builder

Request for CreateDevice.

Protobuf type google.cloud.iot.v1.CreateDeviceRequest

DeleteDeviceRegistryRequest

Request for DeleteDeviceRegistry.

Protobuf type google.cloud.iot.v1.DeleteDeviceRegistryRequest

DeleteDeviceRegistryRequest.Builder

Request for DeleteDeviceRegistry.

Protobuf type google.cloud.iot.v1.DeleteDeviceRegistryRequest

DeleteDeviceRequest

Request for DeleteDevice.

Protobuf type google.cloud.iot.v1.DeleteDeviceRequest

DeleteDeviceRequest.Builder

Request for DeleteDevice.

Protobuf type google.cloud.iot.v1.DeleteDeviceRequest

Device

The device resource.

Protobuf type google.cloud.iot.v1.Device

Device.Builder

The device resource.

Protobuf type google.cloud.iot.v1.Device

DeviceConfig

The device configuration. Eventually delivered to devices.

Protobuf type google.cloud.iot.v1.DeviceConfig

DeviceConfig.Builder

The device configuration. Eventually delivered to devices.

Protobuf type google.cloud.iot.v1.DeviceConfig

DeviceCredential

A server-stored device credential used for authentication.

Protobuf type google.cloud.iot.v1.DeviceCredential

DeviceCredential.Builder

A server-stored device credential used for authentication.

Protobuf type google.cloud.iot.v1.DeviceCredential

DeviceManagerClient

Service Description: Internet of Things (IoT) service. Securely connect and manage IoT devices.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeviceRegistry deviceRegistry = DeviceRegistry.newBuilder().build();
   DeviceRegistry response = deviceManagerClient.createDeviceRegistry(parent, deviceRegistry);
 }

Note: close() needs to be called on the DeviceManagerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DeviceManagerSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DeviceManagerSettings deviceManagerSettings =
     DeviceManagerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DeviceManagerClient deviceManagerClient = DeviceManagerClient.create(deviceManagerSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DeviceManagerSettings deviceManagerSettings =
     DeviceManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
 DeviceManagerClient deviceManagerClient = DeviceManagerClient.create(deviceManagerSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DeviceManagerSettings deviceManagerSettings =
     DeviceManagerSettings.newHttpJsonBuilder().build();
 DeviceManagerClient deviceManagerClient = DeviceManagerClient.create(deviceManagerSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DeviceManagerClient.ListDeviceRegistriesFixedSizeCollection

DeviceManagerClient.ListDeviceRegistriesPage

DeviceManagerClient.ListDeviceRegistriesPagedResponse