2023-04-15
▼ ▲ cloudiot.projects.locations.registries.devices.configVersions.list
HTTP Method: GET
Parameter Order: name
Parameters:
name
Description: Required. 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}`.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Type: string
numVersions
Location: query
Format: int32
Description: The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available.
Type: integer
Scopes:
Path: v1/{+name}/configVersions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions
Description: Lists the last few versions of the device configuration in descending order (i.e.: newest first).
▼ ▲ cloudiot.projects.locations.registries.devices.states.list
Path: v1/{+name}/states
HTTP Method: GET
Parameter Order: name
Scopes:
Description: Lists the last few versions of the device state in descending order (i.e.: newest first).
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states
Parameters:
name
Description: Required. 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}`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Type: string
Required: Yes
numStates
Location: query
Type: integer
Format: int32
Description: The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.
▼ ▲ cloudiot.projects.locations.registries.devices.create
Description: Creates a device in a device registry.
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices
Path: v1/{+parent}/devices
Parameters:
parent
Type: string
Required: Yes
Location: path
Description: Required. The name of the device registry where this device should be created. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Scopes:
HTTP Method: POST
▼ ▲ cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig
Path: v1/{+name}:modifyCloudToDeviceConfig
HTTP Method: POST
Scopes:
Description: 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
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Type: string
Required: Yes
Location: path
Description: Required. 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}`.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig
Parameter Order: name
▼ ▲ cloudiot.projects.locations.registries.devices.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices
Description: List devices in a device registry.
HTTP Method: GET
Scopes:
Parameters:
deviceNumIds
Type: string
Repeated: Yes
Location: query
Format: uint64
Description: A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
deviceIds
Type: string
Repeated: Yes
Location: query
Description: A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
pageSize
Type: integer
Location: query
Format: int32
Description: The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
pageToken
Description: The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data.
Type: string
Location: query
gatewayListOptions.associationsGatewayId
Type: string
Description: If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `123` is specified, only devices bound to the gateway with `num_id` 123 are returned.
Location: query
gatewayListOptions.associationsDeviceId
Type: string
Location: query
Description: If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `456` is specified, returns only the gateways to which the device with `num_id` 456 is bound.
parent
Description: Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
gatewayListOptions.gatewayType
Location: query
Enum:
Description: If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.
Type: string
Enum Descriptions:
fieldMask
Format: google-fieldmask
Type: string
Location: query
Description: The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other fields specified in snake_case format, for example: `last_heartbeat_time`.
Parameter Order: parent
Path: v1/{+parent}/devices
▼ ▲ cloudiot.projects.locations.registries.devices.get
Parameters:
fieldMask
Format: google-fieldmask
Type: string
Description: The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned. Fields have to be provided in snake_case format, for example: `last_heartbeat_time`.
Location: query
name
Description: Required. 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}`.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}
Path: v1/{+name}
Description: Gets details about a device.
Scopes:
HTTP Method: GET
▼ ▲ cloudiot.projects.locations.registries.devices.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}
Description: Updates a device.
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Required: Yes
Description: The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID.
Location: path
updateMask
Type: string
Description: Required. 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`
Location: query
Format: google-fieldmask
HTTP Method: PATCH
Path: v1/{+name}
Scopes:
Parameter Order: name
▼ ▲ cloudiot.projects.locations.registries.devices.sendCommandToDevice
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:sendCommandToDevice
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. 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}`.
Description: 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.
Scopes:
Path: v1/{+name}:sendCommandToDevice
HTTP Method: POST
▼ ▲ cloudiot.projects.locations.registries.devices.delete
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Description: Required. 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}`.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}
Description: Deletes a device.
Scopes:
HTTP Method: DELETE
▼ ▲ cloudiot.projects.locations.registries.groups.setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters:
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Path: v1/{+resource}:setIamPolicy
Scopes:
Parameter Order: resource
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:setIamPolicy
▼ ▲ cloudiot.projects.locations.registries.groups.testIamPermissions
HTTP Method: POST
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Required: Yes
Parameter Order: resource
Scopes:
Path: v1/{+resource}:testIamPermissions
Description: 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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:testIamPermissions
▼ ▲ cloudiot.projects.locations.registries.groups.getIamPolicy
Scopes:
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$
Type: string
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameter Order: resource
HTTP Method: POST
Path: v1/{+resource}:getIamPolicy
▼ ▲ cloudiot.projects.locations.registries.groups.devices.list
HTTP Method: GET
Parameter Order: parent
Parameters:
deviceIds
Location: query
Type: string
Repeated: Yes
Description: A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$
Required: Yes
Description: Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
Type: string
pageToken
Description: The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data.
Location: query
Type: string
pageSize
Format: int32
Description: The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
Location: query
Type: integer
gatewayListOptions.gatewayType
Type: string
Description: If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.
Enum Descriptions:
Enum:
Location: query
gatewayListOptions.associationsGatewayId
Location: query
Description: If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `123` is specified, only devices bound to the gateway with `num_id` 123 are returned.
Type: string
deviceNumIds
Description: A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
Repeated: Yes
Format: uint64
Location: query
Type: string
gatewayListOptions.associationsDeviceId
Location: query
Type: string
Description: If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `456` is specified, returns only the gateways to which the device with `num_id` 456 is bound.
fieldMask
Type: string
Format: google-fieldmask
Description: The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other fields specified in snake_case format, for example: `last_heartbeat_time`.
Location: query
Path: v1/{+parent}/devices
Description: List devices in a device registry.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices
Scopes:
▼ ▲ cloudiot.projects.locations.registries.bindDeviceToGateway
Description: Associates the device with the gateway.
Parameters:
parent
Required: Yes
Description: Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Type: string
Location: path
Scopes:
Parameter Order: parent
Path: v1/{+parent}:bindDeviceToGateway
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:bindDeviceToGateway
HTTP Method: POST
▼ ▲ cloudiot.projects.locations.registries.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries
HTTP Method: GET
Description: Lists device registries.
Scopes:
Parameters:
pageSize
Description: The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
Location: query
Format: int32
Type: integer
pageToken
Type: string
Description: The value returned by the last `ListDeviceRegistriesResponse`; indicates that this is a continuation of a prior `ListDeviceRegistries` call and the system should return the next page of data.
Location: query
parent
Location: path
Description: Required. The project and cloud region path. For example, `projects/example-project/locations/us-central1`.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Path: v1/{+parent}/registries
Parameter Order: parent
▼ ▲ cloudiot.projects.locations.registries.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}
Description: Gets a device registry configuration.
Scopes:
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Description: Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Location: path
Required: Yes
Type: string
HTTP Method: GET
Parameter Order: name
Path: v1/{+name}
▼ ▲ cloudiot.projects.locations.registries.unbindDeviceFromGateway
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:unbindDeviceFromGateway
Scopes:
Description: Deletes the association between the device and the gateway.
HTTP Method: POST
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Description: Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Type: string
Required: Yes
Path: v1/{+parent}:unbindDeviceFromGateway
▼ ▲ cloudiot.projects.locations.registries.patch
HTTP Method: PATCH
Parameter Order: name
Path: v1/{+name}
Description: Updates a device registry configuration.
Parameters:
name
Description: The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Type: string
updateMask
Format: google-fieldmask
Description: Required. 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`.
Type: string
Location: query
Scopes:
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}
▼ ▲ cloudiot.projects.locations.registries.create
Parameters:
parent
Description: Required. The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Required: Yes
Scopes:
Parameter Order: parent
HTTP Method: POST
Description: Creates a device registry that contains devices.
Path: v1/{+parent}/registries
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries
▼ ▲ cloudiot.projects.locations.registries.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions
Description: 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:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Required: Yes
Location: path
Scopes:
Parameter Order: resource
HTTP Method: POST
▼ ▲ cloudiot.projects.locations.registries.delete
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Location: path
Description: Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Type: string
Required: Yes
Scopes:
HTTP Method: DELETE
Description: Deletes a device registry configuration.
Path: v1/{+name}
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}
▼ ▲ cloudiot.projects.locations.registries.setIamPolicy
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes:
Parameter Order: resource
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Location: path
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy
HTTP Method: POST
▼ ▲ cloudiot.projects.locations.registries.getIamPolicy
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy
Path: v1/{+resource}:getIamPolicy
Scopes:
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
resource
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Parameter Order: resource