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