1251 lines
64 KiB
JSON
1251 lines
64 KiB
JSON
{
|
|
"basePath": "",
|
|
"id": "cloudiot:v1beta1",
|
|
"documentationLink": "https://cloud.google.com/iot",
|
|
"revision": "20170922",
|
|
"discoveryVersion": "v1",
|
|
"version_module": true,
|
|
"schemas": {
|
|
"NotificationConfig": {
|
|
"id": "NotificationConfig",
|
|
"description": "Configuration to forward messages such as telemetry events.",
|
|
"type": "object",
|
|
"properties": {
|
|
"pubsubTopicName": {
|
|
"description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"HttpPublishEventRequest": {
|
|
"description": "Request for `PublishEvent`.",
|
|
"type": "object",
|
|
"properties": {
|
|
"subFolder": {
|
|
"description": "Optional subfolder for the telemetry event. This can be used to classify\ntypes of events, and is included in the Pub/Sub message attributes.",
|
|
"type": "string"
|
|
},
|
|
"binaryData": {
|
|
"format": "byte",
|
|
"description": "Payload data in binary format.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "HttpPublishEventRequest"
|
|
},
|
|
"Device": {
|
|
"description": "The device resource.",
|
|
"type": "object",
|
|
"properties": {
|
|
"enabledState": {
|
|
"description": "If a device is disabled, communication from it will be blocked. Can be used\nto temporarily prevent the device from connecting if, for example, the\nsensor is generating bad data and needs maintenance.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"No enabled state specified. If not specified, defaults to enabled\n(communication to Cloud IoT Core allowed).",
|
|
"Enables a device. By default, devices are enabled, allowing communication\nfrom the device to Cloud IoT Core. When a device is disabled, it is blocked\nfrom communicating with Cloud IoT Core.",
|
|
"Disables a device, blocking all communication from it to Cloud IoT Core."
|
|
],
|
|
"enum": [
|
|
"UNSPECIFIED_ENABLED_STATE",
|
|
"DEVICE_ENABLED",
|
|
"DEVICE_DISABLED"
|
|
]
|
|
},
|
|
"id": {
|
|
"description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.",
|
|
"type": "string"
|
|
},
|
|
"lastHeartbeatTime": {
|
|
"format": "google-datetime",
|
|
"description": "[Output only] The last time a heartbeat was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
|
|
"type": "string"
|
|
},
|
|
"lastEventTime": {
|
|
"format": "google-datetime",
|
|
"description": "[Output only] The last time an event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
|
|
"type": "string"
|
|
},
|
|
"lastErrorStatus": {
|
|
"description": "[Output only] The error message of the last error, e.g., failed to publish\nto Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no\nerrors are present, this will have an empty message (whose status code is\n0 == OK), otherwise this field is expected to have a not-OK status code.",
|
|
"$ref": "Status"
|
|
},
|
|
"lastConfigAckTime": {
|
|
"format": "google-datetime",
|
|
"description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device.",
|
|
"type": "string"
|
|
},
|
|
"numId": {
|
|
"format": "uint64",
|
|
"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.",
|
|
"type": "string"
|
|
},
|
|
"config": {
|
|
"$ref": "DeviceConfig",
|
|
"description": "The most recent device configuration, which is eventually sent from the\nCloud IoT Core service 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."
|
|
},
|
|
"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"
|
|
},
|
|
"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.",
|
|
"items": {
|
|
"$ref": "DeviceCredential"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"lastErrorTime": {
|
|
"format": "google-datetime",
|
|
"description": "[Output only] The last time an error happened, e.g., failed to publish to\nCloud Pub/Sub. This field is the timestamp of 'last_error_status'.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "Device"
|
|
},
|
|
"HttpSetDeviceStateRequest": {
|
|
"description": "Request for `SetDeviceState`.",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"$ref": "HttpDeviceState",
|
|
"description": "The device state."
|
|
}
|
|
},
|
|
"id": "HttpSetDeviceStateRequest"
|
|
},
|
|
"ListDeviceConfigVersionsResponse": {
|
|
"id": "ListDeviceConfigVersionsResponse",
|
|
"description": "Response for `ListDeviceConfigVersions`.",
|
|
"type": "object",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"SetIamPolicyRequest": {
|
|
"description": "Request message for `SetIamPolicy` method.",
|
|
"type": "object",
|
|
"properties": {
|
|
"updateMask": {
|
|
"format": "google-fieldmask",
|
|
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
|
|
"type": "string"
|
|
},
|
|
"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."
|
|
}
|
|
},
|
|
"id": "SetIamPolicyRequest"
|
|
},
|
|
"HttpDeviceState": {
|
|
"id": "HttpDeviceState",
|
|
"description": "The device state reported to Cloud IoT Core.",
|
|
"type": "object",
|
|
"properties": {
|
|
"binaryData": {
|
|
"format": "byte",
|
|
"description": "Data in binary format.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"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 `{}`.",
|
|
"type": "object",
|
|
"properties": {},
|
|
"id": "Empty"
|
|
},
|
|
"DeviceConfigData": {
|
|
"id": "DeviceConfigData",
|
|
"description": "The data for a device configuration. Only binary data is currently supported.",
|
|
"type": "object",
|
|
"properties": {
|
|
"binaryData": {
|
|
"format": "byte",
|
|
"description": "The configuration sent to the device, as bytes.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"PublicKeyCredential": {
|
|
"description": "A public key format and data.",
|
|
"type": "object",
|
|
"properties": {
|
|
"key": {
|
|
"description": "The key data.",
|
|
"type": "string"
|
|
},
|
|
"format": {
|
|
"enumDescriptions": [
|
|
"The format has not been specified. This is an invalid default value and\nmust not be used.",
|
|
"An RSA public key wrapped in a X.509v3 certificate\n[RFC5280](https://www.ietf.org/rfc/rfc5280.txt), encoded in base64, and\nwrapped by `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.\nThis can be used to verify `RS256` signatures in JWT tokens\n[RFC7518](https://www.ietf.org/rfc/rfc7518.txt).",
|
|
"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."
|
|
],
|
|
"enum": [
|
|
"UNSPECIFIED_PUBLIC_KEY_FORMAT",
|
|
"RSA_X509_PEM",
|
|
"ES256_PEM"
|
|
],
|
|
"description": "The format of the key.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "PublicKeyCredential"
|
|
},
|
|
"AuditLogConfig": {
|
|
"id": "AuditLogConfig",
|
|
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
|
"type": "object",
|
|
"properties": {
|
|
"exemptedMembers": {
|
|
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"logType": {
|
|
"description": "The log type that this config enables.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"Default case. Should never be this.",
|
|
"Admin reads. Example: CloudIAM getIamPolicy",
|
|
"Data writes. Example: CloudSQL Users create",
|
|
"Data reads. Example: CloudSQL Users list"
|
|
],
|
|
"enum": [
|
|
"LOG_TYPE_UNSPECIFIED",
|
|
"ADMIN_READ",
|
|
"DATA_WRITE",
|
|
"DATA_READ"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"TestIamPermissionsRequest": {
|
|
"id": "TestIamPermissionsRequest",
|
|
"description": "Request message for `TestIamPermissions` method.",
|
|
"type": "object",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"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**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\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"format": "int32",
|
|
"description": "Version of the `Policy`. The default version is 0.",
|
|
"type": "integer"
|
|
},
|
|
"auditConfigs": {
|
|
"description": "Specifies cloud audit logging configuration for this policy.",
|
|
"items": {
|
|
"$ref": "AuditConfig"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"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"
|
|
},
|
|
"iamOwned": {
|
|
"type": "boolean"
|
|
},
|
|
"etag": {
|
|
"format": "byte",
|
|
"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.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "Policy"
|
|
},
|
|
"ListDeviceRegistriesResponse": {
|
|
"id": "ListDeviceRegistriesResponse",
|
|
"description": "Response for `ListDeviceRegistries`.",
|
|
"type": "object",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"DeviceRegistry": {
|
|
"id": "DeviceRegistry",
|
|
"description": "A container for a group of devices.",
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"description": "The identifier of this device registry. For example, `myRegistry`.",
|
|
"type": "string"
|
|
},
|
|
"mqttConfig": {
|
|
"description": "The configuration of the MQTT broker associated with this device registry,\nincluding enablement, payload data format type, etc.",
|
|
"$ref": "MqttConfig"
|
|
},
|
|
"name": {
|
|
"description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
|
"type": "string"
|
|
},
|
|
"eventNotificationConfig": {
|
|
"description": "Configuration to notify events received from the device.",
|
|
"$ref": "NotificationConfig"
|
|
}
|
|
}
|
|
},
|
|
"ListDevicesResponse": {
|
|
"id": "ListDevicesResponse",
|
|
"description": "Response for `ListDevices`.",
|
|
"type": "object",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"AuditConfig": {
|
|
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
|
"type": "object",
|
|
"properties": {
|
|
"exemptedMembers": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"service": {
|
|
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
|
|
"type": "string"
|
|
},
|
|
"auditLogConfigs": {
|
|
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
|
|
"items": {
|
|
"$ref": "AuditLogConfig"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"id": "AuditConfig"
|
|
},
|
|
"DeviceCredential": {
|
|
"description": "A server-stored device credential used for authentication.",
|
|
"type": "object",
|
|
"properties": {
|
|
"expirationTime": {
|
|
"format": "google-datetime",
|
|
"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.",
|
|
"type": "string"
|
|
},
|
|
"publicKey": {
|
|
"$ref": "PublicKeyCredential",
|
|
"description": "A public key used to verify the signature of JSON Web Tokens (JWTs)."
|
|
}
|
|
},
|
|
"id": "DeviceCredential"
|
|
},
|
|
"DeviceConfig": {
|
|
"id": "DeviceConfig",
|
|
"description": "The device configuration and its metadata. Eventually delivered to devices.",
|
|
"type": "object",
|
|
"properties": {
|
|
"deviceAckTime": {
|
|
"format": "google-datetime",
|
|
"description": "[Output only] The time when the Cloud IoT Core server 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 sending\nthe config to the device, there may have been many config versions on the\nCloud IoT Core service while the device was disconnected; and on\nconnection, only the latest version is sent to the device. Some of the\nversions may never be sent to the device, and therefore are never\nacknowledged. This timestamp is set by the Cloud IoT Core service.",
|
|
"type": "string"
|
|
},
|
|
"cloudUpdateTime": {
|
|
"format": "google-datetime",
|
|
"description": "[Output only] The time when this version state was updated in the Cloud IoT\nCore service. This timestamp is set by the server.",
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"format": "int64",
|
|
"description": "[Output only] The version of this update. The version number is assigned by\nthe server, and is always greater than zero after device creation. The\nversion must be zero on the `CreateDevice` request if a `config` is\nspecified; the response of `CreateDevice` will always have a value of one.",
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"$ref": "DeviceConfigData",
|
|
"description": "The device configuration data."
|
|
}
|
|
}
|
|
},
|
|
"MqttConfig": {
|
|
"description": "The configuration of MQTT for a device registry.",
|
|
"type": "object",
|
|
"properties": {
|
|
"mqttConfigState": {
|
|
"description": "If enabled, allows connections using the MQTT protocol. Otherwise any MQTT\nconnection to this registry will fail.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"No MQTT state specified. If not specified, MQTT will be enabled by default.",
|
|
"Enables a MQTT connection.",
|
|
"Disables a MQTT connection."
|
|
],
|
|
"enum": [
|
|
"UNSPECIFIED_MQTT_STATE",
|
|
"MQTT_ENABLED",
|
|
"MQTT_DISABLED"
|
|
]
|
|
}
|
|
},
|
|
"id": "MqttConfig"
|
|
},
|
|
"Status": {
|
|
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[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 message,\nand 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.",
|
|
"type": "object",
|
|
"properties": {
|
|
"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"
|
|
},
|
|
"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"
|
|
},
|
|
"code": {
|
|
"format": "int32",
|
|
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"id": "Status"
|
|
},
|
|
"Binding": {
|
|
"id": "Binding",
|
|
"description": "Associates `members` with a `role`.",
|
|
"type": "object",
|
|
"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.\nThis field is GOOGLE_INTERNAL."
|
|
},
|
|
"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` or `joe@example.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}`: A Google Apps domain name 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`.\nRequired",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Expr": {
|
|
"id": "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\"",
|
|
"type": "object",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"HttpPublishEventResponse": {
|
|
"description": "Response for `PublishEvent`.",
|
|
"type": "object",
|
|
"properties": {},
|
|
"id": "HttpPublishEventResponse"
|
|
},
|
|
"ModifyCloudToDeviceConfigRequest": {
|
|
"description": "Request for `ModifyCloudToDeviceConfig`.",
|
|
"type": "object",
|
|
"properties": {
|
|
"versionToUpdate": {
|
|
"format": "int64",
|
|
"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.",
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"$ref": "DeviceConfigData",
|
|
"description": "The configuration data for the device."
|
|
}
|
|
},
|
|
"id": "ModifyCloudToDeviceConfigRequest"
|
|
},
|
|
"GetIamPolicyRequest": {
|
|
"id": "GetIamPolicyRequest",
|
|
"description": "Request message for `GetIamPolicy` method.",
|
|
"type": "object",
|
|
"properties": {}
|
|
},
|
|
"TestIamPermissionsResponse": {
|
|
"id": "TestIamPermissionsResponse",
|
|
"description": "Response message for `TestIamPermissions` method.",
|
|
"type": "object",
|
|
"properties": {
|
|
"permissions": {
|
|
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"HttpDeviceConfig": {
|
|
"description": "The device configuration obtained from Cloud IoT Core.",
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"format": "int64",
|
|
"description": "The version of the configuration in Cloud IoT Core.",
|
|
"type": "string"
|
|
},
|
|
"binaryData": {
|
|
"format": "byte",
|
|
"description": "Data in binary format.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "HttpDeviceConfig"
|
|
}
|
|
},
|
|
"icons": {
|
|
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
|
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
|
},
|
|
"protocol": "rest",
|
|
"canonicalName": "Cloud Iot",
|
|
"auth": {
|
|
"oauth2": {
|
|
"scopes": {
|
|
"https://www.googleapis.com/auth/cloudiot": {
|
|
"description": "Register and manage devices in the Google Cloud IoT service"
|
|
},
|
|
"https://www.googleapis.com/auth/cloud-platform": {
|
|
"description": "View and manage your data across Google Cloud Platform services"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"rootUrl": "https://cloudiot.googleapis.com/",
|
|
"ownerDomain": "google.com",
|
|
"name": "cloudiot",
|
|
"batchPath": "batch",
|
|
"title": "Google Cloud IoT API",
|
|
"ownerName": "Google",
|
|
"resources": {
|
|
"projects": {
|
|
"resources": {
|
|
"locations": {
|
|
"resources": {
|
|
"registries": {
|
|
"methods": {
|
|
"delete": {
|
|
"path": "v1beta1/{+name}",
|
|
"id": "cloudiot.projects.locations.registries.delete",
|
|
"description": "Deletes a device registry configuration.",
|
|
"httpMethod": "DELETE",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}"
|
|
},
|
|
"list": {
|
|
"path": "v1beta1/{+parent}/registries",
|
|
"id": "cloudiot.projects.locations.registries.list",
|
|
"description": "Lists device registries.",
|
|
"httpMethod": "GET",
|
|
"response": {
|
|
"$ref": "ListDeviceRegistriesResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"parameters": {
|
|
"pageToken": {
|
|
"description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call, and\nthat the system should return the next page of data.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"pageSize": {
|
|
"format": "int32",
|
|
"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, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
|
|
"type": "integer",
|
|
"location": "query"
|
|
},
|
|
"parent": {
|
|
"description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries"
|
|
},
|
|
"create": {
|
|
"parameters": {
|
|
"parent": {
|
|
"description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries",
|
|
"path": "v1beta1/{+parent}/registries",
|
|
"id": "cloudiot.projects.locations.registries.create",
|
|
"description": "Creates a device registry that contains devices.",
|
|
"request": {
|
|
"$ref": "DeviceRegistry"
|
|
},
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"response": {
|
|
"$ref": "DeviceRegistry"
|
|
}
|
|
},
|
|
"setIamPolicy": {
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"parameters": {
|
|
"resource": {
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
|
"location": "path",
|
|
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
|
|
"path": "v1beta1/{+resource}:setIamPolicy",
|
|
"id": "cloudiot.projects.locations.registries.setIamPolicy",
|
|
"request": {
|
|
"$ref": "SetIamPolicyRequest"
|
|
},
|
|
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"resource"
|
|
],
|
|
"response": {
|
|
"$ref": "Policy"
|
|
}
|
|
},
|
|
"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.",
|
|
"request": {
|
|
"$ref": "GetIamPolicyRequest"
|
|
},
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"resource"
|
|
],
|
|
"response": {
|
|
"$ref": "Policy"
|
|
},
|
|
"parameters": {
|
|
"resource": {
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
|
"location": "path",
|
|
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
|
|
"path": "v1beta1/{+resource}:getIamPolicy",
|
|
"id": "cloudiot.projects.locations.registries.getIamPolicy"
|
|
},
|
|
"patch": {
|
|
"path": "v1beta1/{+name}",
|
|
"id": "cloudiot.projects.locations.registries.patch",
|
|
"request": {
|
|
"$ref": "DeviceRegistry"
|
|
},
|
|
"description": "Updates a device registry configuration.",
|
|
"httpMethod": "PATCH",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"response": {
|
|
"$ref": "DeviceRegistry"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"parameters": {
|
|
"name": {
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
|
"location": "path",
|
|
"description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
|
"type": "string",
|
|
"required": true
|
|
},
|
|
"updateMask": {
|
|
"location": "query",
|
|
"format": "google-fieldmask",
|
|
"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` and `mqtt_config`",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}"
|
|
},
|
|
"get": {
|
|
"httpMethod": "GET",
|
|
"response": {
|
|
"$ref": "DeviceRegistry"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
|
|
"path": "v1beta1/{+name}",
|
|
"id": "cloudiot.projects.locations.registries.get",
|
|
"description": "Gets a device registry configuration."
|
|
},
|
|
"testIamPermissions": {
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"resource"
|
|
],
|
|
"response": {
|
|
"$ref": "TestIamPermissionsResponse"
|
|
},
|
|
"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.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
|
|
"path": "v1beta1/{+resource}:testIamPermissions",
|
|
"id": "cloudiot.projects.locations.registries.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.",
|
|
"request": {
|
|
"$ref": "TestIamPermissionsRequest"
|
|
}
|
|
}
|
|
},
|
|
"resources": {
|
|
"devices": {
|
|
"methods": {
|
|
"delete": {
|
|
"id": "cloudiot.projects.locations.registries.devices.delete",
|
|
"path": "v1beta1/{+name}",
|
|
"description": "Deletes a device.",
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "DELETE",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"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}`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}"
|
|
},
|
|
"list": {
|
|
"parameters": {
|
|
"pageToken": {
|
|
"location": "query",
|
|
"description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data.",
|
|
"type": "string"
|
|
},
|
|
"fieldMask": {
|
|
"format": "google-fieldmask",
|
|
"description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"pageSize": {
|
|
"location": "query",
|
|
"format": "int32",
|
|
"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, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
|
"location": "path",
|
|
"description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
|
|
"type": "string",
|
|
"required": true
|
|
},
|
|
"deviceIds": {
|
|
"repeated": true,
|
|
"location": "query",
|
|
"description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries.",
|
|
"type": "string"
|
|
},
|
|
"deviceNumIds": {
|
|
"repeated": true,
|
|
"location": "query",
|
|
"format": "uint64",
|
|
"description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
|
|
"path": "v1beta1/{+parent}/devices",
|
|
"id": "cloudiot.projects.locations.registries.devices.list",
|
|
"description": "List devices in a device registry.",
|
|
"httpMethod": "GET",
|
|
"response": {
|
|
"$ref": "ListDevicesResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
]
|
|
},
|
|
"create": {
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"response": {
|
|
"$ref": "Device"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"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`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
|
|
"path": "v1beta1/{+parent}/devices",
|
|
"id": "cloudiot.projects.locations.registries.devices.create",
|
|
"request": {
|
|
"$ref": "Device"
|
|
},
|
|
"description": "Creates a device in a device registry."
|
|
},
|
|
"modifyCloudToDeviceConfig": {
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"response": {
|
|
"$ref": "DeviceConfig"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"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}`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
|
|
"path": "v1beta1/{+name}:modifyCloudToDeviceConfig",
|
|
"id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
|
|
"request": {
|
|
"$ref": "ModifyCloudToDeviceConfigRequest"
|
|
},
|
|
"description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT servers. Returns the modified configuration version and its\nmeta-data."
|
|
},
|
|
"publishEvent": {
|
|
"response": {
|
|
"$ref": "HttpPublishEventResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "POST",
|
|
"parameters": {
|
|
"name": {
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
|
"location": "path",
|
|
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0`.",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:publishEvent",
|
|
"id": "cloudiot.projects.locations.registries.devices.publishEvent",
|
|
"path": "v1beta1/{+name}:publishEvent",
|
|
"request": {
|
|
"$ref": "HttpPublishEventRequest"
|
|
},
|
|
"description": "Publishes a telemetry event for a device."
|
|
},
|
|
"get": {
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"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}`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
|
|
"path": "v1beta1/{+name}",
|
|
"id": "cloudiot.projects.locations.registries.devices.get",
|
|
"description": "Gets details about a device.",
|
|
"httpMethod": "GET",
|
|
"response": {
|
|
"$ref": "Device"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
]
|
|
},
|
|
"patch": {
|
|
"path": "v1beta1/{+name}",
|
|
"id": "cloudiot.projects.locations.registries.devices.patch",
|
|
"description": "Updates a device.",
|
|
"request": {
|
|
"$ref": "Device"
|
|
},
|
|
"httpMethod": "PATCH",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"response": {
|
|
"$ref": "Device"
|
|
},
|
|
"parameters": {
|
|
"name": {
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
|
"location": "path",
|
|
"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",
|
|
"required": true
|
|
},
|
|
"updateMask": {
|
|
"location": "query",
|
|
"format": "google-fieldmask",
|
|
"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` and `enabled_state`",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}"
|
|
},
|
|
"setState": {
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "POST",
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:setState",
|
|
"id": "cloudiot.projects.locations.registries.devices.setState",
|
|
"path": "v1beta1/{+name}:setState",
|
|
"description": "Sets the state of a device.",
|
|
"request": {
|
|
"$ref": "HttpSetDeviceStateRequest"
|
|
}
|
|
},
|
|
"getConfig": {
|
|
"path": "v1beta1/{+name}/config",
|
|
"id": "cloudiot.projects.locations.registries.devices.getConfig",
|
|
"description": "Gets the configuration of a device.",
|
|
"httpMethod": "GET",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"response": {
|
|
"$ref": "HttpDeviceConfig"
|
|
},
|
|
"parameters": {
|
|
"name": {
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
|
"location": "path",
|
|
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0`.",
|
|
"type": "string",
|
|
"required": true
|
|
},
|
|
"localVersion": {
|
|
"format": "int64",
|
|
"description": "If zero, returns the current device configuration from Cloud IoT Core.\nIf nonzero, specifies the local version of the configuration on the device.\nThe server returns config data only if a higher (newer) version is\navailable from Cloud IoT Core.\nIf this value is higher than the latest version available in Cloud IoT\nCore, returns an `OUT_OF_RANGE` error.",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/config"
|
|
}
|
|
},
|
|
"resources": {
|
|
"configVersions": {
|
|
"methods": {
|
|
"list": {
|
|
"response": {
|
|
"$ref": "ListDeviceConfigVersionsResponse"
|
|
},
|
|
"httpMethod": "GET",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloudiot"
|
|
],
|
|
"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}`.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
|
"location": "path"
|
|
},
|
|
"numVersions": {
|
|
"format": "int32",
|
|
"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.",
|
|
"type": "integer",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
|
|
"id": "cloudiot.projects.locations.registries.devices.configVersions.list",
|
|
"path": "v1beta1/{+name}/configVersions",
|
|
"description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first)."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": {
|
|
"$.xgafv": {
|
|
"description": "V1 error format.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"v1 error format",
|
|
"v2 error format"
|
|
],
|
|
"location": "query",
|
|
"enum": [
|
|
"1",
|
|
"2"
|
|
]
|
|
},
|
|
"callback": {
|
|
"description": "JSONP",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"alt": {
|
|
"type": "string",
|
|
"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",
|
|
"description": "Data format for response.",
|
|
"default": "json",
|
|
"enum": [
|
|
"json",
|
|
"media",
|
|
"proto"
|
|
]
|
|
},
|
|
"key": {
|
|
"location": "query",
|
|
"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.",
|
|
"type": "string"
|
|
},
|
|
"access_token": {
|
|
"description": "OAuth access token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"quotaUser": {
|
|
"location": "query",
|
|
"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.",
|
|
"type": "string"
|
|
},
|
|
"pp": {
|
|
"description": "Pretty-print response.",
|
|
"default": "true",
|
|
"type": "boolean",
|
|
"location": "query"
|
|
},
|
|
"oauth_token": {
|
|
"location": "query",
|
|
"description": "OAuth 2.0 token for the current user.",
|
|
"type": "string"
|
|
},
|
|
"bearer_token": {
|
|
"description": "OAuth bearer token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"upload_protocol": {
|
|
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"prettyPrint": {
|
|
"location": "query",
|
|
"description": "Returns response with indentations and line breaks.",
|
|
"default": "true",
|
|
"type": "boolean"
|
|
},
|
|
"fields": {
|
|
"description": "Selector specifying which fields to include in a partial response.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"uploadType": {
|
|
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"version": "v1beta1",
|
|
"baseUrl": "https://cloudiot.googleapis.com/",
|
|
"description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
|
|
"kind": "discovery#restDescription",
|
|
"servicePath": ""
|
|
}
|