Cloud IoT API: projects. Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform. See: https://cloud.google.com/iotapi/reference/rest/v1/projects
Cloud IoT API: projects. Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform. See: https://cloud.google.com/iotapi/reference/rest/v1/projects
(locations-registries-bindDeviceToGateway$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/bindDeviceToGateway
Required parameters: parent
Optional parameters: none
Body:
{:deviceId string, :gatewayId string}
Associates the device with the gateway.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/bindDeviceToGateway Required parameters: parent Optional parameters: none Body: {:deviceId string, :gatewayId string} Associates the device with the gateway.
(locations-registries-create$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/create
Required parameters: parent
Optional parameters: none
Body:
{:name string, :mqttConfig {:mqttEnabledState string}, :httpConfig {:httpEnabledState string}, :stateNotificationConfig {:pubsubTopicName string}, :logLevel string, :eventNotificationConfigs [{:pubsubTopicName string, :subfolderMatches string}], :id string, :credentials [{:publicKeyCertificate PublicKeyCertificate}]}
Creates a device registry that contains devices.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/create Required parameters: parent Optional parameters: none Body: {:name string, :mqttConfig {:mqttEnabledState string}, :httpConfig {:httpEnabledState string}, :stateNotificationConfig {:pubsubTopicName string}, :logLevel string, :eventNotificationConfigs [{:pubsubTopicName string, :subfolderMatches string}], :id string, :credentials [{:publicKeyCertificate PublicKeyCertificate}]} Creates a device registry that contains devices.
(locations-registries-delete$ auth parameters)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/delete
Required parameters: name
Optional parameters: none
Deletes a device registry configuration.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/delete Required parameters: name Optional parameters: none Deletes a device registry configuration.
(locations-registries-devices-configVersions-list$ auth parameters)
Required parameters: name
Optional parameters: numVersions
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/configVersions/list Required parameters: name Optional parameters: numVersions Lists the last few versions of the device configuration in descending order (i.e.: newest first).
(locations-registries-devices-create$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/create
Required parameters: parent
Optional parameters: none
Body:
{:gatewayConfig {:gatewayType string, :lastAccessedGatewayTime string, :gatewayAuthMethod string, :lastAccessedGatewayId string}, :numId string, :lastConfigAckTime string, :lastHeartbeatTime string, :credentials [{:publicKey PublicKeyCredential, :expirationTime string}], :config {:binaryData string, :version string, :cloudUpdateTime string, :deviceAckTime string}, :lastConfigSendTime string, :name string, :lastStateTime string, :state {:binaryData string, :updateTime string}, :lastErrorTime string, :id string, :lastEventTime string, :logLevel string, :lastErrorStatus {:message string, :details [{}], :code integer}, :blocked boolean, :metadata {}}
Creates a device in a device registry.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/create Required parameters: parent Optional parameters: none Body: {:gatewayConfig {:gatewayType string, :lastAccessedGatewayTime string, :gatewayAuthMethod string, :lastAccessedGatewayId string}, :numId string, :lastConfigAckTime string, :lastHeartbeatTime string, :credentials [{:publicKey PublicKeyCredential, :expirationTime string}], :config {:binaryData string, :version string, :cloudUpdateTime string, :deviceAckTime string}, :lastConfigSendTime string, :name string, :lastStateTime string, :state {:binaryData string, :updateTime string}, :lastErrorTime string, :id string, :lastEventTime string, :logLevel string, :lastErrorStatus {:message string, :details [{}], :code integer}, :blocked boolean, :metadata {}} Creates a device in a device registry.
(locations-registries-devices-delete$ auth parameters)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/delete
Required parameters: name
Optional parameters: none
Deletes a device.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/delete Required parameters: name Optional parameters: none Deletes a device.
(locations-registries-devices-get$ auth parameters)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/get
Required parameters: name
Optional parameters: fieldMask
Gets details about a device.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/get Required parameters: name Optional parameters: fieldMask Gets details about a device.
(locations-registries-devices-list$ auth parameters)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/list
Required parameters: parent
Optional parameters: fieldMask, gatewayListOptions.associationsGatewayId, gatewayListOptions.associationsDeviceId, pageToken, deviceNumIds, pageSize, deviceIds, gatewayListOptions.gatewayType
List devices in a device registry.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/list Required parameters: parent Optional parameters: fieldMask, gatewayListOptions.associationsGatewayId, gatewayListOptions.associationsDeviceId, pageToken, deviceNumIds, pageSize, deviceIds, gatewayListOptions.gatewayType List devices in a device registry.
(locations-registries-devices-modifyCloudToDeviceConfig$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:versionToUpdate string, :binaryData string}
Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/modifyCloudToDeviceConfig Required parameters: name Optional parameters: none Body: {:versionToUpdate string, :binaryData string} Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.
(locations-registries-devices-patch$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:gatewayConfig {:gatewayType string, :lastAccessedGatewayTime string, :gatewayAuthMethod string, :lastAccessedGatewayId string}, :numId string, :lastConfigAckTime string, :lastHeartbeatTime string, :credentials [{:publicKey PublicKeyCredential, :expirationTime string}], :config {:binaryData string, :version string, :cloudUpdateTime string, :deviceAckTime string}, :lastConfigSendTime string, :name string, :lastStateTime string, :state {:binaryData string, :updateTime string}, :lastErrorTime string, :id string, :lastEventTime string, :logLevel string, :lastErrorStatus {:message string, :details [{}], :code integer}, :blocked boolean, :metadata {}}
Updates a device.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/patch Required parameters: name Optional parameters: updateMask Body: {:gatewayConfig {:gatewayType string, :lastAccessedGatewayTime string, :gatewayAuthMethod string, :lastAccessedGatewayId string}, :numId string, :lastConfigAckTime string, :lastHeartbeatTime string, :credentials [{:publicKey PublicKeyCredential, :expirationTime string}], :config {:binaryData string, :version string, :cloudUpdateTime string, :deviceAckTime string}, :lastConfigSendTime string, :name string, :lastStateTime string, :state {:binaryData string, :updateTime string}, :lastErrorTime string, :id string, :lastEventTime string, :logLevel string, :lastErrorStatus {:message string, :details [{}], :code integer}, :blocked boolean, :metadata {}} Updates a device.
(locations-registries-devices-sendCommandToDevice$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:subfolder string, :binaryData string}
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.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/sendCommandToDevice Required parameters: name Optional parameters: none Body: {:subfolder string, :binaryData string} 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.
(locations-registries-devices-states-list$ auth parameters)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/states/list
Required parameters: name
Optional parameters: numStates
Lists the last few versions of the device state in descending order (i.e.: newest first).
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/devices/states/list Required parameters: name Optional parameters: numStates Lists the last few versions of the device state in descending order (i.e.: newest first).
(locations-registries-get$ auth parameters)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/get
Required parameters: name
Optional parameters: none
Gets a device registry configuration.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/get Required parameters: name Optional parameters: none Gets a device registry configuration.
(locations-registries-getIamPolicy$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-registries-groups-devices-list$ auth parameters)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/groups/devices/list
Required parameters: parent
Optional parameters: fieldMask, gatewayListOptions.associationsGatewayId, gatewayListOptions.associationsDeviceId, pageToken, deviceNumIds, pageSize, deviceIds, gatewayListOptions.gatewayType
List devices in a device registry.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/groups/devices/list Required parameters: parent Optional parameters: fieldMask, gatewayListOptions.associationsGatewayId, gatewayListOptions.associationsDeviceId, pageToken, deviceNumIds, pageSize, deviceIds, gatewayListOptions.gatewayType List devices in a device registry.
(locations-registries-groups-getIamPolicy$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/groups/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/groups/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-registries-groups-setIamPolicy$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/groups/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :etag string, :bindings [Binding]}}
Sets the access control policy on the specified resource. Replaces any existing policy.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/groups/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :etag string, :bindings [Binding]}} Sets the access control policy on the specified resource. Replaces any existing policy.
(locations-registries-groups-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/groups/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(locations-registries-list$ auth parameters)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/list
Required parameters: parent
Optional parameters: pageToken, pageSize
Lists device registries.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/list Required parameters: parent Optional parameters: pageToken, pageSize Lists device registries.
(locations-registries-patch$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :mqttConfig {:mqttEnabledState string}, :httpConfig {:httpEnabledState string}, :stateNotificationConfig {:pubsubTopicName string}, :logLevel string, :eventNotificationConfigs [{:pubsubTopicName string, :subfolderMatches string}], :id string, :credentials [{:publicKeyCertificate PublicKeyCertificate}]}
Updates a device registry configuration.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/patch Required parameters: name Optional parameters: updateMask Body: {:name string, :mqttConfig {:mqttEnabledState string}, :httpConfig {:httpEnabledState string}, :stateNotificationConfig {:pubsubTopicName string}, :logLevel string, :eventNotificationConfigs [{:pubsubTopicName string, :subfolderMatches string}], :id string, :credentials [{:publicKeyCertificate PublicKeyCertificate}]} Updates a device registry configuration.
(locations-registries-setIamPolicy$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :etag string, :bindings [Binding]}}
Sets the access control policy on the specified resource. Replaces any existing policy.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :etag string, :bindings [Binding]}} Sets the access control policy on the specified resource. Replaces any existing policy.
(locations-registries-testIamPermissions$ auth parameters body)
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/testIamPermissions
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(locations-registries-unbindDeviceFromGateway$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:deviceId string, :gatewayId string}
Deletes the association between the device and the gateway.
https://cloud.google.com/iotapi/reference/rest/v1/projects/locations/registries/unbindDeviceFromGateway Required parameters: parent Optional parameters: none Body: {:deviceId string, :gatewayId string} Deletes the association between the device and the gateway.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close