Class DeviceManagerGrpc.DeviceManagerBlockingStub (2.16.0)

public static final class DeviceManagerGrpc.DeviceManagerBlockingStub extends AbstractBlockingStub<DeviceManagerGrpc.DeviceManagerBlockingStub>

A stub to allow clients to do synchronous 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.AbstractBlockingStub > DeviceManagerGrpc.DeviceManagerBlockingStub

Methods

bindDeviceToGateway(BindDeviceToGatewayRequest request)

public BindDeviceToGatewayResponse bindDeviceToGateway(BindDeviceToGatewayRequest request)

Associates the device with the gateway.

Parameter
NameDescription
requestBindDeviceToGatewayRequest
Returns
TypeDescription
BindDeviceToGatewayResponse

build(Channel channel, CallOptions callOptions)

protected DeviceManagerGrpc.DeviceManagerBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DeviceManagerGrpc.DeviceManagerBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDevice(CreateDeviceRequest request)

public Device createDevice(CreateDeviceRequest request)

Creates a device in a device registry.

Parameter
NameDescription
requestCreateDeviceRequest
Returns
TypeDescription
Device

createDeviceRegistry(CreateDeviceRegistryRequest request)

public DeviceRegistry createDeviceRegistry(CreateDeviceRegistryRequest request)

Creates a device registry that contains devices.

Parameter
NameDescription
requestCreateDeviceRegistryRequest
Returns
TypeDescription
DeviceRegistry

deleteDevice(DeleteDeviceRequest request)

public Empty deleteDevice(DeleteDeviceRequest request)

Deletes a device.

Parameter
NameDescription
requestDeleteDeviceRequest
Returns
TypeDescription
Empty

deleteDeviceRegistry(DeleteDeviceRegistryRequest request)

public Empty deleteDeviceRegistry(DeleteDeviceRegistryRequest request)

Deletes a device registry configuration.

Parameter
NameDescription
requestDeleteDeviceRegistryRequest
Returns
TypeDescription
Empty

getDevice(GetDeviceRequest request)

public Device getDevice(GetDeviceRequest request)

Gets details about a device.

Parameter
NameDescription
requestGetDeviceRequest
Returns
TypeDescription
Device

getDeviceRegistry(GetDeviceRegistryRequest request)

public DeviceRegistry getDeviceRegistry(GetDeviceRegistryRequest request)

Gets a device registry configuration.

Parameter
NameDescription
requestGetDeviceRegistryRequest
Returns
TypeDescription
DeviceRegistry

getIamPolicy(GetIamPolicyRequest request)

public 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
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest
Returns
TypeDescription
com.google.iam.v1.Policy

listDeviceConfigVersions(ListDeviceConfigVersionsRequest request)

public ListDeviceConfigVersionsResponse listDeviceConfigVersions(ListDeviceConfigVersionsRequest request)

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

Parameter
NameDescription
requestListDeviceConfigVersionsRequest
Returns
TypeDescription
ListDeviceConfigVersionsResponse

listDeviceRegistries(ListDeviceRegistriesRequest request)

public ListDeviceRegistriesResponse listDeviceRegistries(ListDeviceRegistriesRequest request)

Lists device registries.

Parameter
NameDescription
requestListDeviceRegistriesRequest
Returns
TypeDescription
ListDeviceRegistriesResponse

listDeviceStates(ListDeviceStatesRequest request)

public ListDeviceStatesResponse listDeviceStates(ListDeviceStatesRequest request)

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

Parameter
NameDescription
requestListDeviceStatesRequest
Returns
TypeDescription
ListDeviceStatesResponse

listDevices(ListDevicesRequest request)

public ListDevicesResponse listDevices(ListDevicesRequest request)

List devices in a device registry.

Parameter
NameDescription
requestListDevicesRequest
Returns
TypeDescription
ListDevicesResponse

modifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest request)

public 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
NameDescription
requestModifyCloudToDeviceConfigRequest
Returns
TypeDescription
DeviceConfig

sendCommandToDevice(SendCommandToDeviceRequest request)

public 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
NameDescription
requestSendCommandToDeviceRequest
Returns
TypeDescription
SendCommandToDeviceResponse

setIamPolicy(SetIamPolicyRequest request)

public Policy setIamPolicy(SetIamPolicyRequest request)

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

Parameter
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest
Returns
TypeDescription
com.google.iam.v1.Policy

testIamPermissions(TestIamPermissionsRequest request)

public 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
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest
Returns
TypeDescription
com.google.iam.v1.TestIamPermissionsResponse

unbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request)

public UnbindDeviceFromGatewayResponse unbindDeviceFromGateway(UnbindDeviceFromGatewayRequest request)

Deletes the association between the device and the gateway.

Parameter
NameDescription
requestUnbindDeviceFromGatewayRequest
Returns
TypeDescription
UnbindDeviceFromGatewayResponse

updateDevice(UpdateDeviceRequest request)

public Device updateDevice(UpdateDeviceRequest request)

Updates a device.

Parameter
NameDescription
requestUpdateDeviceRequest
Returns
TypeDescription
Device

updateDeviceRegistry(UpdateDeviceRegistryRequest request)

public DeviceRegistry updateDeviceRegistry(UpdateDeviceRegistryRequest request)

Updates a device registry configuration.

Parameter
NameDescription
requestUpdateDeviceRegistryRequest
Returns
TypeDescription
DeviceRegistry