DeviceManagerClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.iot.v1.DeviceManagerClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class DeviceManagerClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
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:
```
 
 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:
1. 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.
2. 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.
3. 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:
```
 
 DeviceManagerSettings deviceManagerSettings =
     DeviceManagerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DeviceManagerClient deviceManagerClient =
     DeviceManagerClient.create(deviceManagerSettings);
 
 
```
To customize the endpoint:
```
 
 DeviceManagerSettings deviceManagerSettings =
     DeviceManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
 DeviceManagerClient deviceManagerClient =
     DeviceManagerClient.create(deviceManagerSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DeviceManagerClient.ListDeviceRegistriesFixedSizeCollection`
`static class`	`DeviceManagerClient.ListDeviceRegistriesPage`
`static class`	`DeviceManagerClient.ListDeviceRegistriesPagedResponse`
`static class`	`DeviceManagerClient.ListDevicesFixedSizeCollection`
`static class`	`DeviceManagerClient.ListDevicesPage`
`static class`	`DeviceManagerClient.ListDevicesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DeviceManagerClient(DeviceManagerSettings settings)` Constructs an instance of DeviceManagerClient, using the given settings.
`protected`	`DeviceManagerClient(DeviceManagerStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`BindDeviceToGatewayResponse`	`bindDeviceToGateway(BindDeviceToGatewayRequest request)` Associates the device with the gateway.
`BindDeviceToGatewayResponse`	`bindDeviceToGateway(RegistryName parent, String gatewayId, String deviceId)` Associates the device with the gateway.
`BindDeviceToGatewayResponse`	`bindDeviceToGateway(String parent, String gatewayId, String deviceId)` Associates the device with the gateway.
`com.google.api.gax.rpc.UnaryCallable<BindDeviceToGatewayRequest,BindDeviceToGatewayResponse>`	`bindDeviceToGatewayCallable()` Associates the device with the gateway.
`void`	`close()`
`static DeviceManagerClient`	`create()` Constructs an instance of DeviceManagerClient with default settings.
`static DeviceManagerClient`	`create(DeviceManagerSettings settings)` Constructs an instance of DeviceManagerClient, using the given settings.
`static DeviceManagerClient`	`create(DeviceManagerStub stub)` Constructs an instance of DeviceManagerClient, using the given stub for making calls.
`Device`	`createDevice(CreateDeviceRequest request)` Creates a device in a device registry.
`Device`	`createDevice(RegistryName parent, Device device)` Creates a device in a device registry.
`Device`	`createDevice(String parent, Device device)` Creates a device in a device registry.
`com.google.api.gax.rpc.UnaryCallable<CreateDeviceRequest,Device>`	`createDeviceCallable()` Creates a device in a device registry.
`DeviceRegistry`	`createDeviceRegistry(CreateDeviceRegistryRequest request)` Creates a device registry that contains devices.
`DeviceRegistry`	`createDeviceRegistry(LocationName parent, DeviceRegistry deviceRegistry)` Creates a device registry that contains devices.
`DeviceRegistry`	`createDeviceRegistry(String parent, DeviceRegistry deviceRegistry)` Creates a device registry that contains devices.
`com.google.api.gax.rpc.UnaryCallable<CreateDeviceRegistryRequest,DeviceRegistry>`	`createDeviceRegistryCallable()` Creates a device registry that contains devices.
`void`	`deleteDevice(DeleteDeviceRequest request)` Deletes a device.
`void`	`deleteDevice(DeviceName name)` Deletes a device.
`void`	`deleteDevice(String name)` Deletes a device.
`com.google.api.gax.rpc.UnaryCallable<DeleteDeviceRequest,Empty>`	`deleteDeviceCallable()` Deletes a device.
`void`	`deleteDeviceRegistry(DeleteDeviceRegistryRequest request)` Deletes a device registry configuration.
`void`	`deleteDeviceRegistry(RegistryName name)` Deletes a device registry configuration.
`void`	`deleteDeviceRegistry(String name)` Deletes a device registry configuration.
`com.google.api.gax.rpc.UnaryCallable<DeleteDeviceRegistryRequest,Empty>`	`deleteDeviceRegistryCallable()` Deletes a device registry configuration.
`Device`	`getDevice(DeviceName name)` Gets details about a device.
`Device`	`getDevice(GetDeviceRequest request)` Gets details about a device.
`Device`	`getDevice(String name)` Gets details about a device.
`com.google.api.gax.rpc.UnaryCallable<GetDeviceRequest,Device>`	`getDeviceCallable()` Gets details about a device.
`DeviceRegistry`	`getDeviceRegistry(GetDeviceRegistryRequest request)` Gets a device registry configuration.
`DeviceRegistry`	`getDeviceRegistry(RegistryName name)` Gets a device registry configuration.
`DeviceRegistry`	`getDeviceRegistry(String name)` Gets a device registry configuration.
`com.google.api.gax.rpc.UnaryCallable<GetDeviceRegistryRequest,DeviceRegistry>`	`getDeviceRegistryCallable()` Gets a device registry configuration.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.iam.v1.Policy`	`getIamPolicy(RegistryName resource)` Gets the access control policy for a resource.
`com.google.iam.v1.Policy`	`getIamPolicy(String resource)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`DeviceManagerSettings`	`getSettings()`
`DeviceManagerStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ListDeviceConfigVersionsResponse`	`listDeviceConfigVersions(DeviceName name)` Lists the last few versions of the device configuration in descending order (i.e.: newest first).
`ListDeviceConfigVersionsResponse`	`listDeviceConfigVersions(ListDeviceConfigVersionsRequest request)` Lists the last few versions of the device configuration in descending order (i.e.: newest first).
`ListDeviceConfigVersionsResponse`	`listDeviceConfigVersions(String name)` Lists the last few versions of the device configuration in descending order (i.e.: newest first).
`com.google.api.gax.rpc.UnaryCallable<ListDeviceConfigVersionsRequest,ListDeviceConfigVersionsResponse>`	`listDeviceConfigVersionsCallable()` Lists the last few versions of the device configuration in descending order (i.e.: newest first).
`DeviceManagerClient.ListDeviceRegistriesPagedResponse`	`listDeviceRegistries(ListDeviceRegistriesRequest request)` Lists device registries.
`DeviceManagerClient.ListDeviceRegistriesPagedResponse`	`listDeviceRegistries(LocationName parent)` Lists device registries.
`DeviceManagerClient.ListDeviceRegistriesPagedResponse`	`listDeviceRegistries(String parent)` Lists device registries.
`com.google.api.gax.rpc.UnaryCallable<ListDeviceRegistriesRequest,ListDeviceRegistriesResponse>`	`listDeviceRegistriesCallable()` Lists device registries.
`com.google.api.gax.rpc.UnaryCallable<ListDeviceRegistriesRequest,DeviceManagerClient.ListDeviceRegistriesPagedResponse>`	`listDeviceRegistriesPagedCallable()` Lists device registries.
`DeviceManagerClient.ListDevicesPagedResponse`	`listDevices(ListDevicesRequest request)` List devices in a device registry.
`DeviceManagerClient.ListDevicesPagedResponse`	`listDevices(RegistryName parent)` List devices in a device registry.
`DeviceManagerClient.ListDevicesPagedResponse`	`listDevices(String parent)` List devices in a device registry.
`com.google.api.gax.rpc.UnaryCallable<ListDevicesRequest,ListDevicesResponse>`	`listDevicesCallable()` List devices in a device registry.
`com.google.api.gax.rpc.UnaryCallable<ListDevicesRequest,DeviceManagerClient.ListDevicesPagedResponse>`	`listDevicesPagedCallable()` List devices in a device registry.
`ListDeviceStatesResponse`	`listDeviceStates(DeviceName name)` Lists the last few versions of the device state in descending order (i.e.: newest first).
`ListDeviceStatesResponse`	`listDeviceStates(ListDeviceStatesRequest request)` Lists the last few versions of the device state in descending order (i.e.: newest first).
`ListDeviceStatesResponse`	`listDeviceStates(String name)` Lists the last few versions of the device state in descending order (i.e.: newest first).
`com.google.api.gax.rpc.UnaryCallable<ListDeviceStatesRequest,ListDeviceStatesResponse>`	`listDeviceStatesCallable()` Lists the last few versions of the device state in descending order (i.e.: newest first).
`DeviceConfig`	`modifyCloudToDeviceConfig(DeviceName name, ByteString binaryData)` Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers.
`DeviceConfig`	`modifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request)` Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers.
`DeviceConfig`	`modifyCloudToDeviceConfig(String name, ByteString binaryData)` Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers.
`com.google.api.gax.rpc.UnaryCallable<ModifyCloudToDeviceConfigRequest,DeviceConfig>`	`modifyCloudToDeviceConfigCallable()` Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers.
`SendCommandToDeviceResponse`	`sendCommandToDevice(DeviceName name, ByteString binaryData, String subfolder)` Sends a command to the specified device.
`SendCommandToDeviceResponse`	`sendCommandToDevice(SendCommandToDeviceRequest request)` Sends a command to the specified device.
`SendCommandToDeviceResponse`	`sendCommandToDevice(String name, ByteString binaryData, String subfolder)` Sends a command to the specified device.
`com.google.api.gax.rpc.UnaryCallable<SendCommandToDeviceRequest,SendCommandToDeviceResponse>`	`sendCommandToDeviceCallable()` Sends a command to the specified device.
`com.google.iam.v1.Policy`	`setIamPolicy(RegistryName resource, com.google.iam.v1.Policy policy)` Sets the access control policy on the specified resource.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.iam.v1.Policy`	`setIamPolicy(String resource, com.google.iam.v1.Policy policy)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(RegistryName resource, List<String> permissions)` Returns permissions that a caller has on the specified resource.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(String resource, List<String> permissions)` Returns permissions that a caller has on the specified resource.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`UnbindDeviceFromGatewayResponse`	`unbindDeviceFromGateway(RegistryName parent, String gatewayId, String deviceId)` Deletes the association between the device and the gateway.
`UnbindDeviceFromGatewayResponse`	`unbindDeviceFromGateway(String parent, String gatewayId, String deviceId)` Deletes the association between the device and the gateway.
`UnbindDeviceFromGatewayResponse`	`unbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request)` Deletes the association between the device and the gateway.
`com.google.api.gax.rpc.UnaryCallable<UnbindDeviceFromGatewayRequest,UnbindDeviceFromGatewayResponse>`	`unbindDeviceFromGatewayCallable()` Deletes the association between the device and the gateway.
`Device`	`updateDevice(Device device, FieldMask updateMask)` Updates a device.
`Device`	`updateDevice(UpdateDeviceRequest request)` Updates a device.
`com.google.api.gax.rpc.UnaryCallable<UpdateDeviceRequest,Device>`	`updateDeviceCallable()` Updates a device.
`DeviceRegistry`	`updateDeviceRegistry(DeviceRegistry deviceRegistry, FieldMask updateMask)` Updates a device registry configuration.
`DeviceRegistry`	`updateDeviceRegistry(UpdateDeviceRegistryRequest request)` Updates a device registry configuration.
`com.google.api.gax.rpc.UnaryCallable<UpdateDeviceRegistryRequest,DeviceRegistry>`	`updateDeviceRegistryCallable()` Updates a device registry configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DeviceManagerClient
```
protected DeviceManagerClient(DeviceManagerSettings settings)
                       throws IOException
```
  Constructs an instance of DeviceManagerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- DeviceManagerClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected DeviceManagerClient(DeviceManagerStub stub)
```

Method Detail

create

public static final DeviceManagerClient create()
                                        throws IOException

Constructs an instance of DeviceManagerClient with default settings.

Throws:: IOException

create
```
public static final DeviceManagerClient create(DeviceManagerSettings settings)
                                        throws IOException
```
Constructs an instance of DeviceManagerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final DeviceManagerClient create(DeviceManagerStub stub)

Constructs an instance of DeviceManagerClient, using the given stub for making calls. This is for advanced usage - prefer to use DeviceManagerSettings}.

getSettings

public final DeviceManagerSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public DeviceManagerStub getStub()

createDeviceRegistry

public final DeviceRegistry createDeviceRegistry(LocationName parent,
                                                 DeviceRegistry deviceRegistry)

Creates a device registry that contains devices.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeviceRegistry deviceRegistry = DeviceRegistry.newBuilder().build();
   DeviceRegistry response = deviceManagerClient.createDeviceRegistry(parent, deviceRegistry);
 }

Parameters:: parent - The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`.; deviceRegistry - The device registry. The field `name` must be empty. The server will generate that field from the device registry `id` provided and the `parent` field.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createDeviceRegistry

public final DeviceRegistry createDeviceRegistry(String parent,
                                                 DeviceRegistry deviceRegistry)

Creates a device registry that contains devices.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeviceRegistry deviceRegistry = DeviceRegistry.newBuilder().build();
   DeviceRegistry response = deviceManagerClient.createDeviceRegistry(parent.toString(), deviceRegistry);
 }

Parameters:: parent - The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`.; deviceRegistry - The device registry. The field `name` must be empty. The server will generate that field from the device registry `id` provided and the `parent` field.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createDeviceRegistry

public final DeviceRegistry createDeviceRegistry(CreateDeviceRegistryRequest request)

Creates a device registry that contains devices.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeviceRegistry deviceRegistry = DeviceRegistry.newBuilder().build();
   CreateDeviceRegistryRequest request = CreateDeviceRegistryRequest.newBuilder()
     .setParent(parent.toString())
     .setDeviceRegistry(deviceRegistry)
     .build();
   DeviceRegistry response = deviceManagerClient.createDeviceRegistry(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createDeviceRegistryCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateDeviceRegistryRequest,DeviceRegistry> createDeviceRegistryCallable()

Creates a device registry that contains devices.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DeviceRegistry deviceRegistry = DeviceRegistry.newBuilder().build();
   CreateDeviceRegistryRequest request = CreateDeviceRegistryRequest.newBuilder()
     .setParent(parent.toString())
     .setDeviceRegistry(deviceRegistry)
     .build();
   ApiFuture<DeviceRegistry> future = deviceManagerClient.createDeviceRegistryCallable().futureCall(request);
   // Do something
   DeviceRegistry response = future.get();
 }

getDeviceRegistry

public final DeviceRegistry getDeviceRegistry(RegistryName name)

Gets a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   DeviceRegistry response = deviceManagerClient.getDeviceRegistry(name);
 }

Parameters:: name - The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDeviceRegistry

public final DeviceRegistry getDeviceRegistry(String name)

Gets a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   DeviceRegistry response = deviceManagerClient.getDeviceRegistry(name.toString());
 }

Parameters:: name - The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDeviceRegistry

public final DeviceRegistry getDeviceRegistry(GetDeviceRegistryRequest request)

Gets a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   GetDeviceRegistryRequest request = GetDeviceRegistryRequest.newBuilder()
     .setName(name.toString())
     .build();
   DeviceRegistry response = deviceManagerClient.getDeviceRegistry(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDeviceRegistryCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDeviceRegistryRequest,DeviceRegistry> getDeviceRegistryCallable()

Gets a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   GetDeviceRegistryRequest request = GetDeviceRegistryRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<DeviceRegistry> future = deviceManagerClient.getDeviceRegistryCallable().futureCall(request);
   // Do something
   DeviceRegistry response = future.get();
 }

updateDeviceRegistry
```
public final DeviceRegistry updateDeviceRegistry(DeviceRegistry deviceRegistry,
                                                 FieldMask updateMask)
```
Updates a device registry configuration.
Sample code:
```
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceRegistry deviceRegistry = DeviceRegistry.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DeviceRegistry response = deviceManagerClient.updateDeviceRegistry(deviceRegistry, updateMask);
 }
 
