Blame - docs/dyn/cloudiot_v1.projects.locations.registries.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

88

<code><a href="#bindDeviceToGateway">bindDeviceToGateway(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

89

<p class="firstline">Associates the device with the gateway.</p>

90

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

91

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

<p class="firstline">Creates a device registry that contains devices.</p>

93

94

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

95

<p class="firstline">Deletes a device registry configuration.</p>

96

97

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

98

<p class="firstline">Gets a device registry configuration.</p>

99

100

<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

101

<p class="firstline">Gets the access control policy for a resource.</p>

102

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

103

<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

104

<p class="firstline">Lists device registries.</p>

105

106

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

107

<p class="firstline">Retrieves the next page of results.</p>

108

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

109

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

110

<p class="firstline">Updates a device registry configuration.</p>

111

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

112

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>

114

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

115

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

116

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

117

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

118

<code><a href="#unbindDeviceFromGateway">unbindDeviceFromGateway(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

119

<p class="firstline">Deletes the association between the device and the gateway.</p>

120

<h3>Method Details</h3>

121

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

122

<code class="details" id="bindDeviceToGateway">bindDeviceToGateway(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

123

<pre>Associates the device with the gateway.

124

125

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

126

parent: string, Required. The name of the registry. For example,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

127

`projects/example-project/locations/us-central1/registries/my-registry`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

128

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

129

The object takes the form of:

130

131

{ # Request for `BindDeviceToGateway`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

132

"deviceId": "A String", # Required. The device to associate with the specified gateway. The value of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

133

# `device_id` can be either the device numeric ID or the user-defined device

134

# identifier.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

135

"gatewayId": "A String", # Required. The value of `gateway_id` can be either the device numeric ID or the

136

# user-defined device identifier.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

137

}

138

139

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

146

147

{ # Response for `BindDeviceToGateway`.

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

152

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

153

<pre>Creates a device registry that contains devices.

154

155

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

156

parent: string, Required. The project and cloud region where this device registry must be created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

157

For example, `projects/example-project/locations/us-central1`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

158

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

159

The object takes the form of:

160

161

{ # A container for a group of devices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

162

"credentials": [ # The credentials used to verify the device credentials. No more than 10

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

163

# credentials can be bound to a single registry at a time. The verification

164

# process occurs at the time of device creation or update. If this field is

165

# empty, no verification is performed. Otherwise, the credentials of a newly

166

# created device or added credentials of an updated device should be signed

167

# with one of these registry credentials.

168

#

169

# Note, however, that existing devices will never be affected by

170

# modifications to this list of credentials: after a device has been

171

# successfully created in a registry, it should be able to connect even if

172

# its registry credentials are revoked, deleted, or modified.

173

{ # A server-stored registry credential used to validate device credentials.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

174

"publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.

175

"x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

176

"signatureAlgorithm": "A String", # The algorithm used to sign the certificate.

177

"startTime": "A String", # The time the certificate becomes valid.

178

"expiryTime": "A String", # The time the certificate becomes invalid.

179

"subject": "A String", # The entity the certificate and public key belong to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

180

"issuer": "A String", # The entity that signed the certificate.

181

"publicKeyType": "A String", # The type of public key in the certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

182

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

183

"format": "A String", # The certificate format.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

184

"certificate": "A String", # The certificate data.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

185

},

186

},

187

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

188

"name": "A String", # The resource path name. For example,

189

# `projects/example-project/locations/us-central1/registries/my-registry`.

190

"eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the

191

# device. All telemetry events that were successfully published by the

192

# device and acknowledged by Cloud IoT Core are guaranteed to be

193

# delivered to Cloud Pub/Sub. If multiple configurations match a message,

194

# only the first matching configuration is used. If you try to publish a

195

# device telemetry event using MQTT without specifying a Cloud Pub/Sub topic

196

# for the device's registry, the connection closes automatically. If you try

197

# to do so using an HTTP connection, an error is returned. Up to 10

198

# configurations may be provided.

199

{ # The configuration for forwarding telemetry events.

200

"subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will

201

# be used. The string must not include the leading '/' character. If empty,

202

# all strings are matched. This field is used only for telemetry events;

203

# subfolders are not supported for state changes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

204

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

205

# `projects/myProject/topics/deviceEvents`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

206

},

207

],

208

"logLevel": "A String", # **Beta Feature**

209

#

210

# The default logging verbosity for activity from devices in this registry.

211

# The verbosity level can be overridden by Device.log_level.

212

"httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.

213

"httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.

214

# Otherwise, any requests to DeviceService will fail for this registry.

215

},

216

"id": "A String", # The identifier of this device registry. For example, `myRegistry`.

217

"mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.

218

"mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT

219

# connections to this registry will fail.

220

},

221

"stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.

222

# State updates are guaranteed to be stored in the state history, but

223

# notifications to Cloud Pub/Sub are not guaranteed. For example, if

224

# permissions are misconfigured or the specified topic doesn't exist, no

225

# notification will be published but the state will still be stored in Cloud

226

# IoT Core.

227

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

228

# `projects/myProject/topics/deviceEvents`.

229

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

230

}

231

232

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

239

240

{ # A container for a group of devices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

241

"credentials": [ # The credentials used to verify the device credentials. No more than 10

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

242

# credentials can be bound to a single registry at a time. The verification

243

# process occurs at the time of device creation or update. If this field is

244

# empty, no verification is performed. Otherwise, the credentials of a newly

245

# created device or added credentials of an updated device should be signed

246

# with one of these registry credentials.

247

#

248

# Note, however, that existing devices will never be affected by

249

# modifications to this list of credentials: after a device has been

250

# successfully created in a registry, it should be able to connect even if

251

# its registry credentials are revoked, deleted, or modified.

252

{ # A server-stored registry credential used to validate device credentials.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

253

"publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.

254

"x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

255

"signatureAlgorithm": "A String", # The algorithm used to sign the certificate.

256

"startTime": "A String", # The time the certificate becomes valid.

257

"expiryTime": "A String", # The time the certificate becomes invalid.

258

"subject": "A String", # The entity the certificate and public key belong to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

259

"issuer": "A String", # The entity that signed the certificate.

260

"publicKeyType": "A String", # The type of public key in the certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

261

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

262

"format": "A String", # The certificate format.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

263

"certificate": "A String", # The certificate data.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

264

},

265

},

266

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

267

"name": "A String", # The resource path name. For example,

268

# `projects/example-project/locations/us-central1/registries/my-registry`.

269

"eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the

270

# device. All telemetry events that were successfully published by the

271

# device and acknowledged by Cloud IoT Core are guaranteed to be

272

# delivered to Cloud Pub/Sub. If multiple configurations match a message,

273

# only the first matching configuration is used. If you try to publish a

274

# device telemetry event using MQTT without specifying a Cloud Pub/Sub topic

275

# for the device's registry, the connection closes automatically. If you try

276

# to do so using an HTTP connection, an error is returned. Up to 10

277

# configurations may be provided.

278

{ # The configuration for forwarding telemetry events.

279

"subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will

280

# be used. The string must not include the leading '/' character. If empty,

281

# all strings are matched. This field is used only for telemetry events;

282

# subfolders are not supported for state changes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

283

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

284

# `projects/myProject/topics/deviceEvents`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

285

},

286

],

287

"logLevel": "A String", # **Beta Feature**

288

#

289

# The default logging verbosity for activity from devices in this registry.

290

# The verbosity level can be overridden by Device.log_level.

291

"httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.

292

"httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.

293

# Otherwise, any requests to DeviceService will fail for this registry.

294

},

295

"id": "A String", # The identifier of this device registry. For example, `myRegistry`.

296

"mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.

297

"mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT

298

# connections to this registry will fail.

299

},

300

"stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.

301

# State updates are guaranteed to be stored in the state history, but

302

# notifications to Cloud Pub/Sub are not guaranteed. For example, if

303

# permissions are misconfigured or the specified topic doesn't exist, no

304

# notification will be published but the state will still be stored in Cloud

305

# IoT Core.

306

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

307

# `projects/myProject/topics/deviceEvents`.

308

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

314

<pre>Deletes a device registry configuration.

315

316

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

317

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

318

`projects/example-project/locations/us-central1/registries/my-registry`. (required)

319

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

326

327

{ # A generic empty message that you can re-use to avoid defining duplicated

328

# empty messages in your APIs. A typical example is to use it as the request

329

# or the response type of an API method. For instance:

330

#

331

# service Foo {

332

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

333

# }

334

#

335

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

341

<pre>Gets a device registry configuration.

342

343

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

344

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

345

`projects/example-project/locations/us-central1/registries/my-registry`. (required)

346

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

353

354

{ # A container for a group of devices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

355

"credentials": [ # The credentials used to verify the device credentials. No more than 10

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

356

# credentials can be bound to a single registry at a time. The verification

357

# process occurs at the time of device creation or update. If this field is

358

# empty, no verification is performed. Otherwise, the credentials of a newly

359

# created device or added credentials of an updated device should be signed

360

# with one of these registry credentials.

361

#

362

# Note, however, that existing devices will never be affected by

363

# modifications to this list of credentials: after a device has been

364

# successfully created in a registry, it should be able to connect even if

365

# its registry credentials are revoked, deleted, or modified.

366

{ # A server-stored registry credential used to validate device credentials.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

367

"publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.

368

"x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

369

"signatureAlgorithm": "A String", # The algorithm used to sign the certificate.

370

"startTime": "A String", # The time the certificate becomes valid.

371

"expiryTime": "A String", # The time the certificate becomes invalid.

372

"subject": "A String", # The entity the certificate and public key belong to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

373

"issuer": "A String", # The entity that signed the certificate.

374

"publicKeyType": "A String", # The type of public key in the certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

375

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

376

"format": "A String", # The certificate format.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

377

"certificate": "A String", # The certificate data.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

378

},

379

},

380

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

381

"name": "A String", # The resource path name. For example,

382

# `projects/example-project/locations/us-central1/registries/my-registry`.

383

"eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the

384

# device. All telemetry events that were successfully published by the

385

# device and acknowledged by Cloud IoT Core are guaranteed to be

386

# delivered to Cloud Pub/Sub. If multiple configurations match a message,

387

# only the first matching configuration is used. If you try to publish a

388

# device telemetry event using MQTT without specifying a Cloud Pub/Sub topic

389

# for the device's registry, the connection closes automatically. If you try

390

# to do so using an HTTP connection, an error is returned. Up to 10

391

# configurations may be provided.

392

{ # The configuration for forwarding telemetry events.

393

"subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will

394

# be used. The string must not include the leading '/' character. If empty,

395

# all strings are matched. This field is used only for telemetry events;

396

# subfolders are not supported for state changes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

397

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

398

# `projects/myProject/topics/deviceEvents`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

399

},

400

],

401

"logLevel": "A String", # **Beta Feature**

402

#

403

# The default logging verbosity for activity from devices in this registry.

404

# The verbosity level can be overridden by Device.log_level.

405

"httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.

406

"httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.

407

# Otherwise, any requests to DeviceService will fail for this registry.

408

},

409

"id": "A String", # The identifier of this device registry. For example, `myRegistry`.

410

"mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.

411

"mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT

412

# connections to this registry will fail.

413

},

414

"stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.

415

# State updates are guaranteed to be stored in the state history, but

416

# notifications to Cloud Pub/Sub are not guaranteed. For example, if

417

# permissions are misconfigured or the specified topic doesn't exist, no

418

# notification will be published but the state will still be stored in Cloud

419

# IoT Core.

420

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

421

# `projects/myProject/topics/deviceEvents`.

422

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>

428

<pre>Gets the access control policy for a resource.

429

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

434

See the operation documentation for the appropriate value for this field. (required)

435

body: object, The request body.

436

The object takes the form of:

437

438

{ # Request message for `GetIamPolicy` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

439

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

440

# `GetIamPolicy`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

441

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

442

#

443

# Valid values are 0, 1, and 3. Requests specifying an invalid value will be

444

# rejected.

445

#

446

# Requests for policies with any conditional bindings must specify version 3.

447

# Policies without any conditional bindings may specify any valid value or

448

# leave the field unset.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

449

#

450

# To learn which resources support conditions in their IAM policies, see the

451

# [IAM

452

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

453

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

454

}

455

456

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

463

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

464

{ # An Identity and Access Management (IAM) policy, which specifies access

465

# controls for Google Cloud resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

466

#

467

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

468

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

469

# `members` to a single `role`. Members can be user accounts, service accounts,

470

# Google groups, and domains (such as G Suite). A `role` is a named list of

471

# permissions; each `role` can be an IAM predefined role or a user-created

472

# custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

473

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

474

# For some types of Google Cloud resources, a `binding` can also specify a

475

# `condition`, which is a logical expression that allows access to a resource

476

# only if the expression evaluates to `true`. A condition can add constraints

477

# based on attributes of the request, the resource, or both. To learn which

478

# resources support conditions in their IAM policies, see the

479

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

480

#

481

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

482

#

483

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

484

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

485

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

486

# "role": "roles/resourcemanager.organizationAdmin",

487

# "members": [

488

# "user:mike@example.com",

489

# "group:admins@example.com",

490

# "domain:google.com",

491

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

492

# ]

493

# },

494

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

495

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

496

# "members": [

497

# "user:eve@example.com"

498

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

499

# "condition": {

500

# "title": "expirable access",

501

# "description": "Does not grant access after Sep 2020",

502

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

503

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

504

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

505

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

506

# "etag": "BwWWja0YfJA=",

507

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

508

# }

509

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

510

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

515

# - group:admins@example.com

516

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

517

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

518

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

519

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

520

# - user:eve@example.com

521

# role: roles/resourcemanager.organizationViewer

522

# condition:

523

# title: expirable access

524

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

525

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

526

# - etag: BwWWja0YfJA=

527

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

528

#

529

# For a description of IAM and its features, see the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

530

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

531

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

532

# `condition` that determines how and when the `bindings` are applied. Each

533

# of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

534

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

535

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

536

#

537

# If the condition evaluates to `true`, then this binding applies to the

538

# current request.

539

#

540

# If the condition evaluates to `false`, then this binding does not apply to

541

# the current request. However, a different role binding might grant the same

542

# role to one or more of the members in this binding.

543

#

544

# To learn which resources support conditions in their IAM policies, see the

545

# [IAM

546

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

547

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

548

# are documented at https://github.com/google/cel-spec.

549

#

550

# Example (Comparison):

551

#

552

# title: "Summary size limit"

553

# description: "Determines if a summary is less than 100 chars"

554

# expression: "document.summary.size() < 100"

555

#

556

# Example (Equality):

557

#

558

# title: "Requestor is owner"

559

# description: "Determines if requestor is the document owner"

560

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

565

# description: "Determine whether the document should be publicly visible"

566

# expression: "document.type != 'private' && document.type != 'internal'"

567

#

568

# Example (Data Manipulation):

569

#

570

# title: "Notification string"

571

# description: "Create a notification string with a timestamp."

572

# expression: "'New message received at ' + string(document.create_time)"

573

#

574

# The exact variables and functions that may be referenced within an expression

575

# are determined by the service that evaluates it. See the service

576

# documentation for additional information.

577

"description": "A String", # Optional. Description of the expression. This is a longer text which

578

# describes the expression, e.g. when hovered over it in a UI.

579

"expression": "A String", # Textual representation of an expression in Common Expression Language

580

# syntax.

581

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

582

# its purpose. This can be used e.g. in UIs which allow to enter the

583

# expression.

584

"location": "A String", # Optional. String indicating the location of the expression for error

585

# reporting, e.g. a file name and a position in the file.

586

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

587

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

588

# `members` can have the following values:

589

#

590

# * `allUsers`: A special identifier that represents anyone who is

591

# on the internet; with or without a Google account.

592

#

593

# * `allAuthenticatedUsers`: A special identifier that represents anyone

594

# who is authenticated with a Google account or a service account.

595

#

596

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

597

# account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

598

#

599

#

600

# * `serviceAccount:{emailid}`: An email address that represents a service

601

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

602

#

603

# * `group:{emailid}`: An email address that represents a Google group.

604

# For example, `admins@example.com`.

605

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

606

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

607

# identifier) representing a user that has been recently deleted. For

608

# example, `alice@example.com?uid=123456789012345678901`. If the user is

609

# recovered, this value reverts to `user:{emailid}` and the recovered user

610

# retains the role in the binding.

611

#

612

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

613

# unique identifier) representing a service account that has been recently

614

# deleted. For example,

615

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

616

# If the service account is undeleted, this value reverts to

617

# `serviceAccount:{emailid}` and the undeleted service account retains the

618

# role in the binding.

619

#

620

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

621

# identifier) representing a Google group that has been recently

622

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

623

# the group is recovered, this value reverts to `group:{emailid}` and the

624

# recovered group retains the role in the binding.

625

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

626

#

627

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

628

# users of that domain. For example, `google.com` or `example.com`.

629

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

630

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

631

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

632

"role": "A String", # Role that is assigned to `members`.

633

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

634

},

635

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

636

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

637

# prevent simultaneous updates of a policy from overwriting each other.

638

# It is strongly suggested that systems make use of the `etag` in the

639

# read-modify-write cycle to perform policy updates in order to avoid race

640

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

641

# systems are expected to put that etag in the request to `setIamPolicy` to

642

# ensure that their change will be applied to the same version of the policy.

643

#

644

# **Important:** If you use IAM Conditions, you must include the `etag` field

645

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

646

# you to overwrite a version `3` policy with a version `1` policy, and all of

647

# the conditions in the version `3` policy are lost.

648

"version": 42, # Specifies the format of the policy.

649

#

650

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

651

# are rejected.

652

#

653

# Any operation that affects conditional role bindings must specify version

654

# `3`. This requirement applies to the following operations:

655

#

656

# * Getting a policy that includes a conditional role binding

657

# * Adding a conditional role binding to a policy

658

# * Changing a conditional role binding in a policy

659

# * Removing any role binding, with or without a condition, from a policy

660

# that includes conditions

661

#

662

# **Important:** If you use IAM Conditions, you must include the `etag` field

663

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

664

# you to overwrite a version `3` policy with a version `1` policy, and all of

665

# the conditions in the version `3` policy are lost.

666

#

667

# If a policy does not include any conditions, operations on that policy may

668

# specify any valid version or leave the field unset.

669

#

670

# To learn which resources support conditions in their IAM policies, see the

671

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

676

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

677

<pre>Lists device registries.

678

679

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

680

parent: string, Required. The project and cloud region path. For example,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

681

`projects/example-project/locations/us-central1`. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

682

pageToken: string, The value returned by the last `ListDeviceRegistriesResponse`; indicates

683

that this is a continuation of a prior `ListDeviceRegistries` call and

684

the system should return the next page of data.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

685

pageSize: integer, The maximum number of registries to return in the response. If this value

686

is zero, the service will select a default size. A call may return fewer

687

objects than requested. A non-empty `next_page_token` in the response

688

indicates that more data is available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

689

x__xgafv: string, V1 error format.

690

Allowed values

691

1 - v1 error format

692

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

693

694

Returns:

695

An object of the form:

696

697

{ # Response for `ListDeviceRegistries`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

698

"deviceRegistries": [ # The registries that matched the query.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

699

{ # A container for a group of devices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

700

"credentials": [ # The credentials used to verify the device credentials. No more than 10

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

701

# credentials can be bound to a single registry at a time. The verification

702

# process occurs at the time of device creation or update. If this field is

703

# empty, no verification is performed. Otherwise, the credentials of a newly

704

# created device or added credentials of an updated device should be signed

705

# with one of these registry credentials.

706

#

707

# Note, however, that existing devices will never be affected by

708

# modifications to this list of credentials: after a device has been

709

# successfully created in a registry, it should be able to connect even if

710

# its registry credentials are revoked, deleted, or modified.

711

{ # A server-stored registry credential used to validate device credentials.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

712

"publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.

713

"x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

714

"signatureAlgorithm": "A String", # The algorithm used to sign the certificate.

715

"startTime": "A String", # The time the certificate becomes valid.

716

"expiryTime": "A String", # The time the certificate becomes invalid.

717

"subject": "A String", # The entity the certificate and public key belong to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

718

"issuer": "A String", # The entity that signed the certificate.

719

"publicKeyType": "A String", # The type of public key in the certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

720

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

721

"format": "A String", # The certificate format.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

722

"certificate": "A String", # The certificate data.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

723

},

724

},

725

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

726

"name": "A String", # The resource path name. For example,

727

# `projects/example-project/locations/us-central1/registries/my-registry`.

728

"eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the

729

# device. All telemetry events that were successfully published by the

730

# device and acknowledged by Cloud IoT Core are guaranteed to be

731

# delivered to Cloud Pub/Sub. If multiple configurations match a message,

732

# only the first matching configuration is used. If you try to publish a

733

# device telemetry event using MQTT without specifying a Cloud Pub/Sub topic

734

# for the device's registry, the connection closes automatically. If you try

735

# to do so using an HTTP connection, an error is returned. Up to 10

736

# configurations may be provided.

737

{ # The configuration for forwarding telemetry events.

738

"subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will

739

# be used. The string must not include the leading '/' character. If empty,

740

# all strings are matched. This field is used only for telemetry events;

741

# subfolders are not supported for state changes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

742

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

743

# `projects/myProject/topics/deviceEvents`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

744

},

745

],

746

"logLevel": "A String", # **Beta Feature**

747

#

748

# The default logging verbosity for activity from devices in this registry.

749

# The verbosity level can be overridden by Device.log_level.

750

"httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.

751

"httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.

752

# Otherwise, any requests to DeviceService will fail for this registry.

753

},

754

"id": "A String", # The identifier of this device registry. For example, `myRegistry`.

755

"mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.

756

"mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT

757

# connections to this registry will fail.

758

},

759

"stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.

760

# State updates are guaranteed to be stored in the state history, but

761

# notifications to Cloud Pub/Sub are not guaranteed. For example, if

762

# permissions are misconfigured or the specified topic doesn't exist, no

763

# notification will be published but the state will still be stored in Cloud

764

# IoT Core.

765

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

766

# `projects/myProject/topics/deviceEvents`.

767

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

768

},

769

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

770

"nextPageToken": "A String", # If not empty, indicates that there may be more registries that match the

771

# request; this value should be passed in a new

772

# `ListDeviceRegistriesRequest`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

778

<pre>Retrieves the next page of results.

779

780

Args:

781

previous_request: The request for the previous page. (required)

782

previous_response: The response from the request for the previous page. (required)

783

784

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

785

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

786

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

791

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

792

<pre>Updates a device registry configuration.

Args:

`projects/example-project/locations/us-central1/registries/my-registry`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

797

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

798

The object takes the form of:

799

800

{ # A container for a group of devices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

801

"credentials": [ # The credentials used to verify the device credentials. No more than 10

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

802

# credentials can be bound to a single registry at a time. The verification

803

# process occurs at the time of device creation or update. If this field is

804

# empty, no verification is performed. Otherwise, the credentials of a newly

805

# created device or added credentials of an updated device should be signed

806

# with one of these registry credentials.

807

#

808

# Note, however, that existing devices will never be affected by

809

# modifications to this list of credentials: after a device has been

810

# successfully created in a registry, it should be able to connect even if

811

# its registry credentials are revoked, deleted, or modified.

812

{ # A server-stored registry credential used to validate device credentials.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

813

"publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.

814

"x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

815

"signatureAlgorithm": "A String", # The algorithm used to sign the certificate.

816

"startTime": "A String", # The time the certificate becomes valid.

817

"expiryTime": "A String", # The time the certificate becomes invalid.

818

"subject": "A String", # The entity the certificate and public key belong to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

819

"issuer": "A String", # The entity that signed the certificate.

820

"publicKeyType": "A String", # The type of public key in the certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

821

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

822

"format": "A String", # The certificate format.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

823

"certificate": "A String", # The certificate data.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

824

},

825

},

826

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

827

"name": "A String", # The resource path name. For example,

828

# `projects/example-project/locations/us-central1/registries/my-registry`.

829

"eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the

830

# device. All telemetry events that were successfully published by the

831

# device and acknowledged by Cloud IoT Core are guaranteed to be

832

# delivered to Cloud Pub/Sub. If multiple configurations match a message,

833

# only the first matching configuration is used. If you try to publish a

834

# device telemetry event using MQTT without specifying a Cloud Pub/Sub topic

835

# for the device's registry, the connection closes automatically. If you try

836

# to do so using an HTTP connection, an error is returned. Up to 10

837

# configurations may be provided.

838

{ # The configuration for forwarding telemetry events.

839

"subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will

840

# be used. The string must not include the leading '/' character. If empty,

841

# all strings are matched. This field is used only for telemetry events;

842

# subfolders are not supported for state changes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

843

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

844

# `projects/myProject/topics/deviceEvents`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

845

},

846

],

847

"logLevel": "A String", # **Beta Feature**

848

#

849

# The default logging verbosity for activity from devices in this registry.

850

# The verbosity level can be overridden by Device.log_level.

851

"httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.

852

"httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.

853

# Otherwise, any requests to DeviceService will fail for this registry.

854

},

855

"id": "A String", # The identifier of this device registry. For example, `myRegistry`.

856

"mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.

857

"mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT

858

# connections to this registry will fail.

859

},

860

"stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.

861

# State updates are guaranteed to be stored in the state history, but

862

# notifications to Cloud Pub/Sub are not guaranteed. For example, if

863

# permissions are misconfigured or the specified topic doesn't exist, no

864

# notification will be published but the state will still be stored in Cloud

865

# IoT Core.

866

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

867

# `projects/myProject/topics/deviceEvents`.

868

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

869

}

870

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

871

updateMask: string, Required. Only updates the `device_registry` fields indicated by this mask.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

872

The field mask must not be empty, and it must not contain fields that

873

are immutable or only set by the server.

874

Mutable top-level fields: `event_notification_config`, `http_config`,

875

`mqtt_config`, and `state_notification_config`.

876

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

883

884

{ # A container for a group of devices.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

885

"credentials": [ # The credentials used to verify the device credentials. No more than 10

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

886

# credentials can be bound to a single registry at a time. The verification

887

# process occurs at the time of device creation or update. If this field is

888

# empty, no verification is performed. Otherwise, the credentials of a newly

889

# created device or added credentials of an updated device should be signed

890

# with one of these registry credentials.

891

#

892

# Note, however, that existing devices will never be affected by

893

# modifications to this list of credentials: after a device has been

894

# successfully created in a registry, it should be able to connect even if

895

# its registry credentials are revoked, deleted, or modified.

896

{ # A server-stored registry credential used to validate device credentials.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

897

"publicKeyCertificate": { # A public key certificate format and data. # A public key certificate used to verify the device credentials.

898

"x509Details": { # Details of an X.509 certificate. For informational purposes only. # [Output only] The certificate details. Used only for X.509 certificates.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

899

"signatureAlgorithm": "A String", # The algorithm used to sign the certificate.

900

"startTime": "A String", # The time the certificate becomes valid.

901

"expiryTime": "A String", # The time the certificate becomes invalid.

902

"subject": "A String", # The entity the certificate and public key belong to.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

903

"issuer": "A String", # The entity that signed the certificate.

904

"publicKeyType": "A String", # The type of public key in the certificate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

905

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

906

"format": "A String", # The certificate format.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

907

"certificate": "A String", # The certificate data.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

908

},

909

},

910

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

911

"name": "A String", # The resource path name. For example,

912

# `projects/example-project/locations/us-central1/registries/my-registry`.

913

"eventNotificationConfigs": [ # The configuration for notification of telemetry events received from the

914

# device. All telemetry events that were successfully published by the

915

# device and acknowledged by Cloud IoT Core are guaranteed to be

916

# delivered to Cloud Pub/Sub. If multiple configurations match a message,

917

# only the first matching configuration is used. If you try to publish a

918

# device telemetry event using MQTT without specifying a Cloud Pub/Sub topic

919

# for the device's registry, the connection closes automatically. If you try

920

# to do so using an HTTP connection, an error is returned. Up to 10

921

# configurations may be provided.

922

{ # The configuration for forwarding telemetry events.

923

"subfolderMatches": "A String", # If the subfolder name matches this string exactly, this configuration will

924

# be used. The string must not include the leading '/' character. If empty,

925

# all strings are matched. This field is used only for telemetry events;

926

# subfolders are not supported for state changes.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

927

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

928

# `projects/myProject/topics/deviceEvents`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

929

},

930

],

931

"logLevel": "A String", # **Beta Feature**

932

#

933

# The default logging verbosity for activity from devices in this registry.

934

# The verbosity level can be overridden by Device.log_level.

935

"httpConfig": { # The configuration of the HTTP bridge for a device registry. # The DeviceService (HTTP) configuration for this device registry.

936

"httpEnabledState": "A String", # If enabled, allows devices to use DeviceService via the HTTP protocol.

937

# Otherwise, any requests to DeviceService will fail for this registry.

938

},

939

"id": "A String", # The identifier of this device registry. For example, `myRegistry`.

940

"mqttConfig": { # The configuration of MQTT for a device registry. # The MQTT configuration for this device registry.

941

"mqttEnabledState": "A String", # If enabled, allows connections using the MQTT protocol. Otherwise, MQTT

942

# connections to this registry will fail.

943

},

944

"stateNotificationConfig": { # The configuration for notification of new states received from the device. # The configuration for notification of new states received from the device.

945

# State updates are guaranteed to be stored in the state history, but

946

# notifications to Cloud Pub/Sub are not guaranteed. For example, if

947

# permissions are misconfigured or the specified topic doesn't exist, no

948

# notification will be published but the state will still be stored in Cloud

949

# IoT Core.

950

"pubsubTopicName": "A String", # A Cloud Pub/Sub topic name. For example,

951

# `projects/myProject/topics/deviceEvents`.

952

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

957

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

958

<pre>Sets the access control policy on the specified resource. Replaces any

existing policy.

Args:

resource: string, REQUIRED: The resource for which the policy is being specified.

963

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

964

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

965

The object takes the form of:

966

967

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

968

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

969

# the policy is limited to a few 10s of KB. An empty policy is a

970

# valid policy but certain Cloud Platform services (such as Projects)

971

# might reject them.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

972

# controls for Google Cloud resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

973

#

974

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

975

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

976

# `members` to a single `role`. Members can be user accounts, service accounts,

977

# Google groups, and domains (such as G Suite). A `role` is a named list of

978

# permissions; each `role` can be an IAM predefined role or a user-created

979

# custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

980

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

981

# For some types of Google Cloud resources, a `binding` can also specify a

982

# `condition`, which is a logical expression that allows access to a resource

983

# only if the expression evaluates to `true`. A condition can add constraints

984

# based on attributes of the request, the resource, or both. To learn which

985

# resources support conditions in their IAM policies, see the

986

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

987

#

988

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

989

#

990

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

991

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

992

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

993

# "role": "roles/resourcemanager.organizationAdmin",

994

# "members": [

995

# "user:mike@example.com",

996

# "group:admins@example.com",

997

# "domain:google.com",

998

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

999

# ]

1000

# },

1001

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1002

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1003

# "members": [

1004

# "user:eve@example.com"

1005

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1006

# "condition": {

1007

# "title": "expirable access",

1008

# "description": "Does not grant access after Sep 2020",

1009

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1010

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1011

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1012

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1013

# "etag": "BwWWja0YfJA=",

1014

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1015

# }

1016

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1017

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1022

# - group:admins@example.com

1023

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1024

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1025

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1026

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1027

# - user:eve@example.com

1028

# role: roles/resourcemanager.organizationViewer

1029

# condition:

1030

# title: expirable access

1031

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1032

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1033

# - etag: BwWWja0YfJA=

1034

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1035

#

1036

# For a description of IAM and its features, see the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1037

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1038

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1039

# `condition` that determines how and when the `bindings` are applied. Each

1040

# of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1041

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1042

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1043

#

1044

# If the condition evaluates to `true`, then this binding applies to the

1045

# current request.

1046

#

1047

# If the condition evaluates to `false`, then this binding does not apply to

1048

# the current request. However, a different role binding might grant the same

1049

# role to one or more of the members in this binding.

1050

#

1051

# To learn which resources support conditions in their IAM policies, see the

1052

# [IAM

1053

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1054

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1055

# are documented at https://github.com/google/cel-spec.

1056

#

1057

# Example (Comparison):

1058

#

1059

# title: "Summary size limit"

1060

# description: "Determines if a summary is less than 100 chars"

1061

# expression: "document.summary.size() < 100"

1062

#

1063

# Example (Equality):

1064

#

1065

# title: "Requestor is owner"

1066

# description: "Determines if requestor is the document owner"

1067

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1072

# description: "Determine whether the document should be publicly visible"

1073

# expression: "document.type != 'private' && document.type != 'internal'"

1074

#

1075

# Example (Data Manipulation):

1076

#

1077

# title: "Notification string"

1078

# description: "Create a notification string with a timestamp."

1079

# expression: "'New message received at ' + string(document.create_time)"

1080

#

1081

# The exact variables and functions that may be referenced within an expression

1082

# are determined by the service that evaluates it. See the service

1083

# documentation for additional information.

1084

"description": "A String", # Optional. Description of the expression. This is a longer text which

1085

# describes the expression, e.g. when hovered over it in a UI.

1086

"expression": "A String", # Textual representation of an expression in Common Expression Language

1087

# syntax.

1088

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

1089

# its purpose. This can be used e.g. in UIs which allow to enter the

1090

# expression.

1091

"location": "A String", # Optional. String indicating the location of the expression for error

1092

# reporting, e.g. a file name and a position in the file.

1093

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1094

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1095

# `members` can have the following values:

1096

#

1097

# * `allUsers`: A special identifier that represents anyone who is

1098

# on the internet; with or without a Google account.

1099

#

1100

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1101

# who is authenticated with a Google account or a service account.

1102

#

1103

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1104

# account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1105

#

1106

#

1107

# * `serviceAccount:{emailid}`: An email address that represents a service

1108

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1109

#

1110

# * `group:{emailid}`: An email address that represents a Google group.

1111

# For example, `admins@example.com`.

1112

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1113

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1114

# identifier) representing a user that has been recently deleted. For

1115

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1116

# recovered, this value reverts to `user:{emailid}` and the recovered user

1117

# retains the role in the binding.

1118

#

1119

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1120

# unique identifier) representing a service account that has been recently

1121

# deleted. For example,

1122

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1123

# If the service account is undeleted, this value reverts to

1124

# `serviceAccount:{emailid}` and the undeleted service account retains the

1125

# role in the binding.

1126

#

1127

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1128

# identifier) representing a Google group that has been recently

1129

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1130

# the group is recovered, this value reverts to `group:{emailid}` and the

1131

# recovered group retains the role in the binding.

1132

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1133

#

1134

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

1135

# users of that domain. For example, `google.com` or `example.com`.

1136

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1137

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1138

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1139

"role": "A String", # Role that is assigned to `members`.

1140

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1141

},

1142

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1143

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1144

# prevent simultaneous updates of a policy from overwriting each other.

1145

# It is strongly suggested that systems make use of the `etag` in the

1146

# read-modify-write cycle to perform policy updates in order to avoid race

1147

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1148

# systems are expected to put that etag in the request to `setIamPolicy` to

1149

# ensure that their change will be applied to the same version of the policy.

1150

#

1151

# **Important:** If you use IAM Conditions, you must include the `etag` field

1152

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1153

# you to overwrite a version `3` policy with a version `1` policy, and all of

1154

# the conditions in the version `3` policy are lost.

1155

"version": 42, # Specifies the format of the policy.

1156

#

1157

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1158

# are rejected.

1159

#

1160

# Any operation that affects conditional role bindings must specify version

1161

# `3`. This requirement applies to the following operations:

1162

#

1163

# * Getting a policy that includes a conditional role binding

1164

# * Adding a conditional role binding to a policy

1165

# * Changing a conditional role binding in a policy

1166

# * Removing any role binding, with or without a condition, from a policy

1167

# that includes conditions

1168

#

1169

# **Important:** If you use IAM Conditions, you must include the `etag` field

1170

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1171

# you to overwrite a version `3` policy with a version `1` policy, and all of

1172

# the conditions in the version `3` policy are lost.

1173

#

1174

# If a policy does not include any conditions, operations on that policy may

1175

# specify any valid version or leave the field unset.

1176

#

1177

# To learn which resources support conditions in their IAM policies, see the

1178

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1189

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1190

{ # An Identity and Access Management (IAM) policy, which specifies access

1191

# controls for Google Cloud resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1192

#

1193

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1194

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1195

# `members` to a single `role`. Members can be user accounts, service accounts,

1196

# Google groups, and domains (such as G Suite). A `role` is a named list of

1197

# permissions; each `role` can be an IAM predefined role or a user-created

1198

# custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1199

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1200

# For some types of Google Cloud resources, a `binding` can also specify a

1201

# `condition`, which is a logical expression that allows access to a resource

1202

# only if the expression evaluates to `true`. A condition can add constraints

1203

# based on attributes of the request, the resource, or both. To learn which

1204

# resources support conditions in their IAM policies, see the

1205

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1206

#

1207

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1208

#

1209

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1210

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1211

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1212

# "role": "roles/resourcemanager.organizationAdmin",

1213

# "members": [

1214

# "user:mike@example.com",

1215

# "group:admins@example.com",

1216

# "domain:google.com",

1217

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1218

# ]

1219

# },

1220

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1221

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1222

# "members": [

1223

# "user:eve@example.com"

1224

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1225

# "condition": {

1226

# "title": "expirable access",

1227

# "description": "Does not grant access after Sep 2020",

1228

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1229

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1230

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1231

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1232

# "etag": "BwWWja0YfJA=",

1233

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1234

# }

1235

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1236

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1241

# - group:admins@example.com

1242

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1243

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1244

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1245

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1246

# - user:eve@example.com

1247

# role: roles/resourcemanager.organizationViewer

1248

# condition:

1249

# title: expirable access

1250

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1251

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1252

# - etag: BwWWja0YfJA=

1253

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1254

#

1255

# For a description of IAM and its features, see the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1256

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1257

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1258

# `condition` that determines how and when the `bindings` are applied. Each

1259

# of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1260

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1261

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1262

#

1263

# If the condition evaluates to `true`, then this binding applies to the

1264

# current request.

1265

#

1266

# If the condition evaluates to `false`, then this binding does not apply to

1267

# the current request. However, a different role binding might grant the same

1268

# role to one or more of the members in this binding.

1269

#

1270

# To learn which resources support conditions in their IAM policies, see the

1271

# [IAM

1272

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1273

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1274

# are documented at https://github.com/google/cel-spec.

1275

#

1276

# Example (Comparison):

1277

#

1278

# title: "Summary size limit"

1279

# description: "Determines if a summary is less than 100 chars"

1280

# expression: "document.summary.size() < 100"

1281

#

1282

# Example (Equality):

1283

#

1284

# title: "Requestor is owner"

1285

# description: "Determines if requestor is the document owner"

1286

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1291

# description: "Determine whether the document should be publicly visible"

1292

# expression: "document.type != 'private' && document.type != 'internal'"

1293

#

1294

# Example (Data Manipulation):

1295

#

1296

# title: "Notification string"

1297

# description: "Create a notification string with a timestamp."

1298

# expression: "'New message received at ' + string(document.create_time)"

1299

#

1300

# The exact variables and functions that may be referenced within an expression

1301

# are determined by the service that evaluates it. See the service

1302

# documentation for additional information.

1303

"description": "A String", # Optional. Description of the expression. This is a longer text which

1304

# describes the expression, e.g. when hovered over it in a UI.

1305

"expression": "A String", # Textual representation of an expression in Common Expression Language

1306

# syntax.

1307

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

1308

# its purpose. This can be used e.g. in UIs which allow to enter the

1309

# expression.

1310

"location": "A String", # Optional. String indicating the location of the expression for error

1311

# reporting, e.g. a file name and a position in the file.

1312

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1313

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1314

# `members` can have the following values:

1315

#

1316

# * `allUsers`: A special identifier that represents anyone who is

1317

# on the internet; with or without a Google account.

1318

#

1319

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1320

# who is authenticated with a Google account or a service account.

1321

#

1322

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1323

# account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1324

#

1325

#

1326

# * `serviceAccount:{emailid}`: An email address that represents a service

1327

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1328

#

1329

# * `group:{emailid}`: An email address that represents a Google group.

1330

# For example, `admins@example.com`.

1331

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1332

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1333

# identifier) representing a user that has been recently deleted. For

1334

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1335

# recovered, this value reverts to `user:{emailid}` and the recovered user

1336

# retains the role in the binding.

1337

#

1338

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1339

# unique identifier) representing a service account that has been recently

1340

# deleted. For example,

1341

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1342

# If the service account is undeleted, this value reverts to

1343

# `serviceAccount:{emailid}` and the undeleted service account retains the

1344

# role in the binding.

1345

#

1346

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1347

# identifier) representing a Google group that has been recently

1348

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1349

# the group is recovered, this value reverts to `group:{emailid}` and the

1350

# recovered group retains the role in the binding.

1351

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1352

#

1353

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

1354

# users of that domain. For example, `google.com` or `example.com`.

1355

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1356

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1357

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1358

"role": "A String", # Role that is assigned to `members`.

1359

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1360

},

1361

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1362

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1363

# prevent simultaneous updates of a policy from overwriting each other.

1364

# It is strongly suggested that systems make use of the `etag` in the

1365

# read-modify-write cycle to perform policy updates in order to avoid race

1366

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1367

# systems are expected to put that etag in the request to `setIamPolicy` to

1368

# ensure that their change will be applied to the same version of the policy.

1369

#

1370

# **Important:** If you use IAM Conditions, you must include the `etag` field

1371

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1372

# you to overwrite a version `3` policy with a version `1` policy, and all of

1373

# the conditions in the version `3` policy are lost.

1374

"version": 42, # Specifies the format of the policy.

1375

#

1376

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1377

# are rejected.

1378

#

1379

# Any operation that affects conditional role bindings must specify version

1380

# `3`. This requirement applies to the following operations:

1381

#

1382

# * Getting a policy that includes a conditional role binding

1383

# * Adding a conditional role binding to a policy

1384

# * Changing a conditional role binding in a policy

1385

# * Removing any role binding, with or without a condition, from a policy

1386

# that includes conditions

1387

#

1388

# **Important:** If you use IAM Conditions, you must include the `etag` field

1389

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1390

# you to overwrite a version `3` policy with a version `1` policy, and all of

1391

# the conditions in the version `3` policy are lost.

1392

#

1393

# If a policy does not include any conditions, operations on that policy may

1394

# specify any valid version or leave the field unset.

1395

#

1396

# To learn which resources support conditions in their IAM policies, see the

1397

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1402

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1403

<pre>Returns permissions that a caller has on the specified resource.

1404

If the resource does not exist, this will return an empty set of

1405

permissions, not a NOT_FOUND error.

1406

1407

Args:

1408

resource: string, REQUIRED: The resource for which the policy detail is being requested.

1409

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1410

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1411

The object takes the form of:

1412

1413

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1414

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

1415

# wildcards (such as '*' or 'storage.*') are not allowed. For more

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1416

# information see

1417

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1418

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1429

1430

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1431

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1432

# allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1433

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1439

<code class="details" id="unbindDeviceFromGateway">unbindDeviceFromGateway(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1440

<pre>Deletes the association between the device and the gateway.

1441

1442

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1443

parent: string, Required. The name of the registry. For example,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1444

`projects/example-project/locations/us-central1/registries/my-registry`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1445

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1446

The object takes the form of:

1447

1448

{ # Request for `UnbindDeviceFromGateway`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1449

"gatewayId": "A String", # Required. The value of `gateway_id` can be either the device numeric ID or the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1450

# user-defined device identifier.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1451

"deviceId": "A String", # Required. The device to disassociate from the specified gateway. The value of

Bu Sun Kim