Interface DeviceManagerGrpc.AsyncService (2.42.0)

public static interface DeviceManagerGrpc.AsyncService

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

Methods

bindDeviceToGateway(BindDeviceToGatewayRequest request, StreamObserver<BindDeviceToGatewayResponse> responseObserver)

public default void bindDeviceToGateway(BindDeviceToGatewayRequest request, StreamObserver<BindDeviceToGatewayResponse> responseObserver)

Associates the device with the gateway.

Parameters
Name Description
request BindDeviceToGatewayRequest
responseObserver io.grpc.stub.StreamObserver<BindDeviceToGatewayResponse>

createDevice(CreateDeviceRequest request, StreamObserver<Device> responseObserver)

public default void createDevice(CreateDeviceRequest request, StreamObserver<Device> responseObserver)

Creates a device in a device registry.

Parameters
Name Description
request CreateDeviceRequest
responseObserver io.grpc.stub.StreamObserver<Device>

createDeviceRegistry(CreateDeviceRegistryRequest request, StreamObserver<DeviceRegistry> responseObserver)

public default void createDeviceRegistry(CreateDeviceRegistryRequest request, StreamObserver<DeviceRegistry> responseObserver)

Creates a device registry that contains devices.

Parameters
Name Description
request CreateDeviceRegistryRequest
responseObserver io.grpc.stub.StreamObserver<DeviceRegistry>

deleteDevice(DeleteDeviceRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDevice(DeleteDeviceRequest request, StreamObserver<Empty> responseObserver)

Deletes a device.

Parameters
Name Description
request DeleteDeviceRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteDeviceRegistry(DeleteDeviceRegistryRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDeviceRegistry(DeleteDeviceRegistryRequest request, StreamObserver<Empty> responseObserver)

Deletes a device registry configuration.

Parameters
Name Description
request DeleteDeviceRegistryRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getDevice(GetDeviceRequest request, StreamObserver<Device> responseObserver)

public default void getDevice(GetDeviceRequest request, StreamObserver<Device> responseObserver)

Gets details about a device.

Parameters
Name Description
request GetDeviceRequest
responseObserver io.grpc.stub.StreamObserver<Device>

getDeviceRegistry(GetDeviceRegistryRequest request, StreamObserver<DeviceRegistry> responseObserver)

public default void getDeviceRegistry(GetDeviceRegistryRequest request, StreamObserver<DeviceRegistry> responseObserver)

Gets a device registry configuration.

Parameters
Name Description
request GetDeviceRegistryRequest
responseObserver io.grpc.stub.StreamObserver<DeviceRegistry>

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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

Parameters
Name Description
request com.google.iam.v1.GetIamPolicyRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

listDeviceConfigVersions(ListDeviceConfigVersionsRequest request, StreamObserver<ListDeviceConfigVersionsResponse> responseObserver)

public default void listDeviceConfigVersions(ListDeviceConfigVersionsRequest request, StreamObserver<ListDeviceConfigVersionsResponse> responseObserver)

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

Parameters
Name Description
request ListDeviceConfigVersionsRequest
responseObserver io.grpc.stub.StreamObserver<ListDeviceConfigVersionsResponse>

listDeviceRegistries(ListDeviceRegistriesRequest request, StreamObserver<ListDeviceRegistriesResponse> responseObserver)

public default void listDeviceRegistries(ListDeviceRegistriesRequest request, StreamObserver<ListDeviceRegistriesResponse> responseObserver)

Lists device registries.

Parameters
Name Description
request ListDeviceRegistriesRequest
responseObserver io.grpc.stub.StreamObserver<ListDeviceRegistriesResponse>

listDeviceStates(ListDeviceStatesRequest request, StreamObserver<ListDeviceStatesResponse> responseObserver)

public default void listDeviceStates(ListDeviceStatesRequest request, StreamObserver<ListDeviceStatesResponse> responseObserver)

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

Parameters
Name Description
request ListDeviceStatesRequest
responseObserver io.grpc.stub.StreamObserver<ListDeviceStatesResponse>

listDevices(ListDevicesRequest request, StreamObserver<ListDevicesResponse> responseObserver)

public default void listDevices(ListDevicesRequest request, StreamObserver<ListDevicesResponse> responseObserver)

List devices in a device registry.

Parameters
Name Description
request ListDevicesRequest
responseObserver io.grpc.stub.StreamObserver<ListDevicesResponse>

modifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request, StreamObserver<DeviceConfig> responseObserver)

public default void modifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request, StreamObserver<DeviceConfig> responseObserver)

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

Parameters
Name Description
request ModifyCloudToDeviceConfigRequest
responseObserver io.grpc.stub.StreamObserver<DeviceConfig>

sendCommandToDevice(SendCommandToDeviceRequest request, StreamObserver<SendCommandToDeviceResponse> responseObserver)

public default void sendCommandToDevice(SendCommandToDeviceRequest request, StreamObserver<SendCommandToDeviceResponse> responseObserver)

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.

Parameters
Name Description
request SendCommandToDeviceRequest
responseObserver io.grpc.stub.StreamObserver<SendCommandToDeviceResponse>

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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

Parameters
Name Description
request com.google.iam.v1.SetIamPolicyRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public default void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

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.

Parameters
Name Description
request com.google.iam.v1.TestIamPermissionsRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>

unbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request, StreamObserver<UnbindDeviceFromGatewayResponse> responseObserver)

public default void unbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request, StreamObserver<UnbindDeviceFromGatewayResponse> responseObserver)

Deletes the association between the device and the gateway.

Parameters
Name Description
request UnbindDeviceFromGatewayRequest
responseObserver io.grpc.stub.StreamObserver<UnbindDeviceFromGatewayResponse>

updateDevice(UpdateDeviceRequest request, StreamObserver<Device> responseObserver)

public default void updateDevice(UpdateDeviceRequest request, StreamObserver<Device> responseObserver)

Updates a device.

Parameters
Name Description
request UpdateDeviceRequest
responseObserver io.grpc.stub.StreamObserver<Device>

updateDeviceRegistry(UpdateDeviceRegistryRequest request, StreamObserver<DeviceRegistry> responseObserver)

public default void updateDeviceRegistry(UpdateDeviceRegistryRequest request, StreamObserver<DeviceRegistry> responseObserver)

Updates a device registry configuration.

Parameters
Name Description
request UpdateDeviceRegistryRequest
responseObserver io.grpc.stub.StreamObserver<DeviceRegistry>