com.google.cloud.iot.v1.DeviceManagerClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-iot Show documentation
Show all versions of google-cloud-iot Show documentation
Java idiomatic client for Google Cloud IoT Core
/*
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.iot.v1;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.iot.v1.stub.DeviceManagerStub;
import com.google.cloud.iot.v1.stub.DeviceManagerStubSettings;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.protobuf.ByteString;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Internet of things (IoT) service. Allows to manipulate device registry
* instances and the registration of devices (Things) to the cloud.
*
* 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:
*
*
* - 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:
*
*
*
* 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);
*
*
*/
@Generated("by gapic-generator")
@BetaApi
public class DeviceManagerClient implements BackgroundResource {
private final DeviceManagerSettings settings;
private final DeviceManagerStub stub;
/** Constructs an instance of DeviceManagerClient with default settings. */
public static final DeviceManagerClient create() throws IOException {
return create(DeviceManagerSettings.newBuilder().build());
}
/**
* 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.
*/
public static final DeviceManagerClient create(DeviceManagerSettings settings)
throws IOException {
return new DeviceManagerClient(settings);
}
/**
* Constructs an instance of DeviceManagerClient, using the given stub for making calls. This is
* for advanced usage - prefer to use DeviceManagerSettings}.
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final DeviceManagerClient create(DeviceManagerStub stub) {
return new DeviceManagerClient(stub);
}
/**
* 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.
*/
protected DeviceManagerClient(DeviceManagerSettings settings) throws IOException {
this.settings = settings;
this.stub = ((DeviceManagerStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected DeviceManagerClient(DeviceManagerStub stub) {
this.settings = null;
this.stub = stub;
}
public final DeviceManagerSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public DeviceManagerStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param parent The project and cloud region where this device registry must be created. For
* example, `projects/example-project/locations/us-central1`.
* @param 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
*/
public final DeviceRegistry createDeviceRegistry(
LocationName parent, DeviceRegistry deviceRegistry) {
CreateDeviceRegistryRequest request =
CreateDeviceRegistryRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setDeviceRegistry(deviceRegistry)
.build();
return createDeviceRegistry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param parent The project and cloud region where this device registry must be created. For
* example, `projects/example-project/locations/us-central1`.
* @param 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
*/
public final DeviceRegistry createDeviceRegistry(String parent, DeviceRegistry deviceRegistry) {
CreateDeviceRegistryRequest request =
CreateDeviceRegistryRequest.newBuilder()
.setParent(parent)
.setDeviceRegistry(deviceRegistry)
.build();
return createDeviceRegistry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final DeviceRegistry createDeviceRegistry(CreateDeviceRegistryRequest request) {
return createDeviceRegistryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable
createDeviceRegistryCallable() {
return stub.createDeviceRegistryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Gets a device registry configuration.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* DeviceRegistry response = deviceManagerClient.getDeviceRegistry(name);
* }
*
*
* @param 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
*/
public final DeviceRegistry getDeviceRegistry(RegistryName name) {
GetDeviceRegistryRequest request =
GetDeviceRegistryRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getDeviceRegistry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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());
* }
*
*
* @param 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
*/
public final DeviceRegistry getDeviceRegistry(String name) {
GetDeviceRegistryRequest request = GetDeviceRegistryRequest.newBuilder().setName(name).build();
return getDeviceRegistry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
private final DeviceRegistry getDeviceRegistry(GetDeviceRegistryRequest request) {
return getDeviceRegistryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable getDeviceRegistryCallable() {
return stub.getDeviceRegistryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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`.
* @param 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
*/
public final DeviceRegistry updateDeviceRegistry(
DeviceRegistry deviceRegistry, FieldMask updateMask) {
UpdateDeviceRegistryRequest request =
UpdateDeviceRegistryRequest.newBuilder()
.setDeviceRegistry(deviceRegistry)
.setUpdateMask(updateMask)
.build();
return updateDeviceRegistry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final DeviceRegistry updateDeviceRegistry(UpdateDeviceRegistryRequest request) {
return updateDeviceRegistryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable
updateDeviceRegistryCallable() {
return stub.updateDeviceRegistryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes a device registry configuration.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* deviceManagerClient.deleteDeviceRegistry(name);
* }
*
*
* @param 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
*/
public final void deleteDeviceRegistry(RegistryName name) {
DeleteDeviceRegistryRequest request =
DeleteDeviceRegistryRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteDeviceRegistry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes a device registry configuration.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName name = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* deviceManagerClient.deleteDeviceRegistry(name.toString());
* }
*
*
* @param 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
*/
public final void deleteDeviceRegistry(String name) {
DeleteDeviceRegistryRequest request =
DeleteDeviceRegistryRequest.newBuilder().setName(name).build();
deleteDeviceRegistry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
private final void deleteDeviceRegistry(DeleteDeviceRegistryRequest request) {
deleteDeviceRegistryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable deleteDeviceRegistryCallable() {
return stub.deleteDeviceRegistryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*
* @param 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
*/
public final ListDeviceRegistriesPagedResponse listDeviceRegistries(LocationName parent) {
ListDeviceRegistriesRequest request =
ListDeviceRegistriesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listDeviceRegistries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*
* @param 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
*/
public final ListDeviceRegistriesPagedResponse listDeviceRegistries(String parent) {
ListDeviceRegistriesRequest request =
ListDeviceRegistriesRequest.newBuilder().setParent(parent).build();
return listDeviceRegistries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*
* @param 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
*/
public final ListDeviceRegistriesPagedResponse listDeviceRegistries(
ListDeviceRegistriesRequest request) {
return listDeviceRegistriesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
* }
*
*/
public final UnaryCallable
listDeviceRegistriesPagedCallable() {
return stub.listDeviceRegistriesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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;
* }
* }
* }
*
*/
public final UnaryCallable
listDeviceRegistriesCallable() {
return stub.listDeviceRegistriesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param parent The name of the device registry where this device should be created. For example,
* `projects/example-project/locations/us-central1/registries/my-registry`.
* @param device The device registration details. 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
*/
public final Device createDevice(RegistryName parent, Device device) {
CreateDeviceRequest request =
CreateDeviceRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setDevice(device)
.build();
return createDevice(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param parent The name of the device registry where this device should be created. For example,
* `projects/example-project/locations/us-central1/registries/my-registry`.
* @param device The device registration details. 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
*/
public final Device createDevice(String parent, Device device) {
CreateDeviceRequest request =
CreateDeviceRequest.newBuilder().setParent(parent).setDevice(device).build();
return createDevice(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Device createDevice(CreateDeviceRequest request) {
return createDeviceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable createDeviceCallable() {
return stub.createDeviceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Device getDevice(DeviceName name) {
GetDeviceRequest request =
GetDeviceRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getDevice(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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());
* }
*
*
* @param 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
*/
public final Device getDevice(String name) {
GetDeviceRequest request = GetDeviceRequest.newBuilder().setName(name).build();
return getDevice(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Device getDevice(GetDeviceRequest request) {
return getDeviceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable getDeviceCallable() {
return stub.getDeviceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param device The new values for the device registry. 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}`.
* @param 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
*/
public final Device updateDevice(Device device, FieldMask updateMask) {
UpdateDeviceRequest request =
UpdateDeviceRequest.newBuilder().setDevice(device).setUpdateMask(updateMask).build();
return updateDevice(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final Device updateDevice(UpdateDeviceRequest request) {
return updateDeviceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable updateDeviceCallable() {
return stub.updateDeviceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes a device.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* deviceManagerClient.deleteDevice(name);
* }
*
*
* @param 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
*/
public final void deleteDevice(DeviceName name) {
DeleteDeviceRequest request =
DeleteDeviceRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteDevice(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes a device.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* deviceManagerClient.deleteDevice(name.toString());
* }
*
*
* @param 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
*/
public final void deleteDevice(String name) {
DeleteDeviceRequest request = DeleteDeviceRequest.newBuilder().setName(name).build();
deleteDevice(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
private final void deleteDevice(DeleteDeviceRequest request) {
deleteDeviceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable deleteDeviceCallable() {
return stub.deleteDeviceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* List devices in a device registry.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName parent = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* for (Device element : deviceManagerClient.listDevices(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param parent The device registry path. Required. For example,
* `projects/my-project/locations/us-central1/registries/my-registry`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDevicesPagedResponse listDevices(RegistryName parent) {
ListDevicesRequest request =
ListDevicesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listDevices(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* List devices in a device registry.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName parent = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* for (Device element : deviceManagerClient.listDevices(parent.toString()).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param parent The device registry path. Required. For example,
* `projects/my-project/locations/us-central1/registries/my-registry`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDevicesPagedResponse listDevices(String parent) {
ListDevicesRequest request = ListDevicesRequest.newBuilder().setParent(parent).build();
return listDevices(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* List devices in a device registry.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName parent = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* ListDevicesRequest request = ListDevicesRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* for (Device element : deviceManagerClient.listDevices(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*
* @param 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
*/
public final ListDevicesPagedResponse listDevices(ListDevicesRequest request) {
return listDevicesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* List devices in a device registry.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName parent = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* ListDevicesRequest request = ListDevicesRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* ApiFuture<ListDevicesPagedResponse> future = deviceManagerClient.listDevicesPagedCallable().futureCall(request);
* // Do something
* for (Device element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
*
*/
public final UnaryCallable
listDevicesPagedCallable() {
return stub.listDevicesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* List devices in a device registry.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName parent = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* ListDevicesRequest request = ListDevicesRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* while (true) {
* ListDevicesResponse response = deviceManagerClient.listDevicesCallable().call(request);
* for (Device element : response.getDevicesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
*
*/
public final UnaryCallable listDevicesCallable() {
return stub.listDevicesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core
* servers. Returns the modified configuration version and its metadata.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ByteString binaryData = ByteString.copyFromUtf8("");
* DeviceConfig response = deviceManagerClient.modifyCloudToDeviceConfig(name, binaryData);
* }
*
*
* @param 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}`.
* @param binaryData The configuration data for the device.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DeviceConfig modifyCloudToDeviceConfig(DeviceName name, ByteString binaryData) {
ModifyCloudToDeviceConfigRequest request =
ModifyCloudToDeviceConfigRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setBinaryData(binaryData)
.build();
return modifyCloudToDeviceConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core
* servers. Returns the modified configuration version and its metadata.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ByteString binaryData = ByteString.copyFromUtf8("");
* DeviceConfig response = deviceManagerClient.modifyCloudToDeviceConfig(name.toString(), binaryData);
* }
*
*
* @param 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}`.
* @param binaryData The configuration data for the device.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DeviceConfig modifyCloudToDeviceConfig(String name, ByteString binaryData) {
ModifyCloudToDeviceConfigRequest request =
ModifyCloudToDeviceConfigRequest.newBuilder()
.setName(name)
.setBinaryData(binaryData)
.build();
return modifyCloudToDeviceConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core
* servers. Returns the modified configuration version and its metadata.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ByteString binaryData = ByteString.copyFromUtf8("");
* ModifyCloudToDeviceConfigRequest request = ModifyCloudToDeviceConfigRequest.newBuilder()
* .setName(name.toString())
* .setBinaryData(binaryData)
* .build();
* DeviceConfig response = deviceManagerClient.modifyCloudToDeviceConfig(request);
* }
*
*
* @param 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
*/
public final DeviceConfig modifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request) {
return modifyCloudToDeviceConfigCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core
* servers. Returns the modified configuration version and its metadata.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ByteString binaryData = ByteString.copyFromUtf8("");
* ModifyCloudToDeviceConfigRequest request = ModifyCloudToDeviceConfigRequest.newBuilder()
* .setName(name.toString())
* .setBinaryData(binaryData)
* .build();
* ApiFuture<DeviceConfig> future = deviceManagerClient.modifyCloudToDeviceConfigCallable().futureCall(request);
* // Do something
* DeviceConfig response = future.get();
* }
*
*/
public final UnaryCallable
modifyCloudToDeviceConfigCallable() {
return stub.modifyCloudToDeviceConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Lists the last few versions of the device configuration in descending order (i.e.: newest
* first).
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ListDeviceConfigVersionsResponse response = deviceManagerClient.listDeviceConfigVersions(name);
* }
*
*
* @param 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
*/
public final ListDeviceConfigVersionsResponse listDeviceConfigVersions(DeviceName name) {
ListDeviceConfigVersionsRequest request =
ListDeviceConfigVersionsRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return listDeviceConfigVersions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Lists the last few versions of the device configuration in descending order (i.e.: newest
* first).
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ListDeviceConfigVersionsResponse response = deviceManagerClient.listDeviceConfigVersions(name.toString());
* }
*
*
* @param 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
*/
public final ListDeviceConfigVersionsResponse listDeviceConfigVersions(String name) {
ListDeviceConfigVersionsRequest request =
ListDeviceConfigVersionsRequest.newBuilder().setName(name).build();
return listDeviceConfigVersions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Lists the last few versions of the device configuration in descending order (i.e.: newest
* first).
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ListDeviceConfigVersionsRequest request = ListDeviceConfigVersionsRequest.newBuilder()
* .setName(name.toString())
* .build();
* ListDeviceConfigVersionsResponse response = deviceManagerClient.listDeviceConfigVersions(request);
* }
*
*
* @param 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
*/
public final ListDeviceConfigVersionsResponse listDeviceConfigVersions(
ListDeviceConfigVersionsRequest request) {
return listDeviceConfigVersionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Lists the last few versions of the device configuration in descending order (i.e.: newest
* first).
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ListDeviceConfigVersionsRequest request = ListDeviceConfigVersionsRequest.newBuilder()
* .setName(name.toString())
* .build();
* ApiFuture<ListDeviceConfigVersionsResponse> future = deviceManagerClient.listDeviceConfigVersionsCallable().futureCall(request);
* // Do something
* ListDeviceConfigVersionsResponse response = future.get();
* }
*
*/
public final UnaryCallable
listDeviceConfigVersionsCallable() {
return stub.listDeviceConfigVersionsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Lists the last few versions of the device state in descending order (i.e.: newest first).
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ListDeviceStatesResponse response = deviceManagerClient.listDeviceStates(name);
* }
*
*
* @param 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
*/
public final ListDeviceStatesResponse listDeviceStates(DeviceName name) {
ListDeviceStatesRequest request =
ListDeviceStatesRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return listDeviceStates(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Lists the last few versions of the device state in descending order (i.e.: newest first).
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ListDeviceStatesResponse response = deviceManagerClient.listDeviceStates(name.toString());
* }
*
*
* @param 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
*/
public final ListDeviceStatesResponse listDeviceStates(String name) {
ListDeviceStatesRequest request = ListDeviceStatesRequest.newBuilder().setName(name).build();
return listDeviceStates(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Lists the last few versions of the device state in descending order (i.e.: newest first).
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ListDeviceStatesRequest request = ListDeviceStatesRequest.newBuilder()
* .setName(name.toString())
* .build();
* ListDeviceStatesResponse response = deviceManagerClient.listDeviceStates(request);
* }
*
*
* @param 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
*/
public final ListDeviceStatesResponse listDeviceStates(ListDeviceStatesRequest request) {
return listDeviceStatesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Lists the last few versions of the device state in descending order (i.e.: newest first).
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* DeviceName name = DeviceName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]", "[DEVICE]");
* ListDeviceStatesRequest request = ListDeviceStatesRequest.newBuilder()
* .setName(name.toString())
* .build();
* ApiFuture<ListDeviceStatesResponse> future = deviceManagerClient.listDeviceStatesCallable().futureCall(request);
* // Do something
* ListDeviceStatesResponse response = future.get();
* }
*
*/
public final UnaryCallable
listDeviceStatesCallable() {
return stub.listDeviceStatesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* Policy policy = Policy.newBuilder().build();
* Policy response = deviceManagerClient.setIamPolicy(resource, policy);
* }
*
*
* @param resource REQUIRED: The resource for which the policy is being specified. `resource` is
* usually specified as a path. For example, a Project resource is specified as
* `projects/{project}`.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
* policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
* Platform services (such as Projects) might reject them.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(RegistryName resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.setPolicy(policy)
.build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* Policy policy = Policy.newBuilder().build();
* Policy response = deviceManagerClient.setIamPolicy(resource.toString(), policy);
* }
*
*
* @param resource REQUIRED: The resource for which the policy is being specified. `resource` is
* usually specified as a path. For example, a Project resource is specified as
* `projects/{project}`.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
* policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
* Platform services (such as Projects) might reject them.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(String resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder().setResource(resource).setPolicy(policy).build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* ResourceName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* Policy policy = Policy.newBuilder().build();
* SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
* .setResource(resource.toString())
* .setPolicy(policy)
* .build();
* Policy response = deviceManagerClient.setIamPolicy(request);
* }
*
*
* @param 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
*/
public final Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* ResourceName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* Policy policy = Policy.newBuilder().build();
* SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
* .setResource(resource.toString())
* .setPolicy(policy)
* .build();
* ApiFuture<Policy> future = deviceManagerClient.setIamPolicyCallable().futureCall(request);
* // Do something
* Policy response = future.get();
* }
*
*/
public final UnaryCallable setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* Policy response = deviceManagerClient.getIamPolicy(resource);
* }
*
*
* @param resource REQUIRED: The resource for which the policy is being requested. `resource` is
* usually specified as a path. For example, a Project resource is specified as
* `projects/{project}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(RegistryName resource) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* Policy response = deviceManagerClient.getIamPolicy(resource.toString());
* }
*
*
* @param resource REQUIRED: The resource for which the policy is being requested. `resource` is
* usually specified as a path. For example, a Project resource is specified as
* `projects/{project}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(String resource) {
GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder().setResource(resource).build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* ResourceName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
* .setResource(resource.toString())
* .build();
* Policy response = deviceManagerClient.getIamPolicy(request);
* }
*
*
* @param 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
*/
private final Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* ResourceName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
* .setResource(resource.toString())
* .build();
* ApiFuture<Policy> future = deviceManagerClient.getIamPolicyCallable().futureCall(request);
* // Do something
* Policy response = future.get();
* }
*
*/
public final UnaryCallable getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns permissions that a caller has on the specified resource. If the resource does not
* exist, this will return an empty set of permissions, not a NOT_FOUND error.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* List<String> permissions = new ArrayList<>();
* TestIamPermissionsResponse response = deviceManagerClient.testIamPermissions(resource, permissions);
* }
*
*
* @param resource REQUIRED: The resource for which the policy detail is being requested.
* `resource` is usually specified as a path. For example, a Project resource is specified as
* `projects/{project}`.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
RegistryName resource, List permissions) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.addAllPermissions(permissions)
.build();
return testIamPermissions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns permissions that a caller has on the specified resource. If the resource does not
* exist, this will return an empty set of permissions, not a NOT_FOUND error.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* RegistryName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* List<String> permissions = new ArrayList<>();
* TestIamPermissionsResponse response = deviceManagerClient.testIamPermissions(resource.toString(), permissions);
* }
*
*
* @param resource REQUIRED: The resource for which the policy detail is being requested.
* `resource` is usually specified as a path. For example, a Project resource is specified as
* `projects/{project}`.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
String resource, List permissions) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(resource)
.addAllPermissions(permissions)
.build();
return testIamPermissions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns permissions that a caller has on the specified resource. If the resource does not
* exist, this will return an empty set of permissions, not a NOT_FOUND error.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* ResourceName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* List<String> permissions = new ArrayList<>();
* TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
* .setResource(resource.toString())
* .addAllPermissions(permissions)
* .build();
* TestIamPermissionsResponse response = deviceManagerClient.testIamPermissions(request);
* }
*
*
* @param 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
*/
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns permissions that a caller has on the specified resource. If the resource does not
* exist, this will return an empty set of permissions, not a NOT_FOUND error.
*
* Sample code:
*
*
* try (DeviceManagerClient deviceManagerClient = DeviceManagerClient.create()) {
* ResourceName resource = RegistryName.of("[PROJECT]", "[LOCATION]", "[REGISTRY]");
* List<String> permissions = new ArrayList<>();
* TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
* .setResource(resource.toString())
* .addAllPermissions(permissions)
* .build();
* ApiFuture<TestIamPermissionsResponse> future = deviceManagerClient.testIamPermissionsCallable().futureCall(request);
* // Do something
* TestIamPermissionsResponse response = future.get();
* }
*
*/
public final UnaryCallable
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListDeviceRegistriesPagedResponse
extends AbstractPagedListResponse<
ListDeviceRegistriesRequest, ListDeviceRegistriesResponse, DeviceRegistry,
ListDeviceRegistriesPage, ListDeviceRegistriesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListDeviceRegistriesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
new ApiFunction() {
@Override
public ListDeviceRegistriesPagedResponse apply(ListDeviceRegistriesPage input) {
return new ListDeviceRegistriesPagedResponse(input);
}
});
}
private ListDeviceRegistriesPagedResponse(ListDeviceRegistriesPage page) {
super(page, ListDeviceRegistriesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListDeviceRegistriesPage
extends AbstractPage<
ListDeviceRegistriesRequest, ListDeviceRegistriesResponse, DeviceRegistry,
ListDeviceRegistriesPage> {
private ListDeviceRegistriesPage(
PageContext
context,
ListDeviceRegistriesResponse response) {
super(context, response);
}
private static ListDeviceRegistriesPage createEmptyPage() {
return new ListDeviceRegistriesPage(null, null);
}
@Override
protected ListDeviceRegistriesPage createPage(
PageContext
context,
ListDeviceRegistriesResponse response) {
return new ListDeviceRegistriesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListDeviceRegistriesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListDeviceRegistriesRequest, ListDeviceRegistriesResponse, DeviceRegistry,
ListDeviceRegistriesPage, ListDeviceRegistriesFixedSizeCollection> {
private ListDeviceRegistriesFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListDeviceRegistriesFixedSizeCollection createEmptyCollection() {
return new ListDeviceRegistriesFixedSizeCollection(null, 0);
}
@Override
protected ListDeviceRegistriesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListDeviceRegistriesFixedSizeCollection(pages, collectionSize);
}
}
public static class ListDevicesPagedResponse
extends AbstractPagedListResponse<
ListDevicesRequest, ListDevicesResponse, Device, ListDevicesPage,
ListDevicesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListDevicesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
new ApiFunction() {
@Override
public ListDevicesPagedResponse apply(ListDevicesPage input) {
return new ListDevicesPagedResponse(input);
}
});
}
private ListDevicesPagedResponse(ListDevicesPage page) {
super(page, ListDevicesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListDevicesPage
extends AbstractPage {
private ListDevicesPage(
PageContext context,
ListDevicesResponse response) {
super(context, response);
}
private static ListDevicesPage createEmptyPage() {
return new ListDevicesPage(null, null);
}
@Override
protected ListDevicesPage createPage(
PageContext context,
ListDevicesResponse response) {
return new ListDevicesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListDevicesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListDevicesRequest, ListDevicesResponse, Device, ListDevicesPage,
ListDevicesFixedSizeCollection> {
private ListDevicesFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListDevicesFixedSizeCollection createEmptyCollection() {
return new ListDevicesFixedSizeCollection(null, 0);
}
@Override
protected ListDevicesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListDevicesFixedSizeCollection(pages, collectionSize);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy