1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudiot_v1.html">Cloud IoT API</a> . <a href="cloudiot_v1.projects.html">projects</a> . <a href="cloudiot_v1.projects.locations.html">locations</a> . <a href="cloudiot_v1.projects.locations.registries.html">registries</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="cloudiot_v1.projects.locations.registries.devices.html">devices()</a></code> 79</p> 80<p class="firstline">Returns the devices Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="cloudiot_v1.projects.locations.registries.groups.html">groups()</a></code> 84</p> 85<p class="firstline">Returns the groups Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#bindDeviceToGateway">bindDeviceToGateway(parent, body=None, x__xgafv=None)</a></code></p> 89<p class="firstline">Associates the device with the gateway.</p> 90<p class="toc_element"> 91 <code><a href="#close">close()</a></code></p> 92<p class="firstline">Close httplib2 connections.</p> 93<p class="toc_element"> 94 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 95<p class="firstline">Creates a device registry that contains devices.</p> 96<p class="toc_element"> 97 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 98<p class="firstline">Deletes a device registry configuration.</p> 99<p class="toc_element"> 100 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 101<p class="firstline">Gets a device registry configuration.</p> 102<p class="toc_element"> 103 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 104<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p> 105<p class="toc_element"> 106 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 107<p class="firstline">Lists device registries.</p> 108<p class="toc_element"> 109 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 110<p class="firstline">Retrieves the next page of results.</p> 111<p class="toc_element"> 112 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 113<p class="firstline">Updates a device registry configuration.</p> 114<p class="toc_element"> 115 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 116<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 117<p class="toc_element"> 118 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 119<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.</p> 120<p class="toc_element"> 121 <code><a href="#unbindDeviceFromGateway">unbindDeviceFromGateway(parent, body=None, x__xgafv=None)</a></code></p> 122<p class="firstline">Deletes the association between the device and the gateway.</p> 123<h3>Method Details</h3> 124<div class="method"> 125 <code class="details" id="bindDeviceToGateway">bindDeviceToGateway(parent, body=None, x__xgafv=None)</code> 126 <pre>Associates the device with the gateway. 127 128Args: 129 parent: string, Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. (required) 130 body: object, The request body. 131 The object takes the form of: 132 133{ # Request for `BindDeviceToGateway`. 134 "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. 135 "gatewayId": "A String", # Required. The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. 136} 137 138 x__xgafv: string, V1 error format. 139 Allowed values 140 1 - v1 error format 141 2 - v2 error format 142 143Returns: 144 An object of the form: 145 146 { # Response for `BindDeviceToGateway`. 147}</pre> 148</div> 149 150<div class="method"> 151 <code class="details" id="close">close()</code> 152 <pre>Close httplib2 connections.</pre> 153</div> 154 155<div class="method"> 156 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 157 <pre>Creates a device registry that contains devices. 158 159Args: 160 parent: string, Required. The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`. (required) 161 body: object, The request body. 162 The object takes the form of: 163 164{ # A container for a group of devices. 165 "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 created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified. 166 { # A server-stored registry credential used to validate device credentials. 167 "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials. 168 "certificate": "A String", # The certificate data. 169 "format": "A String", # The certificate format. 170 "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates. 171 "expiryTime": "A String", # The time the certificate becomes invalid. 172 "issuer": "A String", # The entity that signed the certificate. 173 "publicKeyType": "A String", # The type of public key in the certificate. 174 "signatureAlgorithm": "A String", # The algorithm used to sign the certificate. 175 "startTime": "A String", # The time the certificate becomes valid. 176 "subject": "A String", # The entity the certificate and public key belong to. 177 }, 178 }, 179 }, 180 ], 181 "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. 182 { # The configuration for forwarding telemetry events. 183 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 184 "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. 185 }, 186 ], 187 "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry. 188 "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry. 189 }, 190 "id": "A String", # The identifier of this device registry. For example, `myRegistry`. 191 "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. 192 "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry. 193 "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail. 194 }, 195 "name": "A String", # The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. 196 "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. 197 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 198 }, 199} 200 201 x__xgafv: string, V1 error format. 202 Allowed values 203 1 - v1 error format 204 2 - v2 error format 205 206Returns: 207 An object of the form: 208 209 { # A container for a group of devices. 210 "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 created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified. 211 { # A server-stored registry credential used to validate device credentials. 212 "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials. 213 "certificate": "A String", # The certificate data. 214 "format": "A String", # The certificate format. 215 "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates. 216 "expiryTime": "A String", # The time the certificate becomes invalid. 217 "issuer": "A String", # The entity that signed the certificate. 218 "publicKeyType": "A String", # The type of public key in the certificate. 219 "signatureAlgorithm": "A String", # The algorithm used to sign the certificate. 220 "startTime": "A String", # The time the certificate becomes valid. 221 "subject": "A String", # The entity the certificate and public key belong to. 222 }, 223 }, 224 }, 225 ], 226 "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. 227 { # The configuration for forwarding telemetry events. 228 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 229 "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. 230 }, 231 ], 232 "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry. 233 "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry. 234 }, 235 "id": "A String", # The identifier of this device registry. For example, `myRegistry`. 236 "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. 237 "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry. 238 "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail. 239 }, 240 "name": "A String", # The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. 241 "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. 242 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 243 }, 244}</pre> 245</div> 246 247<div class="method"> 248 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 249 <pre>Deletes a device registry configuration. 250 251Args: 252 name: string, Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. (required) 253 x__xgafv: string, V1 error format. 254 Allowed values 255 1 - v1 error format 256 2 - v2 error format 257 258Returns: 259 An object of the form: 260 261 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 262}</pre> 263</div> 264 265<div class="method"> 266 <code class="details" id="get">get(name, x__xgafv=None)</code> 267 <pre>Gets a device registry configuration. 268 269Args: 270 name: string, Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. (required) 271 x__xgafv: string, V1 error format. 272 Allowed values 273 1 - v1 error format 274 2 - v2 error format 275 276Returns: 277 An object of the form: 278 279 { # A container for a group of devices. 280 "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 created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified. 281 { # A server-stored registry credential used to validate device credentials. 282 "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials. 283 "certificate": "A String", # The certificate data. 284 "format": "A String", # The certificate format. 285 "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates. 286 "expiryTime": "A String", # The time the certificate becomes invalid. 287 "issuer": "A String", # The entity that signed the certificate. 288 "publicKeyType": "A String", # The type of public key in the certificate. 289 "signatureAlgorithm": "A String", # The algorithm used to sign the certificate. 290 "startTime": "A String", # The time the certificate becomes valid. 291 "subject": "A String", # The entity the certificate and public key belong to. 292 }, 293 }, 294 }, 295 ], 296 "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. 297 { # The configuration for forwarding telemetry events. 298 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 299 "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. 300 }, 301 ], 302 "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry. 303 "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry. 304 }, 305 "id": "A String", # The identifier of this device registry. For example, `myRegistry`. 306 "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. 307 "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry. 308 "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail. 309 }, 310 "name": "A String", # The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. 311 "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. 312 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 313 }, 314}</pre> 315</div> 316 317<div class="method"> 318 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> 319 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. 320 321Args: 322 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 323 body: object, The request body. 324 The object takes the form of: 325 326{ # Request message for `GetIamPolicy` method. 327 "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. 328 "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 329 }, 330} 331 332 x__xgafv: string, V1 error format. 333 Allowed values 334 1 - v1 error format 335 2 - v2 error format 336 337Returns: 338 An object of the form: 339 340 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "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 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer 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 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 341 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 342 { # Associates `members`, or principals, with a `role`. 343 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): 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" Example (Logic): 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)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 344 "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. 345 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 346 "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. 347 "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. 348 }, 349 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 350 "A String", 351 ], 352 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 353 }, 354 ], 355 "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. 356 "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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 357}</pre> 358</div> 359 360<div class="method"> 361 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 362 <pre>Lists device registries. 363 364Args: 365 parent: string, Required. The project and cloud region path. For example, `projects/example-project/locations/us-central1`. (required) 366 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. 367 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. 368 x__xgafv: string, V1 error format. 369 Allowed values 370 1 - v1 error format 371 2 - v2 error format 372 373Returns: 374 An object of the form: 375 376 { # Response for `ListDeviceRegistries`. 377 "deviceRegistries": [ # The registries that matched the query. 378 { # A container for a group of devices. 379 "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 created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified. 380 { # A server-stored registry credential used to validate device credentials. 381 "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials. 382 "certificate": "A String", # The certificate data. 383 "format": "A String", # The certificate format. 384 "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates. 385 "expiryTime": "A String", # The time the certificate becomes invalid. 386 "issuer": "A String", # The entity that signed the certificate. 387 "publicKeyType": "A String", # The type of public key in the certificate. 388 "signatureAlgorithm": "A String", # The algorithm used to sign the certificate. 389 "startTime": "A String", # The time the certificate becomes valid. 390 "subject": "A String", # The entity the certificate and public key belong to. 391 }, 392 }, 393 }, 394 ], 395 "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. 396 { # The configuration for forwarding telemetry events. 397 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 398 "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. 399 }, 400 ], 401 "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry. 402 "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry. 403 }, 404 "id": "A String", # The identifier of this device registry. For example, `myRegistry`. 405 "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. 406 "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry. 407 "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail. 408 }, 409 "name": "A String", # The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. 410 "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. 411 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 412 }, 413 }, 414 ], 415 "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`. 416}</pre> 417</div> 418 419<div class="method"> 420 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 421 <pre>Retrieves the next page of results. 422 423Args: 424 previous_request: The request for the previous page. (required) 425 previous_response: The response from the request for the previous page. (required) 426 427Returns: 428 A request object that you can call 'execute()' on to request the next 429 page. Returns None if there are no more items in the collection. 430 </pre> 431</div> 432 433<div class="method"> 434 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 435 <pre>Updates a device registry configuration. 436 437Args: 438 name: string, The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. (required) 439 body: object, The request body. 440 The object takes the form of: 441 442{ # A container for a group of devices. 443 "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 created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified. 444 { # A server-stored registry credential used to validate device credentials. 445 "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials. 446 "certificate": "A String", # The certificate data. 447 "format": "A String", # The certificate format. 448 "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates. 449 "expiryTime": "A String", # The time the certificate becomes invalid. 450 "issuer": "A String", # The entity that signed the certificate. 451 "publicKeyType": "A String", # The type of public key in the certificate. 452 "signatureAlgorithm": "A String", # The algorithm used to sign the certificate. 453 "startTime": "A String", # The time the certificate becomes valid. 454 "subject": "A String", # The entity the certificate and public key belong to. 455 }, 456 }, 457 }, 458 ], 459 "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. 460 { # The configuration for forwarding telemetry events. 461 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 462 "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. 463 }, 464 ], 465 "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry. 466 "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry. 467 }, 468 "id": "A String", # The identifier of this device registry. For example, `myRegistry`. 469 "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. 470 "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry. 471 "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail. 472 }, 473 "name": "A String", # The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. 474 "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. 475 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 476 }, 477} 478 479 updateMask: string, Required. Only updates the `device_registry` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `event_notification_config`, `http_config`, `mqtt_config`, and `state_notification_config`. 480 x__xgafv: string, V1 error format. 481 Allowed values 482 1 - v1 error format 483 2 - v2 error format 484 485Returns: 486 An object of the form: 487 488 { # A container for a group of devices. 489 "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 created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified. 490 { # A server-stored registry credential used to validate device credentials. 491 "publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials. 492 "certificate": "A String", # The certificate data. 493 "format": "A String", # The certificate format. 494 "x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates. 495 "expiryTime": "A String", # The time the certificate becomes invalid. 496 "issuer": "A String", # The entity that signed the certificate. 497 "publicKeyType": "A String", # The type of public key in the certificate. 498 "signatureAlgorithm": "A String", # The algorithm used to sign the certificate. 499 "startTime": "A String", # The time the certificate becomes valid. 500 "subject": "A String", # The entity the certificate and public key belong to. 501 }, 502 }, 503 }, 504 ], 505 "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. 506 { # The configuration for forwarding telemetry events. 507 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 508 "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. 509 }, 510 ], 511 "httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry. 512 "httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry. 513 }, 514 "id": "A String", # The identifier of this device registry. For example, `myRegistry`. 515 "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. 516 "mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry. 517 "mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail. 518 }, 519 "name": "A String", # The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. 520 "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. 521 "pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`. 522 }, 523}</pre> 524</div> 525 526<div class="method"> 527 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 528 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 529 530Args: 531 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 532 body: object, The request body. 533 The object takes the form of: 534 535{ # Request message for `SetIamPolicy` method. 536 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "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 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer 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 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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. 537 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 538 { # Associates `members`, or principals, with a `role`. 539 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): 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" Example (Logic): 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)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 540 "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. 541 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 542 "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. 543 "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. 544 }, 545 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 546 "A String", 547 ], 548 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 549 }, 550 ], 551 "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. 552 "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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 553 }, 554} 555 556 x__xgafv: string, V1 error format. 557 Allowed values 558 1 - v1 error format 559 2 - v2 error format 560 561Returns: 562 An object of the form: 563 564 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "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 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer 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 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 565 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 566 { # Associates `members`, or principals, with a `role`. 567 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): 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" Example (Logic): 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)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 568 "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. 569 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 570 "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. 571 "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. 572 }, 573 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 574 "A String", 575 ], 576 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 577 }, 578 ], 579 "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. 580 "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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 581}</pre> 582</div> 583 584<div class="method"> 585 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 586 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. 587 588Args: 589 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required) 590 body: object, The request body. 591 The object takes the form of: 592 593{ # Request message for `TestIamPermissions` method. 594 "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). 595 "A String", 596 ], 597} 598 599 x__xgafv: string, V1 error format. 600 Allowed values 601 1 - v1 error format 602 2 - v2 error format 603 604Returns: 605 An object of the form: 606 607 { # Response message for `TestIamPermissions` method. 608 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 609 "A String", 610 ], 611}</pre> 612</div> 613 614<div class="method"> 615 <code class="details" id="unbindDeviceFromGateway">unbindDeviceFromGateway(parent, body=None, x__xgafv=None)</code> 616 <pre>Deletes the association between the device and the gateway. 617 618Args: 619 parent: string, Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. (required) 620 body: object, The request body. 621 The object takes the form of: 622 623{ # Request for `UnbindDeviceFromGateway`. 624 "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. 625 "gatewayId": "A String", # Required. The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. 626} 627 628 x__xgafv: string, V1 error format. 629 Allowed values 630 1 - v1 error format 631 2 - v2 error format 632 633Returns: 634 An object of the form: 635 636 { # Response for `UnbindDeviceFromGateway`. 637}</pre> 638</div> 639 640</body></html>