docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudiot_v1.projects.locations.registries.html b/docs/dyn/cloudiot_v1.projects.locations.registries.html
index 454fdf5..40bea0c 100644
--- a/docs/dyn/cloudiot_v1.projects.locations.registries.html
+++ b/docs/dyn/cloudiot_v1.projects.locations.registries.html
@@ -100,7 +100,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists device registries.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -129,9 +129,9 @@
The object takes the form of:
{ # Request for `BindDeviceToGateway`.
- "gatewayId": "A String", # Required. The value of `gateway_id` can be either the device numeric ID or the
+ "gatewayId": "A String", # Required. The value of `gateway_id` can be either the device numeric ID or the
# user-defined device identifier.
- "deviceId": "A String", # Required. The device to associate with the specified gateway. The value of
+ "deviceId": "A String", # Required. The device to associate with the specified gateway. The value of
# `device_id` can be either the device numeric ID or the user-defined device
# identifier.
}
@@ -159,48 +159,7 @@
The object takes the form of:
{ # A container for a group of devices.
- "name": "A String", # The resource path name. For example,
- # `projects/example-project/locations/us-central1/registries/my-registry`.
- "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
- # State updates are guaranteed to be stored in the state history, but
- # notifications to Cloud Pub/Sub are not guaranteed. For example, if
- # permissions are misconfigured or the specified topic doesn't exist, no
- # notification will be published but the state will still be stored in Cloud
- # IoT Core.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- },
- "logLevel": "A String", # **Beta Feature**
- #
- # The default logging verbosity for activity from devices in this registry.
- # The verbosity level can be overridden by Device.log_level.
- "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
- # device. All telemetry events that were successfully published by the
- # device and acknowledged by Cloud IoT Core are guaranteed to be
- # delivered to Cloud Pub/Sub. If multiple configurations match a message,
- # only the first matching configuration is used. If you try to publish a
- # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
- # for the device's registry, the connection closes automatically. If you try
- # to do so using an HTTP connection, an error is returned. Up to 10
- # configurations may be provided.
- { # The configuration for forwarding telemetry events.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
- # be used. The string must not include the leading '/' character. If empty,
- # all strings are matched. This field is used only for telemetry events;
- # subfolders are not supported for state changes.
- },
- ],
- "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
- "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
- # Otherwise, any requests to DeviceService will fail for this registry.
- },
- "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
- "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
- # connections to this registry will fail.
- },
- "credentials": [ # The credentials used to verify the device credentials. No more than 10
+ "credentials": [ # The credentials used to verify the device credentials. No more than 10
# credentials can be bound to a single registry at a time. The verification
# process occurs at the time of device creation or update. If this field is
# empty, no verification is performed. Otherwise, the credentials of a newly
@@ -212,21 +171,62 @@
# successfully created in a registry, it should be able to connect even if
# its registry credentials are revoked, deleted, or modified.
{ # A server-stored registry credential used to validate device credentials.
- "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
- "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
- "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
- "expiryTime": "A String", # The time the certificate becomes invalid.
- "publicKeyType": "A String", # The type of public key in the certificate.
- "startTime": "A String", # The time the certificate becomes valid.
- "subject": "A String", # The entity the certificate and public key belong to.
- "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
+ "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
+ "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyType": "A String", # The type of public key in the certificate.
+ "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
+ "startTime": "A String", # The time the certificate becomes valid.
+ "expiryTime": "A String", # The time the certificate becomes invalid.
+ "subject": "A String", # The entity the certificate and public key belong to.
},
- "certificate": "A String", # The certificate data.
- "format": "A String", # The certificate format.
+ "format": "A String", # The certificate format.
+ "certificate": "A String", # The certificate data.
},
},
],
- "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "name": "A String", # The resource path name. For example,
+ # `projects/example-project/locations/us-central1/registries/my-registry`.
+ "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
+ # device. All telemetry events that were successfully published by the
+ # device and acknowledged by Cloud IoT Core are guaranteed to be
+ # delivered to Cloud Pub/Sub. If multiple configurations match a message,
+ # only the first matching configuration is used. If you try to publish a
+ # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
+ # for the device's registry, the connection closes automatically. If you try
+ # to do so using an HTTP connection, an error is returned. Up to 10
+ # configurations may be provided.
+ { # The configuration for forwarding telemetry events.
+ "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
+ # be used. The string must not include the leading '/' character. If empty,
+ # all strings are matched. This field is used only for telemetry events;
+ # subfolders are not supported for state changes.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
+ ],
+ "logLevel": "A String", # **Beta Feature**
+ #
+ # The default logging verbosity for activity from devices in this registry.
+ # The verbosity level can be overridden by Device.log_level.
+ "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
+ "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
+ # Otherwise, any requests to DeviceService will fail for this registry.
+ },
+ "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
+ "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
+ # connections to this registry will fail.
+ },
+ "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
+ # State updates are guaranteed to be stored in the state history, but
+ # notifications to Cloud Pub/Sub are not guaranteed. For example, if
+ # permissions are misconfigured or the specified topic doesn't exist, no
+ # notification will be published but the state will still be stored in Cloud
+ # IoT Core.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
}
x__xgafv: string, V1 error format.
@@ -238,48 +238,7 @@
An object of the form:
{ # A container for a group of devices.
- "name": "A String", # The resource path name. For example,
- # `projects/example-project/locations/us-central1/registries/my-registry`.
- "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
- # State updates are guaranteed to be stored in the state history, but
- # notifications to Cloud Pub/Sub are not guaranteed. For example, if
- # permissions are misconfigured or the specified topic doesn't exist, no
- # notification will be published but the state will still be stored in Cloud
- # IoT Core.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- },
- "logLevel": "A String", # **Beta Feature**
- #
- # The default logging verbosity for activity from devices in this registry.
- # The verbosity level can be overridden by Device.log_level.
- "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
- # device. All telemetry events that were successfully published by the
- # device and acknowledged by Cloud IoT Core are guaranteed to be
- # delivered to Cloud Pub/Sub. If multiple configurations match a message,
- # only the first matching configuration is used. If you try to publish a
- # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
- # for the device's registry, the connection closes automatically. If you try
- # to do so using an HTTP connection, an error is returned. Up to 10
- # configurations may be provided.
- { # The configuration for forwarding telemetry events.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
- # be used. The string must not include the leading '/' character. If empty,
- # all strings are matched. This field is used only for telemetry events;
- # subfolders are not supported for state changes.
- },
- ],
- "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
- "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
- # Otherwise, any requests to DeviceService will fail for this registry.
- },
- "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
- "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
- # connections to this registry will fail.
- },
- "credentials": [ # The credentials used to verify the device credentials. No more than 10
+ "credentials": [ # The credentials used to verify the device credentials. No more than 10
# credentials can be bound to a single registry at a time. The verification
# process occurs at the time of device creation or update. If this field is
# empty, no verification is performed. Otherwise, the credentials of a newly
@@ -291,21 +250,62 @@
# successfully created in a registry, it should be able to connect even if
# its registry credentials are revoked, deleted, or modified.
{ # A server-stored registry credential used to validate device credentials.
- "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
- "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
- "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
- "expiryTime": "A String", # The time the certificate becomes invalid.
- "publicKeyType": "A String", # The type of public key in the certificate.
- "startTime": "A String", # The time the certificate becomes valid.
- "subject": "A String", # The entity the certificate and public key belong to.
- "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
+ "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
+ "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyType": "A String", # The type of public key in the certificate.
+ "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
+ "startTime": "A String", # The time the certificate becomes valid.
+ "expiryTime": "A String", # The time the certificate becomes invalid.
+ "subject": "A String", # The entity the certificate and public key belong to.
},
- "certificate": "A String", # The certificate data.
- "format": "A String", # The certificate format.
+ "format": "A String", # The certificate format.
+ "certificate": "A String", # The certificate data.
},
},
],
- "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "name": "A String", # The resource path name. For example,
+ # `projects/example-project/locations/us-central1/registries/my-registry`.
+ "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
+ # device. All telemetry events that were successfully published by the
+ # device and acknowledged by Cloud IoT Core are guaranteed to be
+ # delivered to Cloud Pub/Sub. If multiple configurations match a message,
+ # only the first matching configuration is used. If you try to publish a
+ # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
+ # for the device's registry, the connection closes automatically. If you try
+ # to do so using an HTTP connection, an error is returned. Up to 10
+ # configurations may be provided.
+ { # The configuration for forwarding telemetry events.
+ "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
+ # be used. The string must not include the leading '/' character. If empty,
+ # all strings are matched. This field is used only for telemetry events;
+ # subfolders are not supported for state changes.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
+ ],
+ "logLevel": "A String", # **Beta Feature**
+ #
+ # The default logging verbosity for activity from devices in this registry.
+ # The verbosity level can be overridden by Device.log_level.
+ "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
+ "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
+ # Otherwise, any requests to DeviceService will fail for this registry.
+ },
+ "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
+ "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
+ # connections to this registry will fail.
+ },
+ "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
+ # State updates are guaranteed to be stored in the state history, but
+ # notifications to Cloud Pub/Sub are not guaranteed. For example, if
+ # permissions are misconfigured or the specified topic doesn't exist, no
+ # notification will be published but the state will still be stored in Cloud
+ # IoT Core.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
}</pre>
</div>
@@ -352,48 +352,7 @@
An object of the form:
{ # A container for a group of devices.
- "name": "A String", # The resource path name. For example,
- # `projects/example-project/locations/us-central1/registries/my-registry`.
- "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
- # State updates are guaranteed to be stored in the state history, but
- # notifications to Cloud Pub/Sub are not guaranteed. For example, if
- # permissions are misconfigured or the specified topic doesn't exist, no
- # notification will be published but the state will still be stored in Cloud
- # IoT Core.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- },
- "logLevel": "A String", # **Beta Feature**
- #
- # The default logging verbosity for activity from devices in this registry.
- # The verbosity level can be overridden by Device.log_level.
- "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
- # device. All telemetry events that were successfully published by the
- # device and acknowledged by Cloud IoT Core are guaranteed to be
- # delivered to Cloud Pub/Sub. If multiple configurations match a message,
- # only the first matching configuration is used. If you try to publish a
- # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
- # for the device's registry, the connection closes automatically. If you try
- # to do so using an HTTP connection, an error is returned. Up to 10
- # configurations may be provided.
- { # The configuration for forwarding telemetry events.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
- # be used. The string must not include the leading '/' character. If empty,
- # all strings are matched. This field is used only for telemetry events;
- # subfolders are not supported for state changes.
- },
- ],
- "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
- "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
- # Otherwise, any requests to DeviceService will fail for this registry.
- },
- "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
- "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
- # connections to this registry will fail.
- },
- "credentials": [ # The credentials used to verify the device credentials. No more than 10
+ "credentials": [ # The credentials used to verify the device credentials. No more than 10
# credentials can be bound to a single registry at a time. The verification
# process occurs at the time of device creation or update. If this field is
# empty, no verification is performed. Otherwise, the credentials of a newly
@@ -405,21 +364,62 @@
# successfully created in a registry, it should be able to connect even if
# its registry credentials are revoked, deleted, or modified.
{ # A server-stored registry credential used to validate device credentials.
- "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
- "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
- "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
- "expiryTime": "A String", # The time the certificate becomes invalid.
- "publicKeyType": "A String", # The type of public key in the certificate.
- "startTime": "A String", # The time the certificate becomes valid.
- "subject": "A String", # The entity the certificate and public key belong to.
- "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
+ "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
+ "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyType": "A String", # The type of public key in the certificate.
+ "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
+ "startTime": "A String", # The time the certificate becomes valid.
+ "expiryTime": "A String", # The time the certificate becomes invalid.
+ "subject": "A String", # The entity the certificate and public key belong to.
},
- "certificate": "A String", # The certificate data.
- "format": "A String", # The certificate format.
+ "format": "A String", # The certificate format.
+ "certificate": "A String", # The certificate data.
},
},
],
- "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "name": "A String", # The resource path name. For example,
+ # `projects/example-project/locations/us-central1/registries/my-registry`.
+ "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
+ # device. All telemetry events that were successfully published by the
+ # device and acknowledged by Cloud IoT Core are guaranteed to be
+ # delivered to Cloud Pub/Sub. If multiple configurations match a message,
+ # only the first matching configuration is used. If you try to publish a
+ # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
+ # for the device's registry, the connection closes automatically. If you try
+ # to do so using an HTTP connection, an error is returned. Up to 10
+ # configurations may be provided.
+ { # The configuration for forwarding telemetry events.
+ "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
+ # be used. The string must not include the leading '/' character. If empty,
+ # all strings are matched. This field is used only for telemetry events;
+ # subfolders are not supported for state changes.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
+ ],
+ "logLevel": "A String", # **Beta Feature**
+ #
+ # The default logging verbosity for activity from devices in this registry.
+ # The verbosity level can be overridden by Device.log_level.
+ "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
+ "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
+ # Otherwise, any requests to DeviceService will fail for this registry.
+ },
+ "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
+ "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
+ # connections to this registry will fail.
+ },
+ "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
+ # State updates are guaranteed to be stored in the state history, but
+ # notifications to Cloud Pub/Sub are not guaranteed. For example, if
+ # permissions are misconfigured or the specified topic doesn't exist, no
+ # notification will be published but the state will still be stored in Cloud
+ # IoT Core.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
}</pre>
</div>
@@ -436,9 +436,9 @@
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
- "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
# `GetIamPolicy`.
- "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
+ "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
#
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
@@ -475,28 +475,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -514,19 +514,50 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -569,9 +600,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
@@ -580,81 +613,48 @@
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
#
# Example (Equality):
#
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists device registries.
Args:
@@ -663,66 +663,22 @@
pageToken: string, The value returned by the last `ListDeviceRegistriesResponse`; indicates
that this is a continuation of a prior `ListDeviceRegistries` call and
the system should return the next page of data.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
pageSize: integer, The maximum number of registries to return in the response. If this value
is zero, the service will select a default size. A call may return fewer
objects than requested. A non-empty `next_page_token` in the response
indicates that more data is available.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Response for `ListDeviceRegistries`.
- "nextPageToken": "A String", # If not empty, indicates that there may be more registries that match the
- # request; this value should be passed in a new
- # `ListDeviceRegistriesRequest`.
- "deviceRegistries": [ # The registries that matched the query.
+ "deviceRegistries": [ # The registries that matched the query.
{ # A container for a group of devices.
- "name": "A String", # The resource path name. For example,
- # `projects/example-project/locations/us-central1/registries/my-registry`.
- "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
- # State updates are guaranteed to be stored in the state history, but
- # notifications to Cloud Pub/Sub are not guaranteed. For example, if
- # permissions are misconfigured or the specified topic doesn't exist, no
- # notification will be published but the state will still be stored in Cloud
- # IoT Core.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- },
- "logLevel": "A String", # **Beta Feature**
- #
- # The default logging verbosity for activity from devices in this registry.
- # The verbosity level can be overridden by Device.log_level.
- "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
- # device. All telemetry events that were successfully published by the
- # device and acknowledged by Cloud IoT Core are guaranteed to be
- # delivered to Cloud Pub/Sub. If multiple configurations match a message,
- # only the first matching configuration is used. If you try to publish a
- # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
- # for the device's registry, the connection closes automatically. If you try
- # to do so using an HTTP connection, an error is returned. Up to 10
- # configurations may be provided.
- { # The configuration for forwarding telemetry events.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
- # be used. The string must not include the leading '/' character. If empty,
- # all strings are matched. This field is used only for telemetry events;
- # subfolders are not supported for state changes.
- },
- ],
- "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
- "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
- # Otherwise, any requests to DeviceService will fail for this registry.
- },
- "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
- "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
- # connections to this registry will fail.
- },
- "credentials": [ # The credentials used to verify the device credentials. No more than 10
+ "credentials": [ # The credentials used to verify the device credentials. No more than 10
# credentials can be bound to a single registry at a time. The verification
# process occurs at the time of device creation or update. If this field is
# empty, no verification is performed. Otherwise, the credentials of a newly
@@ -734,23 +690,67 @@
# successfully created in a registry, it should be able to connect even if
# its registry credentials are revoked, deleted, or modified.
{ # A server-stored registry credential used to validate device credentials.
- "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
- "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
- "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
- "expiryTime": "A String", # The time the certificate becomes invalid.
- "publicKeyType": "A String", # The type of public key in the certificate.
- "startTime": "A String", # The time the certificate becomes valid.
- "subject": "A String", # The entity the certificate and public key belong to.
- "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
+ "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
+ "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyType": "A String", # The type of public key in the certificate.
+ "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
+ "startTime": "A String", # The time the certificate becomes valid.
+ "expiryTime": "A String", # The time the certificate becomes invalid.
+ "subject": "A String", # The entity the certificate and public key belong to.
},
- "certificate": "A String", # The certificate data.
- "format": "A String", # The certificate format.
+ "format": "A String", # The certificate format.
+ "certificate": "A String", # The certificate data.
},
},
],
- "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "name": "A String", # The resource path name. For example,
+ # `projects/example-project/locations/us-central1/registries/my-registry`.
+ "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
+ # device. All telemetry events that were successfully published by the
+ # device and acknowledged by Cloud IoT Core are guaranteed to be
+ # delivered to Cloud Pub/Sub. If multiple configurations match a message,
+ # only the first matching configuration is used. If you try to publish a
+ # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
+ # for the device's registry, the connection closes automatically. If you try
+ # to do so using an HTTP connection, an error is returned. Up to 10
+ # configurations may be provided.
+ { # The configuration for forwarding telemetry events.
+ "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
+ # be used. The string must not include the leading '/' character. If empty,
+ # all strings are matched. This field is used only for telemetry events;
+ # subfolders are not supported for state changes.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
+ ],
+ "logLevel": "A String", # **Beta Feature**
+ #
+ # The default logging verbosity for activity from devices in this registry.
+ # The verbosity level can be overridden by Device.log_level.
+ "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
+ "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
+ # Otherwise, any requests to DeviceService will fail for this registry.
+ },
+ "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
+ "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
+ # connections to this registry will fail.
+ },
+ "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
+ # State updates are guaranteed to be stored in the state history, but
+ # notifications to Cloud Pub/Sub are not guaranteed. For example, if
+ # permissions are misconfigured or the specified topic doesn't exist, no
+ # notification will be published but the state will still be stored in Cloud
+ # IoT Core.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
},
],
+ "nextPageToken": "A String", # If not empty, indicates that there may be more registries that match the
+ # request; this value should be passed in a new
+ # `ListDeviceRegistriesRequest`.
}</pre>
</div>
@@ -763,7 +763,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -779,48 +779,7 @@
The object takes the form of:
{ # A container for a group of devices.
- "name": "A String", # The resource path name. For example,
- # `projects/example-project/locations/us-central1/registries/my-registry`.
- "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
- # State updates are guaranteed to be stored in the state history, but
- # notifications to Cloud Pub/Sub are not guaranteed. For example, if
- # permissions are misconfigured or the specified topic doesn't exist, no
- # notification will be published but the state will still be stored in Cloud
- # IoT Core.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- },
- "logLevel": "A String", # **Beta Feature**
- #
- # The default logging verbosity for activity from devices in this registry.
- # The verbosity level can be overridden by Device.log_level.
- "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
- # device. All telemetry events that were successfully published by the
- # device and acknowledged by Cloud IoT Core are guaranteed to be
- # delivered to Cloud Pub/Sub. If multiple configurations match a message,
- # only the first matching configuration is used. If you try to publish a
- # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
- # for the device's registry, the connection closes automatically. If you try
- # to do so using an HTTP connection, an error is returned. Up to 10
- # configurations may be provided.
- { # The configuration for forwarding telemetry events.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
- # be used. The string must not include the leading '/' character. If empty,
- # all strings are matched. This field is used only for telemetry events;
- # subfolders are not supported for state changes.
- },
- ],
- "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
- "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
- # Otherwise, any requests to DeviceService will fail for this registry.
- },
- "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
- "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
- # connections to this registry will fail.
- },
- "credentials": [ # The credentials used to verify the device credentials. No more than 10
+ "credentials": [ # The credentials used to verify the device credentials. No more than 10
# credentials can be bound to a single registry at a time. The verification
# process occurs at the time of device creation or update. If this field is
# empty, no verification is performed. Otherwise, the credentials of a newly
@@ -832,21 +791,62 @@
# successfully created in a registry, it should be able to connect even if
# its registry credentials are revoked, deleted, or modified.
{ # A server-stored registry credential used to validate device credentials.
- "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
- "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
- "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
- "expiryTime": "A String", # The time the certificate becomes invalid.
- "publicKeyType": "A String", # The type of public key in the certificate.
- "startTime": "A String", # The time the certificate becomes valid.
- "subject": "A String", # The entity the certificate and public key belong to.
- "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
+ "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
+ "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyType": "A String", # The type of public key in the certificate.
+ "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
+ "startTime": "A String", # The time the certificate becomes valid.
+ "expiryTime": "A String", # The time the certificate becomes invalid.
+ "subject": "A String", # The entity the certificate and public key belong to.
},
- "certificate": "A String", # The certificate data.
- "format": "A String", # The certificate format.
+ "format": "A String", # The certificate format.
+ "certificate": "A String", # The certificate data.
},
},
],
- "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "name": "A String", # The resource path name. For example,
+ # `projects/example-project/locations/us-central1/registries/my-registry`.
+ "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
+ # device. All telemetry events that were successfully published by the
+ # device and acknowledged by Cloud IoT Core are guaranteed to be
+ # delivered to Cloud Pub/Sub. If multiple configurations match a message,
+ # only the first matching configuration is used. If you try to publish a
+ # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
+ # for the device's registry, the connection closes automatically. If you try
+ # to do so using an HTTP connection, an error is returned. Up to 10
+ # configurations may be provided.
+ { # The configuration for forwarding telemetry events.
+ "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
+ # be used. The string must not include the leading '/' character. If empty,
+ # all strings are matched. This field is used only for telemetry events;
+ # subfolders are not supported for state changes.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
+ ],
+ "logLevel": "A String", # **Beta Feature**
+ #
+ # The default logging verbosity for activity from devices in this registry.
+ # The verbosity level can be overridden by Device.log_level.
+ "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
+ "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
+ # Otherwise, any requests to DeviceService will fail for this registry.
+ },
+ "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
+ "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
+ # connections to this registry will fail.
+ },
+ "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
+ # State updates are guaranteed to be stored in the state history, but
+ # notifications to Cloud Pub/Sub are not guaranteed. For example, if
+ # permissions are misconfigured or the specified topic doesn't exist, no
+ # notification will be published but the state will still be stored in Cloud
+ # IoT Core.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
}
updateMask: string, Required. Only updates the `device_registry` fields indicated by this mask.
@@ -863,48 +863,7 @@
An object of the form:
{ # A container for a group of devices.
- "name": "A String", # The resource path name. For example,
- # `projects/example-project/locations/us-central1/registries/my-registry`.
- "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
- # State updates are guaranteed to be stored in the state history, but
- # notifications to Cloud Pub/Sub are not guaranteed. For example, if
- # permissions are misconfigured or the specified topic doesn't exist, no
- # notification will be published but the state will still be stored in Cloud
- # IoT Core.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- },
- "logLevel": "A String", # **Beta Feature**
- #
- # The default logging verbosity for activity from devices in this registry.
- # The verbosity level can be overridden by Device.log_level.
- "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
- # device. All telemetry events that were successfully published by the
- # device and acknowledged by Cloud IoT Core are guaranteed to be
- # delivered to Cloud Pub/Sub. If multiple configurations match a message,
- # only the first matching configuration is used. If you try to publish a
- # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
- # for the device's registry, the connection closes automatically. If you try
- # to do so using an HTTP connection, an error is returned. Up to 10
- # configurations may be provided.
- { # The configuration for forwarding telemetry events.
- "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
- # `projects/myProject/topics/deviceEvents`.
- "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
- # be used. The string must not include the leading '/' character. If empty,
- # all strings are matched. This field is used only for telemetry events;
- # subfolders are not supported for state changes.
- },
- ],
- "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
- "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
- # Otherwise, any requests to DeviceService will fail for this registry.
- },
- "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
- "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
- # connections to this registry will fail.
- },
- "credentials": [ # The credentials used to verify the device credentials. No more than 10
+ "credentials": [ # The credentials used to verify the device credentials. No more than 10
# credentials can be bound to a single registry at a time. The verification
# process occurs at the time of device creation or update. If this field is
# empty, no verification is performed. Otherwise, the credentials of a newly
@@ -916,21 +875,62 @@
# successfully created in a registry, it should be able to connect even if
# its registry credentials are revoked, deleted, or modified.
{ # A server-stored registry credential used to validate device credentials.
- "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
- "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
- "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
- "expiryTime": "A String", # The time the certificate becomes invalid.
- "publicKeyType": "A String", # The type of public key in the certificate.
- "startTime": "A String", # The time the certificate becomes valid.
- "subject": "A String", # The entity the certificate and public key belong to.
- "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.
+ "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.
+ "issuer": "A String", # The entity that signed the certificate.
+ "publicKeyType": "A String", # The type of public key in the certificate.
+ "signatureAlgorithm": "A String", # The algorithm used to sign the certificate.
+ "startTime": "A String", # The time the certificate becomes valid.
+ "expiryTime": "A String", # The time the certificate becomes invalid.
+ "subject": "A String", # The entity the certificate and public key belong to.
},
- "certificate": "A String", # The certificate data.
- "format": "A String", # The certificate format.
+ "format": "A String", # The certificate format.
+ "certificate": "A String", # The certificate data.
},
},
],
- "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "name": "A String", # The resource path name. For example,
+ # `projects/example-project/locations/us-central1/registries/my-registry`.
+ "eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the
+ # device. All telemetry events that were successfully published by the
+ # device and acknowledged by Cloud IoT Core are guaranteed to be
+ # delivered to Cloud Pub/Sub. If multiple configurations match a message,
+ # only the first matching configuration is used. If you try to publish a
+ # device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
+ # for the device's registry, the connection closes automatically. If you try
+ # to do so using an HTTP connection, an error is returned. Up to 10
+ # configurations may be provided.
+ { # The configuration for forwarding telemetry events.
+ "subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will
+ # be used. The string must not include the leading '/' character. If empty,
+ # all strings are matched. This field is used only for telemetry events;
+ # subfolders are not supported for state changes.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
+ ],
+ "logLevel": "A String", # **Beta Feature**
+ #
+ # The default logging verbosity for activity from devices in this registry.
+ # The verbosity level can be overridden by Device.log_level.
+ "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.
+ "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.
+ # Otherwise, any requests to DeviceService will fail for this registry.
+ },
+ "id": "A String", # The identifier of this device registry. For example, `myRegistry`.
+ "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.
+ "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
+ # connections to this registry will fail.
+ },
+ "stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.
+ # State updates are guaranteed to be stored in the state history, but
+ # notifications to Cloud Pub/Sub are not guaranteed. For example, if
+ # permissions are misconfigured or the specified topic doesn't exist, no
+ # notification will be published but the state will still be stored in Cloud
+ # IoT Core.
+ "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,
+ # `projects/myProject/topics/deviceEvents`.
+ },
}</pre>
</div>
@@ -946,7 +946,7 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
@@ -967,28 +967,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1006,19 +1006,50 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -1061,9 +1092,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
@@ -1072,76 +1105,43 @@
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
#
# Example (Equality):
#
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
},
}
@@ -1171,28 +1171,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1210,19 +1210,50 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -1265,9 +1296,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
@@ -1276,76 +1309,43 @@
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
#
# Example (Equality):
#
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
}</pre>
</div>
@@ -1362,11 +1362,11 @@
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
- "A String",
+ "A String",
],
}
@@ -1379,9 +1379,9 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
- "A String",
+ "A String",
],
}</pre>
</div>
@@ -1397,9 +1397,9 @@
The object takes the form of:
{ # Request for `UnbindDeviceFromGateway`.
- "gatewayId": "A String", # Required. The value of `gateway_id` can be either the device numeric ID or the
+ "gatewayId": "A String", # Required. The value of `gateway_id` can be either the device numeric ID or the
# user-defined device identifier.
- "deviceId": "A String", # Required. The device to disassociate from the specified gateway. The value of
+ "deviceId": "A String", # Required. The device to disassociate from the specified gateway. The value of
# `device_id` can be either the device numeric ID or the user-defined device
# identifier.
}