```
Parameters:

deviceRegistry - The new values for the device registry. The `id` field must be empty, and the `name` field must indicate the path of the resource. For example, `projects/example-project/locations/us-central1/registries/my-registry`.

updateMask - Only updates the `device_registry` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `event_notification_config`, `http_config`, `mqtt_config`, and `state_notification_config`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateDeviceRegistry

public final DeviceRegistry updateDeviceRegistry(UpdateDeviceRegistryRequest request)

Updates a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceRegistry deviceRegistry = DeviceRegistry.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateDeviceRegistryRequest request = UpdateDeviceRegistryRequest.newBuilder()
     .setDeviceRegistry(deviceRegistry)
     .setUpdateMask(updateMask)
     .build();
   DeviceRegistry response = deviceManagerClient.updateDeviceRegistry(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateDeviceRegistryCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateDeviceRegistryRequest,DeviceRegistry> updateDeviceRegistryCallable()

Updates a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceRegistry deviceRegistry = DeviceRegistry.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateDeviceRegistryRequest request = UpdateDeviceRegistryRequest.newBuilder()
     .setDeviceRegistry(deviceRegistry)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<DeviceRegistry> future = deviceManagerClient.updateDeviceRegistryCallable().futureCall(request);
   // Do something
   DeviceRegistry response = future.get();
 }

deleteDeviceRegistry

public final void deleteDeviceRegistry(RegistryName name)

Deletes a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   deviceManagerClient.deleteDeviceRegistry(name);
 }

Parameters:: name - The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDeviceRegistry

public final void deleteDeviceRegistry(String name)

Deletes a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   deviceManagerClient.deleteDeviceRegistry(name.toString());
 }

Parameters:: name - The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDeviceRegistry

public final void deleteDeviceRegistry(DeleteDeviceRegistryRequest request)

Deletes a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   DeleteDeviceRegistryRequest request = DeleteDeviceRegistryRequest.newBuilder()
     .setName(name.toString())
     .build();
   deviceManagerClient.deleteDeviceRegistry(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDeviceRegistryCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteDeviceRegistryRequest,Empty> deleteDeviceRegistryCallable()

Deletes a device registry configuration.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   DeleteDeviceRegistryRequest request = DeleteDeviceRegistryRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = deviceManagerClient.deleteDeviceRegistryCallable().futureCall(request);
   // Do something
   future.get();
 }

listDeviceRegistries

public final DeviceManagerClient.ListDeviceRegistriesPagedResponse listDeviceRegistries(LocationName parent)

Lists device registries.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DeviceRegistry element : deviceManagerClient.listDeviceRegistries(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - The project and cloud region path. For example, `projects/example-project/locations/us-central1`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDeviceRegistries

public final DeviceManagerClient.ListDeviceRegistriesPagedResponse listDeviceRegistries(String parent)

Lists device registries.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DeviceRegistry element : deviceManagerClient.listDeviceRegistries(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - The project and cloud region path. For example, `projects/example-project/locations/us-central1`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDeviceRegistries

public final DeviceManagerClient.ListDeviceRegistriesPagedResponse listDeviceRegistries(ListDeviceRegistriesRequest request)

Lists device registries.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListDeviceRegistriesRequest request = ListDeviceRegistriesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (DeviceRegistry element : deviceManagerClient.listDeviceRegistries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDeviceRegistriesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDeviceRegistriesRequest,DeviceManagerClient.ListDeviceRegistriesPagedResponse> listDeviceRegistriesPagedCallable()

Lists device registries.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListDeviceRegistriesRequest request = ListDeviceRegistriesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListDeviceRegistriesPagedResponse> future = deviceManagerClient.listDeviceRegistriesPagedCallable().futureCall(request);
   // Do something
   for (DeviceRegistry element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listDeviceRegistriesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDeviceRegistriesRequest,ListDeviceRegistriesResponse> listDeviceRegistriesCallable()

Lists device registries.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListDeviceRegistriesRequest request = ListDeviceRegistriesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListDeviceRegistriesResponse response = deviceManagerClient.listDeviceRegistriesCallable().call(request);
     for (DeviceRegistry element : response.getDeviceRegistriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

createDevice
```
public final Device createDevice(RegistryName parent,
                                 Device device)
