2023-04-17
▼ ▲ cloudiot.projects.locations.registries.testIamPermissions
Scopes:
Parameters:
resource
Type: string
Required: Yes
Location: path
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.
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
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}:testIamPermissions
HTTP Method: POST
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
▼ ▲ cloudiot.projects.locations.registries.delete
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Type: string
Required: Yes
Description: Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Scopes:
Description: Deletes a device registry configuration.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}
HTTP Method: DELETE
▼ ▲ cloudiot.projects.locations.registries.unbindDeviceFromGateway
Parameter Order: parent
Scopes:
Description: Deletes the association between the device and the gateway.
HTTP Method: POST
Path: v1/{+parent}:unbindDeviceFromGateway
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Type: string
Description: Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Location: path
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:unbindDeviceFromGateway
▼ ▲ cloudiot.projects.locations.registries.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.
HTTP Method: POST
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy
Scopes:
Path: v1/{+resource}:getIamPolicy
Parameters:
resource
Required: Yes
Type: string
Location: path
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.
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
▼ ▲ cloudiot.projects.locations.registries.patch
Description: Updates a device registry configuration.
HTTP Method: PATCH
Parameters:
name
Location: path
Description: The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
updateMask
Format: google-fieldmask
Location: query
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
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}
Scopes:
Parameter Order: name
▼ ▲ cloudiot.projects.locations.registries.create
Scopes:
Parameter Order: parent
HTTP Method: POST
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Location: path
Description: Required. The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries
Description: Creates a device registry that contains devices.
Path: v1/{+parent}/registries
▼ ▲ cloudiot.projects.locations.registries.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries
Parameters:
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
Required: Yes
Description: Required. The project and cloud region path. For example, `projects/example-project/locations/us-central1`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
pageSize
Location: query
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.
Type: integer
Format: int32
Path: v1/{+parent}/registries
HTTP Method: GET
Parameter Order: parent
Scopes:
Description: Lists device registries.
▼ ▲ cloudiot.projects.locations.registries.bindDeviceToGateway
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:bindDeviceToGateway
HTTP Method: POST
Description: Associates the device with the gateway.
Parameters:
parent
Description: Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Parameter Order: parent
Path: v1/{+parent}:bindDeviceToGateway
Scopes:
▼ ▲ cloudiot.projects.locations.registries.get
Scopes:
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Description: Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Required: Yes
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}
Description: Gets a device registry configuration.
HTTP Method: GET
Parameter Order: name
Path: v1/{+name}
▼ ▲ cloudiot.projects.locations.registries.setIamPolicy
Scopes:
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy
Parameter Order: resource
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters:
resource
Type: string
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.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Location: path
HTTP Method: POST
Path: v1/{+resource}:setIamPolicy
▼ ▲ cloudiot.projects.locations.registries.groups.devices.list
Parameter Order: parent
Description: List devices in a device registry.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices
Parameters:
gatewayListOptions.associationsGatewayId
Location: query
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.
gatewayListOptions.gatewayType
Enum Descriptions:
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:
Location: query
gatewayListOptions.associationsDeviceId
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.
Location: query
deviceNumIds
Format: uint64
Type: string
Repeated: Yes
Description: A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
Location: query
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`.
pageSize
Type: integer
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
Format: int32
parent
Type: string
Location: path
Description: Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$
deviceIds
Repeated: Yes
Type: string
Description: A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
Location: query
pageToken
Location: query
Type: string
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.
HTTP Method: GET
Scopes:
Path: v1/{+parent}/devices
▼ ▲ cloudiot.projects.locations.registries.groups.testIamPermissions
HTTP Method: POST
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
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$
Location: path
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.
Required: Yes
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:testIamPermissions
Path: v1/{+resource}:testIamPermissions
Scopes:
Parameter Order: resource
▼ ▲ cloudiot.projects.locations.registries.groups.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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:getIamPolicy
HTTP Method: POST
Parameter Order: resource
Parameters:
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$
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.
Scopes:
Path: v1/{+resource}:getIamPolicy
▼ ▲ cloudiot.projects.locations.registries.groups.setIamPolicy
Scopes:
Path: v1/{+resource}:setIamPolicy
Parameter Order: resource
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters:
resource
Type: string
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.
Location: path
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:setIamPolicy
▼ ▲ cloudiot.projects.locations.registries.devices.get
Parameters:
fieldMask
Format: google-fieldmask
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
Type: string
name
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
Location: path
Required: Yes
Scopes:
HTTP Method: GET
Description: Gets details about a device.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}
Parameter Order: name
▼ ▲ cloudiot.projects.locations.registries.devices.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices
Scopes:
Description: List devices in a device registry.
Parameters:
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
deviceNumIds
Format: uint64
Type: string
Description: A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
Repeated: Yes
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
deviceIds
Repeated: Yes
Location: query
Type: string
Description: A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
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`.
Type: string
Format: google-fieldmask
Location: query
pageSize
Location: query
Type: integer
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.
gatewayListOptions.associationsDeviceId
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.
Location: query
parent
Type: string
Location: path
Description: Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+$
Required: Yes
gatewayListOptions.gatewayType
Type: string
Location: query
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:
HTTP Method: GET
Parameter Order: parent
Path: v1/{+parent}/devices
▼ ▲ cloudiot.projects.locations.registries.devices.patch
Description: Updates a device.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}
Scopes:
HTTP Method: PATCH
Path: v1/{+name}
Parameters:
name
Required: Yes
Type: string
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
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
updateMask
Type: string
Format: google-fieldmask
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
Parameter Order: name
▼ ▲ cloudiot.projects.locations.registries.devices.sendCommandToDevice
HTTP Method: POST
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}`.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Parameter Order: name
Path: v1/{+name}:sendCommandToDevice
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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:sendCommandToDevice
Scopes:
▼ ▲ cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig
HTTP Method: POST
Scopes:
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig
Parameter Order: name
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.
Path: v1/{+name}:modifyCloudToDeviceConfig
Parameters:
name
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}`.
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Type: string
▼ ▲ cloudiot.projects.locations.registries.devices.delete
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
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}`.
Required: Yes
Parameter Order: name
Scopes:
HTTP Method: DELETE
Path: v1/{+name}
Description: Deletes a device.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}
▼ ▲ cloudiot.projects.locations.registries.devices.create
Path: v1/{+parent}/devices
Parameters:
parent
Type: string
Required: Yes
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/[^/]+$
Location: path
Parameter Order: parent
Description: Creates a device in a device registry.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices
Scopes:
HTTP Method: POST
▼ ▲ cloudiot.projects.locations.registries.devices.states.list
Scopes:
Parameter Order: name
Path: v1/{+name}/states
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states
Parameters:
numStates
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.
Location: query
name
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}`.
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Required: Yes
Type: string
HTTP Method: GET
Description: Lists the last few versions of the device state in descending order (i.e.: newest first).
▼ ▲ cloudiot.projects.locations.registries.devices.configVersions.list
Parameters:
numVersions
Format: int32
Type: integer
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.
Location: query
name
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}`.
Pattern: ^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$
Required: Yes
Parameter Order: name
Description: Lists the last few versions of the device configuration in descending order (i.e.: newest first).
HTTP Method: GET
Path: v1/{+name}/configVersions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions
Scopes: