luzifer/nginx-sso
1
0
Fork 0
mirror of https://github.com/Luzifer/nginx-sso.git synced 2024-12-30 09:41:19 +00:00
Code Issues Releases Wiki Activity
nginx-sso/vendor/google.golang.org/api/cloudiot/v1/cloudiot-api.json

1922 lines
104 KiB
JSON
Raw Normal View History

Update dependencies Signed-off-by: Knut Ahlers <knut@ahlers.me>
2019-04-21 17:58:15 +00:00
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloudiot": {
"description": "Register and manage devices in the Google Cloud IoT service"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudiot.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Iot",
"description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/iot",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudiot:v1",
"kind": "discovery#restDescription",
"name": "cloudiot",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"registries": {
"methods": {
"bindDeviceToGateway": {
"description": "Associates the device with the gateway.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:bindDeviceToGateway",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.bindDeviceToGateway",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:bindDeviceToGateway",
"request": {
"$ref": "BindDeviceToGatewayRequest"
},
"response": {
"$ref": "BindDeviceToGatewayResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"create": {
"description": "Creates a device registry that contains devices.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/registries",
"request": {
"$ref": "DeviceRegistry"
},
"response": {
"$ref": "DeviceRegistry"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"delete": {
"description": "Deletes a device registry configuration.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
"httpMethod": "DELETE",
"id": "cloudiot.projects.locations.registries.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"get": {
"description": "Gets a device registry configuration.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "DeviceRegistry"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"list": {
"description": "Lists device registries.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call and\nthe system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/registries",
"response": {
"$ref": "ListDeviceRegistriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"patch": {
"description": "Updates a device registry configuration.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
"httpMethod": "PATCH",
"id": "cloudiot.projects.locations.registries.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config`, `http_config`,\n`mqtt_config`, and `state_notification_config`.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "DeviceRegistry"
},
"response": {
"$ref": "DeviceRegistry"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"unbindDeviceFromGateway": {
"description": "Deletes the association between the device and the gateway.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:unbindDeviceFromGateway",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.unbindDeviceFromGateway",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:unbindDeviceFromGateway",
"request": {
"$ref": "UnbindDeviceFromGatewayRequest"
},
"response": {
"$ref": "UnbindDeviceFromGatewayResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
},
"resources": {
"devices": {
"methods": {
"create": {
"description": "Creates a device in a device registry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.devices.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/devices",
"request": {
"$ref": "Device"
},
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"delete": {
"description": "Deletes a device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
"httpMethod": "DELETE",
"id": "cloudiot.projects.locations.registries.devices.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"get": {
"description": "Gets details about a device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.devices.get",
"parameterOrder": [
"name"
],
"parameters": {
"fieldMask": {
"description": "The fields of the `Device` resource to be returned in the response. If the\nfield mask is unset or empty, all fields are returned.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"list": {
"description": "List devices in a device registry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.devices.list",
"parameterOrder": [
"parent"
],
"parameters": {
"deviceIds": {
"description": "A list of device string IDs. For example, `['device0', 'device12']`.\nIf empty, this field is ignored. Maximum IDs: 10,000",
"location": "query",
"repeated": true,
"type": "string"
},
"deviceNumIds": {
"description": "A list of device numeric IDs. If empty, this field is ignored. Maximum\nIDs: 10,000.",
"format": "uint64",
"location": "query",
"repeated": true,
"type": "string"
},
"fieldMask": {
"description": "The fields of the `Device` resource to be returned in the response. The\nfields `id` and `num_id` are always returned, along with any\nother fields specified.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"gatewayListOptions.associationsDeviceId": {
"description": "If set, returns only the gateways with which the specified device is\nassociated. The device ID can be numeric (`num_id`) or the user-defined\nstring (`id`). For example, if `456` is specified, returns only the\ngateways to which the device with `num_id` 456 is bound.",
"location": "query",
"type": "string"
},
"gatewayListOptions.associationsGatewayId": {
"description": "If set, only devices associated with the specified gateway are returned.\nThe gateway ID can be numeric (`num_id`) or the user-defined string\n(`id`). For example, if `123` is specified, only devices bound to the\ngateway with `num_id` 123 are returned.",
"location": "query",
"type": "string"
},
"gatewayListOptions.gatewayType": {
"description": "If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY`\nis specified, only non-gateway devices are returned. If\n`GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.",
"enum": [
"GATEWAY_TYPE_UNSPECIFIED",
"GATEWAY",
"NON_GATEWAY"
],
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call and\nthe system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/devices",
"response": {
"$ref": "ListDevicesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"modifyCloudToDeviceConfig": {
"description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:modifyCloudToDeviceConfig",
"request": {
"$ref": "ModifyCloudToDeviceConfigRequest"
},
"response": {
"$ref": "DeviceConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"patch": {
"description": "Updates a device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
"httpMethod": "PATCH",
"id": "cloudiot.projects.locations.registries.devices.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `blocked`, and `metadata`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Device"
},
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"sendCommandToDevice": {
"description": "Sends a command to the specified device. In order for a device to be able\nto receive commands, it must:\n1) be connected to Cloud IoT Core using the MQTT protocol, and\n2) be subscribed to the group of MQTT topics specified by\n /devices/{device-id}/commands/#. This subscription will receive commands\n at the top-level topic /devices/{device-id}/commands as well as commands\n for subfolders, like /devices/{device-id}/commands/subfolder.\n Note that subscribing to specific subfolders is not supported.\nIf the command could not be delivered to the device, this method will\nreturn an error; in particular, if the device is not subscribed, this\nmethod will return FAILED_PRECONDITION. Otherwise, this method will\nreturn OK. If the subscription is QoS 1, at least once delivery will be\nguaranteed; for QoS 0, no acknowledgment will be expected from the device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:sendCommandToDevice",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.devices.sendCommandToDevice",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:sendCommandToDevice",
"request": {
"$ref": "SendCommandToDeviceRequest"
},
"response": {
"$ref": "SendCommandToDeviceResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
},
"resources": {
"configVersions": {
"methods": {
"list": {
"description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.devices.configVersions.list",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
},
"numVersions": {
"description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}/configVersions",
"response": {
"$ref": "ListDeviceConfigVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
}
},
"states": {
"methods": {
"list": {
"description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.devices.states.list",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
},
"numStates": {
"description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}/states",
"response": {
"$ref": "ListDeviceStatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
}
}
}
},
"groups": {
"methods": {
"bindDeviceToGateway": {
"description": "Associates the device with the gateway.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:bindDeviceToGateway",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.bindDeviceToGateway",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:bindDeviceToGateway",
"request": {
"$ref": "BindDeviceToGatewayRequest"
},
"response": {
"$ref": "BindDeviceToGatewayResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:getIamPolicy",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:setIamPolicy",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:testIamPermissions",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"unbindDeviceFromGateway": {
"description": "Deletes the association between the device and the gateway.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:unbindDeviceFromGateway",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.unbindDeviceFromGateway",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:unbindDeviceFromGateway",
"request": {
"$ref": "UnbindDeviceFromGatewayRequest"
},
"response": {
"$ref": "UnbindDeviceFromGatewayResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
},
"resources": {
"devices": {
"methods": {
"get": {
"description": "Gets details about a device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.groups.devices.get",
"parameterOrder": [
"name"
],
"parameters": {
"fieldMask": {
"description": "The fields of the `Device` resource to be returned in the response. If the\nfield mask is unset or empty, all fields are returned.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"list": {
"description": "List devices in a device registry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.groups.devices.list",
"parameterOrder": [
"parent"
],
"parameters": {
"deviceIds": {
"description": "A list of device string IDs. For example, `['device0', 'device12']`.\nIf empty, this field is ignored. Maximum IDs: 10,000",
"location": "query",
"repeated": true,
"type": "string"
},
"deviceNumIds": {
"description": "A list of device numeric IDs. If empty, this field is ignored. Maximum\nIDs: 10,000.",
"format": "uint64",
"location": "query",
"repeated": true,
"type": "string"
},
"fieldMask": {
"description": "The fields of the `Device` resource to be returned in the response. The\nfields `id` and `num_id` are always returned, along with any\nother fields specified.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"gatewayListOptions.associationsDeviceId": {
"description": "If set, returns only the gateways with which the specified device is\nassociated. The device ID can be numeric (`num_id`) or the user-defined\nstring (`id`). For example, if `456` is specified, returns only the\ngateways to which the device with `num_id` 456 is bound.",
"location": "query",
"type": "string"
},
"gatewayListOptions.associationsGatewayId": {
"description": "If set, only devices associated with the specified gateway are returned.\nThe gateway ID can be numeric (`num_id`) or the user-defined string\n(`id`). For example, if `123` is specified, only devices bound to the\ngateway with `num_id` 123 are returned.",
"location": "query",
"type": "string"
},
"gatewayListOptions.gatewayType": {
"description": "If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY`\nis specified, only non-gateway devices are returned. If\n`GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.",
"enum": [
"GATEWAY_TYPE_UNSPECIFIED",
"GATEWAY",
"NON_GATEWAY"
],
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested. A non-empty `next_page_token` in the response\nindicates that more data is available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call and\nthe system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/devices",
"response": {
"$ref": "ListDevicesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"modifyCloudToDeviceConfig": {
"description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}:modifyCloudToDeviceConfig",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.devices.modifyCloudToDeviceConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:modifyCloudToDeviceConfig",
"request": {
"$ref": "ModifyCloudToDeviceConfigRequest"
},
"response": {
"$ref": "DeviceConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"patch": {
"description": "Updates a device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}",
"httpMethod": "PATCH",
"id": "cloudiot.projects.locations.registries.groups.devices.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `blocked`, and `metadata`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Device"
},
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"sendCommandToDevice": {
"description": "Sends a command to the specified device. In order for a device to be able\nto receive commands, it must:\n1) be connected to Cloud IoT Core using the MQTT protocol, and\n2) be subscribed to the group of MQTT topics specified by\n /devices/{device-id}/commands/#. This subscription will receive commands\n at the top-level topic /devices/{device-id}/commands as well as commands\n for subfolders, like /devices/{device-id}/commands/subfolder.\n Note that subscribing to specific subfolders is not supported.\nIf the command could not be delivered to the device, this method will\nreturn an error; in particular, if the device is not subscribed, this\nmethod will return FAILED_PRECONDITION. Otherwise, this method will\nreturn OK. If the subscription is QoS 1, at least once delivery will be\nguaranteed; for QoS 0, no acknowledgment will be expected from the device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}:sendCommandToDevice",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.devices.sendCommandToDevice",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:sendCommandToDevice",
"request": {
"$ref": "SendCommandToDeviceRequest"
},
"response": {
"$ref": "SendCommandToDeviceResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
},
"resources": {
"configVersions": {
"methods": {
"list": {
"description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}/configVersions",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.groups.devices.configVersions.list",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
},
"numVersions": {
"description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}/configVersions",
"response": {
"$ref": "ListDeviceConfigVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
}
},
"states": {
"methods": {
"list": {
"description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}/states",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.groups.devices.states.list",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
},
"numStates": {
"description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}/states",
"response": {
"$ref": "ListDeviceStatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"revision": "20190321",
"rootUrl": "https://cloudiot.googleapis.com/",
"schemas": {
"BindDeviceToGatewayRequest": {
"description": "Request for `BindDeviceToGateway`.",
"id": "BindDeviceToGatewayRequest",
"properties": {
"deviceId": {
"description": "The device to associate with the specified gateway. The value of\n`device_id` can be either the device numeric ID or the user-defined device\nidentifier.",
"type": "string"
},
"gatewayId": {
"description": "The value of `gateway_id` can be either the device numeric ID or the\nuser-defined device identifier.",
"type": "string"
}
},
"type": "object"
},
"BindDeviceToGatewayResponse": {
"description": "Response for `BindDeviceToGateway`.",
"id": "BindDeviceToGatewayResponse",
"properties": {},
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
"type": "object"
},
"Device": {
"description": "The device resource.",
"id": "Device",
"properties": {
"blocked": {
"description": "If a device is blocked, connections or requests from this device will fail.\nCan be used to temporarily prevent the device from connecting if, for\nexample, the sensor is generating bad data and needs maintenance.",
"type": "boolean"
},
"config": {
"$ref": "DeviceConfig",
"description": "The most recent device configuration, which is eventually sent from\nCloud IoT Core to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method."
},
"credentials": {
"description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time. When new credentials are added to a device, they are verified\nagainst the registry credentials. For details, see the description of the\n`DeviceRegistry.credentials` field.",
"items": {
"$ref": "DeviceCredential"
},
"type": "array"
},
"gatewayConfig": {
"$ref": "GatewayConfig",
"description": "Gateway-related configuration and state."
},
"id": {
"description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.",
"type": "string"
},
"lastConfigAckTime": {
"description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device. This field is only for configurations\nsent through MQTT.",
"format": "google-datetime",
"type": "string"
},
"lastConfigSendTime": {
"description": "[Output only] The last time a cloud-to-device config version was sent to\nthe device.",
"format": "google-datetime",
"type": "string"
},
"lastErrorStatus": {
"$ref": "Status",
"description": "[Output only] The error message of the most recent error, such as a failure\nto publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this\nfield. If no errors have occurred, this field has an empty message\nand the status code 0 == OK. Otherwise, this field is expected to have a\nstatus code other than OK."
},
"lastErrorTime": {
"description": "[Output only] The time the most recent error occurred, such as a failure to\npublish to Cloud Pub/Sub. This field is the timestamp of\n'last_error_status'.",
"format": "google-datetime",
"type": "string"
},
"lastEventTime": {
"description": "[Output only] The last time a telemetry event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
"format": "google-datetime",
"type": "string"
},
"lastHeartbeatTime": {
"description": "[Output only] The last time an MQTT `PINGREQ` was received. This field\napplies only to devices connecting through MQTT. MQTT clients usually only\nsend `PINGREQ` messages if the connection is idle, and no other messages\nhave been sent. Timestamps are periodically collected and written to\nstorage; they may be stale by a few minutes.",
"format": "google-datetime",
"type": "string"
},
"lastStateTime": {
"description": "[Output only] The last time a state event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
"format": "google-datetime",
"type": "string"
},
"logLevel": {
"description": "**Beta Feature**\n\nThe logging verbosity for device activity. If unspecified,\nDeviceRegistry.log_level will be used.",
"enum": [
"LOG_LEVEL_UNSPECIFIED",
"NONE",
"ERROR",
"INFO",
"DEBUG"
],
"enumDescriptions": [
"No logging specified. If not specified, logging will be disabled.",
"Disables logging.",
"Error events will be logged.",
"Informational events will be logged, such as connections and\ndisconnections.",
"All events will be logged."
],
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "The metadata key-value pairs assigned to the device. This metadata is not\ninterpreted or indexed by Cloud IoT Core. It can be used to add contextual\ninformation for the device.\n\nKeys must conform to the regular expression a-zA-Z+ and\nbe less than 128 bytes in length.\n\nValues are free-form strings. Each value must be less than or equal to 32\nKB in size.\n\nThe total size of all keys and values must be less than 256 KB, and the\nmaximum number of key-value pairs is 500.",
"type": "object"
},
"name": {
"description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
"type": "string"
},
"numId": {
"description": "[Output only] A server-defined unique numeric ID for the device. This is a\nmore compact way to identify devices, and it is globally unique.",
"format": "uint64",
"type": "string"
},
"state": {
"$ref": "DeviceState",
"description": "[Output only] The state most recently received from the device. If no state\nhas been reported, this field is not present."
}
},
"type": "object"
},
"DeviceConfig": {
"description": "The device configuration. Eventually delivered to devices.",
"id": "DeviceConfig",
"properties": {
"binaryData": {
"description": "The device configuration data.",
"format": "byte",
"type": "string"
},
"cloudUpdateTime": {
"description": "[Output only] The time at which this configuration version was updated in\nCloud IoT Core. This timestamp is set by the server.",
"format": "google-datetime",
"type": "string"
},
"deviceAckTime": {
"description": "[Output only] The time at which Cloud IoT Core received the\nacknowledgment from the device, indicating that the device has received\nthis configuration version. If this field is not present, the device has\nnot yet acknowledged that it received this version. Note that when\nthe config was sent to the device, many config versions may have been\navailable in Cloud IoT Core while the device was disconnected, and on\nconnection, only the latest version is sent to the device. Some\nversions may never be sent to the device, and therefore are never\nacknowledged. This timestamp is set by Cloud IoT Core.",
"format": "google-datetime",
"type": "string"
},
"version": {
"description": "[Output only] The version of this update. The version number is assigned by\nthe server, and is always greater than 0 after device creation. The\nversion must be 0 on the `CreateDevice` request if a `config` is\nspecified; the response of `CreateDevice` will always have a value of 1.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"DeviceCredential": {
"description": "A server-stored device credential used for authentication.",
"id": "DeviceCredential",
"properties": {
"expirationTime": {
"description": "[Optional] The time at which this credential becomes invalid. This\ncredential will be ignored for new client authentication requests after\nthis timestamp; however, it will not be automatically deleted.",
"format": "google-datetime",
"type": "string"
},
"publicKey": {
"$ref": "PublicKeyCredential",
"description": "A public key used to verify the signature of JSON Web Tokens (JWTs).\nWhen adding a new device credential, either via device creation or via\nmodifications, this public key credential may be required to be signed by\none of the registry level certificates. More specifically, if the\nregistry contains at least one certificate, any new device credential\nmust be signed by one of the registry certificates. As a result,\nwhen the registry contains certificates, only X.509 certificates are\naccepted as device credentials. However, if the registry does\nnot contain a certificate, self-signed certificates and public keys will\nbe accepted. New device credentials must be different from every\nregistry-level certificate."
}
},
"type": "object"
},
"DeviceRegistry": {
"description": "A container for a group of devices.",
"id": "DeviceRegistry",
"properties": {
"credentials": {
"description": "The credentials used to verify the device credentials. No more than 10\ncredentials can be bound to a single registry at a time. The verification\nprocess occurs at the time of device creation or update. If this field is\nempty, no verification is performed. Otherwise, the credentials of a newly\ncreated device or added credentials of an updated device should be signed\nwith one of these registry credentials.\n\nNote, however, that existing devices will never be affected by\nmodifications to this list of credentials: after a device has been\nsuccessfully created in a registry, it should be able to connect even if\nits registry credentials are revoked, deleted, or modified.",
"items": {
"$ref": "RegistryCredential"
},
"type": "array"
},
"eventNotificationConfigs": {
"description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. If multiple configurations match a message,\nonly the first matching configuration is used. If you try to publish a\ndevice telemetry event using MQTT without specifying a Cloud Pub/Sub topic\nfor the device's registry, the connection closes automatically. If you try\nto do so using an HTTP connection, an error is returned. Up to 10\nconfigurations may be provided.",
"items": {
"$ref": "EventNotificationConfig"
},
"type": "array"
},
"httpConfig": {
"$ref": "HttpConfig",
"description": "The DeviceService (HTTP) configuration for this device registry."
},
"id": {
"description": "The identifier of this device registry. For example, `myRegistry`.",
"type": "string"
},
"logLevel": {
"description": "**Beta Feature**\n\nThe default logging verbosity for activity from devices in this registry.\nThe verbosity level can be overridden by Device.log_level.",
"enum": [
"LOG_LEVEL_UNSPECIFIED",
"NONE",
"ERROR",
"INFO",
"DEBUG"
],
"enumDescriptions": [
"No logging specified. If not specified, logging will be disabled.",
"Disables logging.",
"Error events will be logged.",
"Informational events will be logged, such as connections and\ndisconnections.",
"All events will be logged."
],
"type": "string"
},
"mqttConfig": {
"$ref": "MqttConfig",
"description": "The MQTT configuration for this device registry."
},
"name": {
"description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"type": "string"
},
"stateNotificationConfig": {
"$ref": "StateNotificationConfig",
"description": "The configuration for notification of new states received from the device.\nState updates are guaranteed to be stored in the state history, but\nnotifications to Cloud Pub/Sub are not guaranteed. For example, if\npermissions are misconfigured or the specified topic doesn't exist, no\nnotification will be published but the state will still be stored in Cloud\nIoT Core."
}
},
"type": "object"
},
"DeviceState": {
"description": "The device state, as reported by the device.",
"id": "DeviceState",
"properties": {
"binaryData": {
"description": "The device state data.",
"format": "byte",
"type": "string"
},
"updateTime": {
"description": "[Output only] The time at which this state version was updated in Cloud\nIoT Core.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"EventNotificationConfig": {
"description": "The configuration for forwarding telemetry events.",
"id": "EventNotificationConfig",
"properties": {
"pubsubTopicName": {
"description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
"type": "string"
},
"subfolderMatches": {
"description": "If the subfolder name matches this string exactly, this configuration will\nbe used. The string must not include the leading '/' character. If empty,\nall strings are matched. This field is used only for telemetry events;\nsubfolders are not supported for state changes.",
"type": "string"
}
},
"type": "object"
},
"Expr": {
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"id": "Expr",
"properties": {
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type": "string"
},
"location": {
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
"type": "string"
}
},
"type": "object"
},
"GatewayConfig": {
"description": "Gateway-related configuration and state.",
"id": "GatewayConfig",
"properties": {
"gatewayAuthMethod": {
"description": "Indicates how to authorize and/or authenticate devices to access the\ngateway.",
"enum": [
"GATEWAY_AUTH_METHOD_UNSPECIFIED",
"ASSOCIATION_ONLY",
"DEVICE_AUTH_TOKEN_ONLY",
"ASSOCIATION_AND_DEVICE_AUTH_TOKEN"
],
"enumDescriptions": [
"No authentication/authorization method specified. No devices are allowed to\naccess the gateway.",
"The device is authenticated through the gateway association only. Device\ncredentials are ignored even if provided.",
"The device is authenticated through its own credentials. Gateway\nassociation is not checked.",
"The device is authenticated through both device credentials and gateway\nassociation. The device must be bound to the gateway and must provide its\nown credentials."
],
"type": "string"
},
"gatewayType": {
"description": "Indicates whether the device is a gateway.",
"enum": [
"GATEWAY_TYPE_UNSPECIFIED",
"GATEWAY",
"NON_GATEWAY"
],
"enumDescriptions": [
"If unspecified, the device is considered a non-gateway device.",
"The device is a gateway.",
"The device is not a gateway."
],
"type": "string"
},
"lastAccessedGatewayId": {
"description": "[Output only] The ID of the gateway the device accessed most recently.",
"type": "string"
},
"lastAccessedGatewayTime": {
"description": "[Output only] The most recent time at which the device accessed the gateway\nspecified in `last_accessed_gateway`.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
"id": "GetIamPolicyRequest",
"properties": {},
"type": "object"
},
"HttpConfig": {
"description": "The configuration of the HTTP bridge for a device registry.",
"id": "HttpConfig",
"properties": {
"httpEnabledState": {
"description": "If enabled, allows devices to use DeviceService via the HTTP protocol.\nOtherwise, any requests to DeviceService will fail for this registry.",
"enum": [
"HTTP_STATE_UNSPECIFIED",
"HTTP_ENABLED",
"HTTP_DISABLED"
],
"enumDescriptions": [
"No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
"Enables DeviceService (HTTP) service for the registry.",
"Disables DeviceService (HTTP) service for the registry."
],
"type": "string"
}
},
"type": "object"
},
"ListDeviceConfigVersionsResponse": {
"description": "Response for `ListDeviceConfigVersions`.",
"id": "ListDeviceConfigVersionsResponse",
"properties": {
"deviceConfigs": {
"description": "The device configuration for the last few versions. Versions are listed\nin decreasing order, starting from the most recent one.",
"items": {
"$ref": "DeviceConfig"
},
"type": "array"
}
},
"type": "object"
},
"ListDeviceRegistriesResponse": {
"description": "Response for `ListDeviceRegistries`.",
"id": "ListDeviceRegistriesResponse",
"properties": {
"deviceRegistries": {
"description": "The registries that matched the query.",
"items": {
"$ref": "DeviceRegistry"
},
"type": "array"
},
"nextPageToken": {
"description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.",
"type": "string"
}
},
"type": "object"
},
"ListDeviceStatesResponse": {
"description": "Response for `ListDeviceStates`.",
"id": "ListDeviceStatesResponse",
"properties": {
"deviceStates": {
"description": "The last few device states. States are listed in descending order of server\nupdate time, starting from the most recent one.",
"items": {
"$ref": "DeviceState"
},
"type": "array"
}
},
"type": "object"
},
"ListDevicesResponse": {
"description": "Response for `ListDevices`.",
"id": "ListDevicesResponse",
"properties": {
"devices": {
"description": "The devices that match the request.",
"items": {
"$ref": "Device"
},
"type": "array"
},
"nextPageToken": {
"description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`.",
"type": "string"
}
},
"type": "object"
},
"ModifyCloudToDeviceConfigRequest": {
"description": "Request for `ModifyCloudToDeviceConfig`.",
"id": "ModifyCloudToDeviceConfigRequest",
"properties": {
"binaryData": {
"description": "The configuration data for the device.",
"format": "byte",
"type": "string"
},
"versionToUpdate": {
"description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"MqttConfig": {
"description": "The configuration of MQTT for a device registry.",
"id": "MqttConfig",
"properties": {
"mqttEnabledState": {
"description": "If enabled, allows connections using the MQTT protocol. Otherwise, MQTT\nconnections to this registry will fail.",
"enum": [
"MQTT_STATE_UNSPECIFIED",
"MQTT_ENABLED",
"MQTT_DISABLED"
],
"enumDescriptions": [
"No MQTT state specified. If not specified, MQTT will be enabled by default.",
"Enables a MQTT connection.",
"Disables a MQTT connection."
],
"type": "string"
}
},
"type": "object"
},
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\n**YAML Example**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Deprecated.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PublicKeyCertificate": {
"description": "A public key certificate format and data.",
"id": "PublicKeyCertificate",
"properties": {
"certificate": {
"description": "The certificate data.",
"type": "string"
},
"format": {
"description": "The certificate format.",
"enum": [
"UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT",
"X509_CERTIFICATE_PEM"
],
"enumDescriptions": [
"The format has not been specified. This is an invalid default value and\nmust not be used.",
"An X.509v3 certificate ([RFC5280](https://www.ietf.org/rfc/rfc5280.txt)),\nencoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and\n`-----END CERTIFICATE-----`."
],
"type": "string"
},
"x509Details": {
"$ref": "X509CertificateDetails",
"description": "[Output only] The certificate details. Used only for X.509 certificates."
}
},
"type": "object"
},
"PublicKeyCredential": {
"description": "A public key format and data.",
"id": "PublicKeyCredential",
"properties": {
"format": {
"description": "The format of the key.",
"enum": [
"UNSPECIFIED_PUBLIC_KEY_FORMAT",
"RSA_PEM",
"RSA_X509_PEM",
"ES256_PEM",
"ES256_X509_PEM"
],
"enumDescriptions": [
"The format has not been specified. This is an invalid default value and\nmust not be used.",
"An RSA public key encoded in base64, and wrapped by\n`-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be\nused to verify `RS256` signatures in JWT tokens ([RFC7518](\nhttps://www.ietf.org/rfc/rfc7518.txt)).",
"As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.",
"Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in\nbase64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END\nPUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256`\nalgorithm ([RFC7518](https://www.ietf.org/rfc/rfc7518.txt)). This curve is\ndefined in [OpenSSL](https://www.openssl.org/) as the `prime256v1` curve.",
"As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`."
],
"type": "string"
},
"key": {
"description": "The key data.",
"type": "string"
}
},
"type": "object"
},
"RegistryCredential": {
"description": "A server-stored registry credential used to validate device credentials.",
"id": "RegistryCredential",
"properties": {
"publicKeyCertificate": {
"$ref": "PublicKeyCertificate",
"description": "A public key certificate used to verify the device credentials."
}
},
"type": "object"
},
"SendCommandToDeviceRequest": {
"description": "Request for `SendCommandToDevice`.",
"id": "SendCommandToDeviceRequest",
"properties": {
"binaryData": {
"description": "The command data to send to the device.",
"format": "byte",
"type": "string"
},
"subfolder": {
"description": "Optional subfolder for the command. If empty, the command will be delivered\nto the /devices/{device-id}/commands topic, otherwise it will be delivered\nto the /devices/{device-id}/commands/{subfolder} topic. Multi-level\nsubfolders are allowed. This field must not have more than 256 characters,\nand must not contain any MQTT wildcards (\"+\" or \"#\") or null characters.",
"type": "string"
}
},
"type": "object"
},
"SendCommandToDeviceResponse": {
"description": "Response for `SendCommandToDevice`.",
"id": "SendCommandToDeviceResponse",
"properties": {},
"type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"id": "SetIamPolicyRequest",
"properties": {
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
"type": "object"
},
"StateNotificationConfig": {
"description": "The configuration for notification of new states received from the device.",
"id": "StateNotificationConfig",
"properties": {
"pubsubTopicName": {
"description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"id": "TestIamPermissionsRequest",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"UnbindDeviceFromGatewayRequest": {
"description": "Request for `UnbindDeviceFromGateway`.",
"id": "UnbindDeviceFromGatewayRequest",
"properties": {
"deviceId": {
"description": "The device to disassociate from the specified gateway. The value of\n`device_id` can be either the device numeric ID or the user-defined device\nidentifier.",
"type": "string"
},
"gatewayId": {
"description": "The value of `gateway_id` can be either the device numeric ID or the\nuser-defined device identifier.",
"type": "string"
}
},
"type": "object"
},
"UnbindDeviceFromGatewayResponse": {
"description": "Response for `UnbindDeviceFromGateway`.",
"id": "UnbindDeviceFromGatewayResponse",
"properties": {},
"type": "object"
},
"X509CertificateDetails": {
"description": "Details of an X.509 certificate. For informational purposes only.",
"id": "X509CertificateDetails",
"properties": {
"expiryTime": {
"description": "The time the certificate becomes invalid.",
"format": "google-datetime",
"type": "string"
},
"issuer": {
"description": "The entity that signed the certificate.",
"type": "string"
},
"publicKeyType": {
"description": "The type of public key in the certificate.",
"type": "string"
},
"signatureAlgorithm": {
"description": "The algorithm used to sign the certificate.",
"type": "string"
},
"startTime": {
"description": "The time the certificate becomes valid.",
"format": "google-datetime",
"type": "string"
},
"subject": {
"description": "The entity the certificate and public key belong to.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud IoT API",
"version": "v1",
"version_module": true
}
Reference in a new issue Copy permalink