Class DeviceManagerGrpc.DeviceManagerFutureStub (2.45.0)

public static final class DeviceManagerGrpc.DeviceManagerFutureStub extends AbstractFutureStub<DeviceManagerGrpc.DeviceManagerFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service DeviceManager.

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DeviceManagerGrpc.DeviceManagerFutureStub

Methods

bindDeviceToGateway(BindDeviceToGatewayRequest request)

public ListenableFuture<BindDeviceToGatewayResponse> bindDeviceToGateway(BindDeviceToGatewayRequest request)

Associates the device with the gateway.

Parameter
Name Description
request BindDeviceToGatewayRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BindDeviceToGatewayResponse>

build(Channel channel, CallOptions callOptions)

protected DeviceManagerGrpc.DeviceManagerFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
DeviceManagerGrpc.DeviceManagerFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDevice(CreateDeviceRequest request)

public ListenableFuture<Device> createDevice(CreateDeviceRequest request)

Creates a device in a device registry.

Parameter
Name Description
request CreateDeviceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Device>

createDeviceRegistry(CreateDeviceRegistryRequest request)

public ListenableFuture<DeviceRegistry> createDeviceRegistry(CreateDeviceRegistryRequest request)

Creates a device registry that contains devices.

Parameter
Name Description
request CreateDeviceRegistryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DeviceRegistry>

deleteDevice(DeleteDeviceRequest request)

public ListenableFuture<Empty> deleteDevice(DeleteDeviceRequest request)

Deletes a device.

Parameter
Name Description
request DeleteDeviceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDeviceRegistry(DeleteDeviceRegistryRequest request)

public ListenableFuture<Empty> deleteDeviceRegistry(DeleteDeviceRegistryRequest request)

Deletes a device registry configuration.

Parameter
Name Description
request DeleteDeviceRegistryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getDevice(GetDeviceRequest request)

public ListenableFuture<Device> getDevice(GetDeviceRequest request)

Gets details about a device.

Parameter
Name Description
request GetDeviceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Device>

getDeviceRegistry(GetDeviceRegistryRequest request)

public ListenableFuture<DeviceRegistry> getDeviceRegistry(GetDeviceRegistryRequest request)

Gets a device registry configuration.

Parameter
Name Description
request GetDeviceRegistryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DeviceRegistry>

getIamPolicy(GetIamPolicyRequest request)

public ListenableFuture<Policy> getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

listDeviceConfigVersions(ListDeviceConfigVersionsRequest request)

public ListenableFuture<ListDeviceConfigVersionsResponse> listDeviceConfigVersions(ListDeviceConfigVersionsRequest request)

Lists the last few versions of the device configuration in descending order (i.e.: newest first).

Parameter
Name Description
request ListDeviceConfigVersionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDeviceConfigVersionsResponse>

listDeviceRegistries(ListDeviceRegistriesRequest request)

public ListenableFuture<ListDeviceRegistriesResponse> listDeviceRegistries(ListDeviceRegistriesRequest request)

Lists device registries.

Parameter
Name Description
request ListDeviceRegistriesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDeviceRegistriesResponse>

listDeviceStates(ListDeviceStatesRequest request)

public ListenableFuture<ListDeviceStatesResponse> listDeviceStates(ListDeviceStatesRequest request)

Lists the last few versions of the device state in descending order (i.e.: newest first).

Parameter
Name Description
request ListDeviceStatesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDeviceStatesResponse>

listDevices(ListDevicesRequest request)

public ListenableFuture<ListDevicesResponse> listDevices(ListDevicesRequest request)

List devices in a device registry.

Parameter
Name Description
request ListDevicesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDevicesResponse>

modifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request)

public ListenableFuture<DeviceConfig> modifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request)

Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.

Parameter
Name Description
request ModifyCloudToDeviceConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DeviceConfig>

sendCommandToDevice(SendCommandToDeviceRequest request)

public ListenableFuture<SendCommandToDeviceResponse> sendCommandToDevice(SendCommandToDeviceRequest request)

Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device.

Parameter
Name Description
request SendCommandToDeviceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SendCommandToDeviceResponse>

setIamPolicy(SetIamPolicyRequest request)

public ListenableFuture<Policy> setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

testIamPermissions(TestIamPermissionsRequest request)

public ListenableFuture<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request)

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.

Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse>

unbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request)

public ListenableFuture<UnbindDeviceFromGatewayResponse> unbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request)

Deletes the association between the device and the gateway.

Parameter
Name Description
request UnbindDeviceFromGatewayRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<UnbindDeviceFromGatewayResponse>

updateDevice(UpdateDeviceRequest request)

public ListenableFuture<Device> updateDevice(UpdateDeviceRequest request)

Updates a device.

Parameter
Name Description
request UpdateDeviceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Device>

updateDeviceRegistry(UpdateDeviceRegistryRequest request)

public ListenableFuture<DeviceRegistry> updateDeviceRegistry(UpdateDeviceRegistryRequest request)

Updates a device registry configuration.

Parameter
Name Description
request UpdateDeviceRegistryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DeviceRegistry>