```
Creates a device in a device registry.
Sample code:
```
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName parent = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   Device device = Device.newBuilder().build();
   Device response = deviceManagerClient.createDevice(parent, device);
 }
 
```
Parameters:

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

device - The device registration details. The field `name` must be empty. The server generates `name` from the device registry `id` and the `parent` field.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDevice
```
public final Device createDevice(String parent,
                                 Device device)
```
Creates a device in a device registry.
Sample code:
```
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName parent = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   Device device = Device.newBuilder().build();
   Device response = deviceManagerClient.createDevice(parent.toString(), device);
 }
 
```
Parameters:

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

device - The device registration details. The field `name` must be empty. The server generates `name` from the device registry `id` and the `parent` field.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDevice

public final Device createDevice(CreateDeviceRequest request)

Creates a device in a device registry.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName parent = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   Device device = Device.newBuilder().build();
   CreateDeviceRequest request = CreateDeviceRequest.newBuilder()
     .setParent(parent.toString())
     .setDevice(device)
     .build();
   Device response = deviceManagerClient.createDevice(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createDeviceCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateDeviceRequest,Device> createDeviceCallable()

Creates a device in a device registry.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   RegistryName parent = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
   Device device = Device.newBuilder().build();
   CreateDeviceRequest request = CreateDeviceRequest.newBuilder()
     .setParent(parent.toString())
     .setDevice(device)
     .build();
   ApiFuture<Device> future = deviceManagerClient.createDeviceCallable().futureCall(request);
   // Do something
   Device response = future.get();
 }

getDevice
```
public final Device getDevice(DeviceName name)
```
Gets details about a device.
Sample code:
```
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
   Device response = deviceManagerClient.getDevice(name);
 }
 
```
Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDevice
```
public final Device getDevice(String name)
```
Gets details about a device.
Sample code:
```
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
   Device response = deviceManagerClient.getDevice(name.toString());
 }
 
```
Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDevice

public final Device getDevice(GetDeviceRequest request)

Gets details about a device.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
   GetDeviceRequest request = GetDeviceRequest.newBuilder()
     .setName(name.toString())
     .build();
   Device response = deviceManagerClient.getDevice(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDeviceCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDeviceRequest,Device> getDeviceCallable()

Gets details about a device.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
   GetDeviceRequest request = GetDeviceRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Device> future = deviceManagerClient.getDeviceCallable().futureCall(request);
   // Do something
   Device response = future.get();
 }

updateDevice
```
public final Device updateDevice(Device device,
                                 FieldMask updateMask)
```
Updates a device.
Sample code:
```
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   Device device = Device.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Device response = deviceManagerClient.updateDevice(device, updateMask);
 }
 
```
Parameters:

device - The new values for the device. The `id` and `num_id` fields must be empty, and the field `name` must specify the name path. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0`or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.

updateMask - Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateDevice

public final Device updateDevice(UpdateDeviceRequest request)

Updates a device.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   Device device = Device.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateDeviceRequest request = UpdateDeviceRequest.newBuilder()
     .setDevice(device)
     .setUpdateMask(updateMask)
     .build();
   Device response = deviceManagerClient.updateDevice(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateDeviceCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateDeviceRequest,Device> updateDeviceCallable()

Updates a device.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   Device device = Device.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateDeviceRequest request = UpdateDeviceRequest.newBuilder()
     .setDevice(device)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<Device> future = deviceManagerClient.updateDeviceCallable().futureCall(request);
   // Do something
   Device response = future.get();
 }

deleteDevice
```
public final void deleteDevice(DeviceName name)
```
Deletes a device.
Sample code:
```
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
   deviceManagerClient.deleteDevice(name);
 }
 
```
Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDevice
```
public final void deleteDevice(String name)
```
Deletes a device.
Sample code:
```
 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
   deviceManagerClient.deleteDevice(name.toString());
 }
 
```
Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDevice

public final void deleteDevice(DeleteDeviceRequest request)

Deletes a device.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
   DeleteDeviceRequest request = DeleteDeviceRequest.newBuilder()
     .setName(name.toString())
     .build();
   deviceManagerClient.deleteDevice(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDeviceCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteDeviceRequest,Empty> deleteDeviceCallable()

Deletes a device.

Sample code:


 try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
   DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
   DeleteDeviceRequest request = DeleteDeviceRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = deviceManagerClient.deleteDeviceCallable().futureCall(request);
   // Do something
   future.get();
 }