Blame - docs/dyn/bigtableadmin_v2.projects.instances.html - platform/external/python/google-api-python-client

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

[diff] [blame]

93

<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]

94

<p class="firstline">Create an instance within a project.</p>

95

96

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

97

<p class="firstline">Delete an instance from a project.</p>

98

99

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

100

<p class="firstline">Gets information about an instance.</p>

101

102

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

103

<p class="firstline">Gets the access control policy for an instance resource. Returns an empty</p>

104

105

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

106

<p class="firstline">Lists information about instances in a project.</p>

107

108

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

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

Bu Sun Kim

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

[diff] [blame]

112

<p class="firstline">Partially updates an instance within a project. This method can modify all</p>

113

Dan O'Meara

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

[diff] [blame]

114

<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]

115

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

116

Dan O'Meara

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

[diff] [blame]

117

<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]

118

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

119

Dan O'Meara

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

[diff] [blame]

120

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

Bu Sun Kim

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

[diff] [blame]

121

<p class="firstline">Updates an instance within a project. This method updates only the display</p>

122

<h3>Method Details</h3>

123

Dan O'Meara

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

[diff] [blame]

124

<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]

125

<pre>Create an instance within a project.

126

127

Args:

Dan O'Meara

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

[diff] [blame]

128

parent: string, Required. The unique name of the project in which to create the new instance.

129

Values are of the form `projects/{project}`. (required)

130

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

131

The object takes the form of:

132

133

{ # Request message for BigtableInstanceAdmin.CreateInstance.

Bu Sun Kim

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

[diff] [blame]

134

"clusters": { # Required. The clusters to be created within the instance, mapped by desired

135

# cluster ID, e.g., just `mycluster` rather than

136

# `projects/myproject/instances/myinstance/clusters/mycluster`.

137

# Fields marked `OutputOnly` must be left blank.

138

# Currently, at most four clusters can be specified.

139

"a_key": { # A resizable group of nodes in a particular cloud location, capable

140

# of serving all Tables in the parent

141

# Instance.

142

"location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best

143

# performance, clients should be located as close as possible to this

144

# cluster. Currently only zones are supported, so values should be of the

145

# form `projects/{project}/locations/{zone}`.

146

"name": "A String", # The unique name of the cluster. Values are of the form

147

# `projects/{project}/instances/{instance}/clusters/a-z*`.

148

"defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its

149

# parent instance's tables, unless explicitly overridden.

150

"serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher

151

# throughput and more consistent performance.

152

"state": "A String", # Output only. The current state of the cluster.

153

},

154

},

155

"instanceId": "A String", # Required. The ID to be used when referring to the new instance within its project,

156

# e.g., just `myinstance` rather than

157

# `projects/myproject/instances/myinstance`.

Bu Sun Kim

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

[diff] [blame]

158

"instance": { # A collection of Bigtable Tables and # Required. The instance to create.

159

# Fields marked `OutputOnly` must be left blank.

160

# the resources that serve them.

161

# All tables in an instance are served from all

162

# Clusters in the instance.

Bu Sun Kim

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

[diff] [blame]

163

"state": "A String", # Output only. The current state of the instance.

164

"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs.

165

# Can be changed at any time, but should be kept globally unique

166

# to avoid confusion.

167

"name": "A String", # The unique name of the instance. Values are of the form

168

# `projects/{project}/instances/a-z+[a-z0-9]`.

169

"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.

Bu Sun Kim

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

[diff] [blame]

170

"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud

171

# resources into groups that reflect a customer's organizational needs and

172

# deployment strategies. They can be used to filter resources and aggregate

173

# metrics.

174

#

175

# * Label keys must be between 1 and 63 characters long and must conform to

176

# the regular expression: `\p{Ll}\p{Lo}{0,62}`.

177

# * Label values must be between 0 and 63 characters long and must conform to

178

# the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.

179

# * No more than 64 labels can be associated with a given resource.

180

# * Keys and values must both be under 128 bytes.

181

"a_key": "A String",

182

},

Bu Sun Kim

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

[diff] [blame]

183

},

184

"parent": "A String", # Required. The unique name of the project in which to create the new instance.

185

# Values are of the form `projects/{project}`.

Bu Sun Kim

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

[diff] [blame]

186

}

187

188

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

195

196

{ # This resource represents a long-running operation that is the result of a

197

# network API call.

Bu Sun Kim

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

[diff] [blame]

198

"metadata": { # Service-specific metadata associated with the operation. It typically

199

# contains progress information and common metadata such as create time.

200

# Some services might not provide such metadata. Any method that returns a

201

# long-running operation should document the metadata type, if any.

202

"a_key": "", # Properties of the object. Contains field @type with type URL.

203

},

204

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

205

# different programming environments, including REST APIs and RPC APIs. It is

206

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

207

# three pieces of data: error code, error message, and error details.

208

#

209

# You can find out more about this error model and how to work with it in the

210

# [API Design Guide](https://cloud.google.com/apis/design/errors).

211

"details": [ # A list of messages that carry the error details. There is a common set of

212

# message types for APIs to use.

213

{

214

"a_key": "", # Properties of the object. Contains field @type with type URL.

215

},

216

],

217

"message": "A String", # A developer-facing error message, which should be in English. Any

218

# user-facing error message should be localized and sent in the

219

# google.rpc.Status.details field, or localized by the client.

220

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

221

},

Bu Sun Kim

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

[diff] [blame]

222

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

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

[diff] [blame]

223

# method returns no data on success, such as `Delete`, the response is

224

# `google.protobuf.Empty`. If the original method is standard

225

# `Get`/`Create`/`Update`, the response should be the resource. For other

226

# methods, the response should have the type `XxxResponse`, where `Xxx`

227

# is the original method name. For example, if the original method name

228

# is `TakeSnapshot()`, the inferred response type is

229

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

230

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

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

[diff] [blame]

231

},

Bu Sun Kim

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

[diff] [blame]

232

"name": "A String", # The server-assigned name, which is only unique within the same service that

Dan O'Meara

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

[diff] [blame]

233

# originally returns it. If you use the default HTTP mapping, the

234

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

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

[diff] [blame]

235

"done": True or False, # If the value is `false`, it means the operation is still in progress.

236

# If `true`, the operation is completed, and either `error` or `response` is

237

# available.

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>

243

<pre>Delete an instance from a project.

244

245

Args:

Dan O'Meara

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

[diff] [blame]

246

247

Values are of the form `projects/{project}/instances/{instance}`. (required)

Bu Sun Kim

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

[diff] [blame]

248

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

255

256

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

257

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

258

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

259

#

260

# service Foo {

261

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

262

# }

263

#

264

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

}</pre>

</div>

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

270

<pre>Gets information about an instance.

271

272

Args:

Dan O'Meara

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

[diff] [blame]

273

name: string, Required. The unique name of the requested instance. Values are of the form

274

`projects/{project}/instances/{instance}`. (required)

Bu Sun Kim

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

[diff] [blame]

275

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

282

283

{ # A collection of Bigtable Tables and

Bu Sun Kim

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

[diff] [blame]

284

# the resources that serve them.

285

# All tables in an instance are served from all

286

# Clusters in the instance.

Bu Sun Kim

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

[diff] [blame]

287

"state": "A String", # Output only. The current state of the instance.

288

"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs.

289

# Can be changed at any time, but should be kept globally unique

290

# to avoid confusion.

291

"name": "A String", # The unique name of the instance. Values are of the form

292

# `projects/{project}/instances/a-z+[a-z0-9]`.

293

"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.

Bu Sun Kim

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

[diff] [blame]

294

"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud

295

# resources into groups that reflect a customer's organizational needs and

296

# deployment strategies. They can be used to filter resources and aggregate

297

# metrics.

298

#

299

# * Label keys must be between 1 and 63 characters long and must conform to

300

# the regular expression: `\p{Ll}\p{Lo}{0,62}`.

301

# * Label values must be between 0 and 63 characters long and must conform to

302

# the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.

303

# * No more than 64 labels can be associated with a given resource.

304

# * Keys and values must both be under 128 bytes.

305

"a_key": "A String",

306

},

Bu Sun Kim

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

[diff] [blame]

307

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

312

<pre>Gets the access control policy for an instance resource. Returns an empty

313

policy if an instance exists but does not have a policy set.

314

315

Args:

316

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

317

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

318

body: object, The request body.

319

The object takes the form of:

320

321

{ # Request message for `GetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

322

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

Bu Sun Kim

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

[diff] [blame]

323

# `GetIamPolicy`.

Bu Sun Kim

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

[diff] [blame]

324

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

Dan O'Meara

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

[diff] [blame]

325

#

326

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

327

# rejected.

328

#

329

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

330

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

331

# leave the field unset.

Bu Sun Kim

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

[diff] [blame]

332

#

333

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

334

# [IAM

335

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

Dan O'Meara

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

[diff] [blame]

336

},

Bu Sun Kim

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

[diff] [blame]

337

}

338

339

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

346

Dan O'Meara

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

[diff] [blame]

347

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

348

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

349

#

350

#

Dan O'Meara

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

[diff] [blame]

351

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

352

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

353

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

354

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

355

# custom role.

Bu Sun Kim

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

[diff] [blame]

356

#

Bu Sun Kim

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

[diff] [blame]

357

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

358

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

359

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

360

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

361

# resources support conditions in their IAM policies, see the

362

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

Dan O'Meara

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

[diff] [blame]

363

#

364

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

365

#

366

# {

Bu Sun Kim

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

[diff] [blame]

367

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

368

# {

Bu Sun Kim

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

[diff] [blame]

369

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

370

# "members": [

371

# "user:mike@example.com",

372

# "group:admins@example.com",

373

# "domain:google.com",

374

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

Bu Sun Kim

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

[diff] [blame]

375

# ]

376

# },

377

# {

Bu Sun Kim

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

[diff] [blame]

378

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

Bu Sun Kim

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

[diff] [blame]

379

# "members": [

380

# "user:eve@example.com"

381

# ],

Bu Sun Kim

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

[diff] [blame]

382

# "condition": {

383

# "title": "expirable access",

384

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

385

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

Dan O'Meara

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

[diff] [blame]

386

# }

Bu Sun Kim

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

[diff] [blame]

387

# }

Dan O'Meara

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

[diff] [blame]

388

# ],

Bu Sun Kim

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

[diff] [blame]

389

# "etag": "BwWWja0YfJA=",

390

# "version": 3

Bu Sun Kim

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

[diff] [blame]

391

# }

392

#

Dan O'Meara

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

[diff] [blame]

393

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

398

# - group:admins@example.com

399

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

400

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

401

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

402

# - members:

Dan O'Meara

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

[diff] [blame]

403

# - user:eve@example.com

404

# role: roles/resourcemanager.organizationViewer

405

# condition:

406

# title: expirable access

407

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

408

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

Dan O'Meara

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

[diff] [blame]

409

# - etag: BwWWja0YfJA=

410

# - version: 3

Bu Sun Kim

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

[diff] [blame]

411

#

412

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

Dan O'Meara

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

[diff] [blame]

413

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

Bu Sun Kim

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

[diff] [blame]

414

"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]

415

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

416

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

417

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

Bu Sun Kim

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

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame]

419

#

420

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

421

# current request.

422

#

423

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

424

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

425

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

426

#

427

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

428

# [IAM

429

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

Bu Sun Kim

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

[diff] [blame]

430

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

431

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

432

#

433

# Example (Comparison):

434

#

435

# title: "Summary size limit"

436

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

437

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

438

#

439

# Example (Equality):

440

#

441

# title: "Requestor is owner"

442

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

443

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

#

# Example (Logic):

#

# title: "Public documents"

448

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

449

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

450

#

451

# Example (Data Manipulation):

452

#

453

# title: "Notification string"

454

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

455

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

456

#

457

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

458

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

459

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

460

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

461

# syntax.

462

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

463

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

464

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

465

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

Bu Sun Kim

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

[diff] [blame]

466

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

467

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

468

# expression.

Bu Sun Kim

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

[diff] [blame]

469

},

470

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

Dan O'Meara

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

[diff] [blame]

471

# `members` can have the following values:

472

#

473

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

474

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

475

#

476

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

477

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

478

#

479

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

480

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

481

#

482

#

483

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

484

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

485

#

486

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

487

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

488

#

489

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

490

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

491

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

492

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

493

# retains the role in the binding.

494

#

495

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

496

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

497

# deleted. For example,

498

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

499

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

500

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

501

# role in the binding.

502

#

503

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

504

# identifier) representing a Google group that has been recently

505

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

506

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

507

# recovered group retains the role in the binding.

508

#

509

#

510

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

511

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

512

#

Bu Sun Kim

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

[diff] [blame]

513

"A String",

Dan O'Meara

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

[diff] [blame]

514

],

Bu Sun Kim

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

[diff] [blame]

515

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

516

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

Dan O'Meara

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

[diff] [blame]

517

},

518

],

Bu Sun Kim

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

[diff] [blame]

519

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

520

{ # Specifies the audit configuration for a service.

521

# The configuration determines which permission types are logged, and what

522

# identities, if any, are exempted from logging.

523

# An AuditConfig must have one or more AuditLogConfigs.

524

#

525

# If there are AuditConfigs for both `allServices` and a specific service,

526

# the union of the two AuditConfigs is used for that service: the log_types

527

# specified in each AuditConfig are enabled, and the exempted_members in each

528

# AuditLogConfig are exempted.

529

#

530

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

536

# "audit_log_configs": [

537

# {

538

# "log_type": "DATA_READ",

539

# "exempted_members": [

540

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

545

# },

546

# {

547

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com",

553

# "audit_log_configs": [

554

# {

555

# "log_type": "DATA_READ"

556

# },

557

# {

558

# "log_type": "DATA_WRITE",

559

# "exempted_members": [

560

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

569

# logging. It also exempts jose@example.com from DATA_READ logging, and

570

# aliya@example.com from DATA_WRITE logging.

571

"auditLogConfigs": [ # The configuration for logging of each type of permission.

572

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

577

# {

578

# "log_type": "DATA_READ",

579

# "exempted_members": [

580

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

590

# jose@example.com from DATA_READ logging.

591

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

592

# permission.

593

# Follows the same format of Binding.members.

594

"A String",

595

],

596

"logType": "A String", # The log type that this config enables.

597

},

598

],

599

"service": "A String", # Specifies a service that will be enabled for audit logging.

600

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

601

# `allServices` is a special value that covers all services.

602

},

603

],

Bu Sun Kim

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

[diff] [blame]

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

#

612

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

613

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

614

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

615

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

Bu Sun Kim

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

[diff] [blame]

616

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

617

#

618

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

619

# are rejected.

620

#

621

# Any operation that affects conditional role bindings must specify version

622

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

623

#

624

# * Getting a policy that includes a conditional role binding

625

# * Adding a conditional role binding to a policy

626

# * Changing a conditional role binding in a policy

627

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

628

# that includes conditions

629

#

630

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

631

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

632

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

633

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

634

#

635

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

636

# specify any valid version or leave the field unset.

637

#

638

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

639

# [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>

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

645

<pre>Lists information about instances in a project.

646

647

Args:

Dan O'Meara

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

[diff] [blame]

648

parent: string, Required. The unique name of the project for which a list of instances is requested.

649

Values are of the form `projects/{project}`. (required)

Bu Sun Kim

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

[diff] [blame]

650

pageToken: string, DEPRECATED: This field is unused and ignored.

651

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

658

659

{ # Response message for BigtableInstanceAdmin.ListInstances.

Bu Sun Kim

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

[diff] [blame]

660

"failedLocations": [ # Locations from which Instance information could not be retrieved,

Bu Sun Kim

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

[diff] [blame]

661

# due to an outage or some other transient condition.

662

# Instances whose Clusters are all in one of the failed locations

663

# may be missing from `instances`, and Instances with at least one

664

# Cluster in a failed location may only have partial information returned.

Dan O'Meara

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

[diff] [blame]

665

# Values are of the form `projects/<project>/locations/<zone_id>`

Bu Sun Kim

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

[diff] [blame]

666

"A String",

Bu Sun Kim

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

[diff] [blame]

667

],

Bu Sun Kim

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

[diff] [blame]

668

"nextPageToken": "A String", # DEPRECATED: This field is unused and ignored.

Bu Sun Kim

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

[diff] [blame]

669

"instances": [ # The list of requested instances.

670

{ # A collection of Bigtable Tables and

671

# the resources that serve them.

672

# All tables in an instance are served from all

673

# Clusters in the instance.

Bu Sun Kim

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

[diff] [blame]

674

"state": "A String", # Output only. The current state of the instance.

675

"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs.

676

# Can be changed at any time, but should be kept globally unique

677

# to avoid confusion.

678

"name": "A String", # The unique name of the instance. Values are of the form

679

# `projects/{project}/instances/a-z+[a-z0-9]`.

680

"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.

Bu Sun Kim

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

[diff] [blame]

681

"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud

682

# resources into groups that reflect a customer's organizational needs and

683

# deployment strategies. They can be used to filter resources and aggregate

684

# metrics.

685

#

686

# * Label keys must be between 1 and 63 characters long and must conform to

687

# the regular expression: `\p{Ll}\p{Lo}{0,62}`.

688

# * Label values must be between 0 and 63 characters long and must conform to

689

# the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.

690

# * No more than 64 labels can be associated with a given resource.

691

# * Keys and values must both be under 128 bytes.

692

"a_key": "A String",

693

},

Bu Sun Kim

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

[diff] [blame]

694

},

695

],

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>

701

<pre>Retrieves the next page of results.

702

703

Args:

704

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

705

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

706

707

Returns:

Bu Sun Kim

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

[diff] [blame]

708

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]

709

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]

714

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

Bu Sun Kim

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

[diff] [blame]

715

<pre>Partially updates an instance within a project. This method can modify all

716

fields of an Instance and is the preferred way to update an Instance.

717

718

Args:

Bu Sun Kim

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

[diff] [blame]

719

Dan O'Meara

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

[diff] [blame]

720

`projects/{project}/instances/a-z+[a-z0-9]`. (required)

721

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

722

The object takes the form of:

723

724

{ # A collection of Bigtable Tables and

Bu Sun Kim

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

[diff] [blame]

725

# the resources that serve them.

726

# All tables in an instance are served from all

727

# Clusters in the instance.

Bu Sun Kim

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

[diff] [blame]

728

"state": "A String", # Output only. The current state of the instance.

729

"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs.

730

# Can be changed at any time, but should be kept globally unique

731

# to avoid confusion.

732

"name": "A String", # The unique name of the instance. Values are of the form

733

# `projects/{project}/instances/a-z+[a-z0-9]`.

734

"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.

Bu Sun Kim

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

[diff] [blame]

735

"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud

736

# resources into groups that reflect a customer's organizational needs and

737

# deployment strategies. They can be used to filter resources and aggregate

738

# metrics.

739

#

740

# * Label keys must be between 1 and 63 characters long and must conform to

741

# the regular expression: `\p{Ll}\p{Lo}{0,62}`.

742

# * Label values must be between 0 and 63 characters long and must conform to

743

# the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.

744

# * No more than 64 labels can be associated with a given resource.

745

# * Keys and values must both be under 128 bytes.

746

"a_key": "A String",

747

},

Bu Sun Kim

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

[diff] [blame]

748

}

Bu Sun Kim

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

[diff] [blame]

749

Dan O'Meara

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

[diff] [blame]

750

updateMask: string, Required. The subset of Instance fields which should be replaced.

Bu Sun Kim

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

[diff] [blame]

751

Must be explicitly set.

752

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

759

760

{ # This resource represents a long-running operation that is the result of a

761

# network API call.

Bu Sun Kim

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

[diff] [blame]

762

"metadata": { # Service-specific metadata associated with the operation. It typically

763

# contains progress information and common metadata such as create time.

764

# Some services might not provide such metadata. Any method that returns a

765

# long-running operation should document the metadata type, if any.

766

"a_key": "", # Properties of the object. Contains field @type with type URL.

767

},

768

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

769

# different programming environments, including REST APIs and RPC APIs. It is

770

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

771

# three pieces of data: error code, error message, and error details.

772

#

773

# You can find out more about this error model and how to work with it in the

774

# [API Design Guide](https://cloud.google.com/apis/design/errors).

775

"details": [ # A list of messages that carry the error details. There is a common set of

776

# message types for APIs to use.

777

{

778

"a_key": "", # Properties of the object. Contains field @type with type URL.

779

},

780

],

781

"message": "A String", # A developer-facing error message, which should be in English. Any

782

# user-facing error message should be localized and sent in the

783

# google.rpc.Status.details field, or localized by the client.

784

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

785

},

Bu Sun Kim

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

[diff] [blame]

786

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

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

[diff] [blame]

787

# method returns no data on success, such as `Delete`, the response is

788

# `google.protobuf.Empty`. If the original method is standard

789

# `Get`/`Create`/`Update`, the response should be the resource. For other

790

# methods, the response should have the type `XxxResponse`, where `Xxx`

791

# is the original method name. For example, if the original method name

792

# is `TakeSnapshot()`, the inferred response type is

793

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

794

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

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

[diff] [blame]

795

},

Bu Sun Kim

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

[diff] [blame]

796

"name": "A String", # The server-assigned name, which is only unique within the same service that

Dan O'Meara

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

[diff] [blame]

797

# originally returns it. If you use the default HTTP mapping, the

798

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

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

[diff] [blame]

799

"done": True or False, # If the value is `false`, it means the operation is still in progress.

800

# If `true`, the operation is completed, and either `error` or `response` is

801

# available.

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]

806

<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]

807

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

existing policy.

Args:

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

812

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

Dan O'Meara

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

[diff] [blame]

813

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

814

The object takes the form of:

815

816

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

817

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

818

# the fields in the mask will be modified. If no mask is provided, the

819

# following default mask is used:

820

#

821

# `paths: "bindings, etag"`

Bu Sun Kim

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

[diff] [blame]

822

"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]

823

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

824

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

825

# might reject them.

Dan O'Meara

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

[diff] [blame]

826

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

827

#

828

#

Dan O'Meara

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

[diff] [blame]

829

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

830

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

831

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

832

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

833

# custom role.

Bu Sun Kim

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

[diff] [blame]

834

#

Bu Sun Kim

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

[diff] [blame]

835

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

836

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

837

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

838

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

839

# resources support conditions in their IAM policies, see the

840

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

Dan O'Meara

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

[diff] [blame]

841

#

842

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

843

#

844

# {

Bu Sun Kim

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

[diff] [blame]

845

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

846

# {

Bu Sun Kim

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

[diff] [blame]

847

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

848

# "members": [

849

# "user:mike@example.com",

850

# "group:admins@example.com",

851

# "domain:google.com",

852

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

Bu Sun Kim

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

[diff] [blame]

853

# ]

854

# },

855

# {

Bu Sun Kim

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

[diff] [blame]

856

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

Bu Sun Kim

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

[diff] [blame]

857

# "members": [

858

# "user:eve@example.com"

859

# ],

Bu Sun Kim

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

[diff] [blame]

860

# "condition": {

861

# "title": "expirable access",

862

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

863

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

Dan O'Meara

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

[diff] [blame]

864

# }

Bu Sun Kim

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

[diff] [blame]

865

# }

Dan O'Meara

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

[diff] [blame]

866

# ],

Bu Sun Kim

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

[diff] [blame]

867

# "etag": "BwWWja0YfJA=",

868

# "version": 3

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

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

876

# - group:admins@example.com

877

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

878

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

879

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

880

# - members:

Dan O'Meara

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

[diff] [blame]

881

# - user:eve@example.com

882

# role: roles/resourcemanager.organizationViewer

883

# condition:

884

# title: expirable access

885

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

886

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

Dan O'Meara

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

[diff] [blame]

887

# - etag: BwWWja0YfJA=

888

# - version: 3

Bu Sun Kim

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

[diff] [blame]

889

#

890

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

Dan O'Meara

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

[diff] [blame]

891

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

Bu Sun Kim

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

[diff] [blame]

892

"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]

893

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

894

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

895

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

Bu Sun Kim

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

[diff] [blame]

896

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

Bu Sun Kim

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

[diff] [blame]

897

#

898

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

899

# current request.

900

#

901

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

902

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

903

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

904

#

905

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

906

# [IAM

907

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

Bu Sun Kim

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

[diff] [blame]

908

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

909

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

910

#

911

# Example (Comparison):

912

#

913

# title: "Summary size limit"

914

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

915

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

916

#

917

# Example (Equality):

918

#

919

# title: "Requestor is owner"

920

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

921

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

#

# Example (Logic):

#

# title: "Public documents"

926

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

927

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

928

#

929

# Example (Data Manipulation):

930

#

931

# title: "Notification string"

932

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

933

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

934

#

935

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

936

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

937

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

938

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

939

# syntax.

940

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

941

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

942

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

943

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

Bu Sun Kim

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

[diff] [blame]

944

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

945

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

946

# expression.

Bu Sun Kim

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

[diff] [blame]

947

},

948

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

Dan O'Meara

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

[diff] [blame]

949

# `members` can have the following values:

950

#

951

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

952

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

953

#

954

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

955

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

956

#

957

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

958

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

959

#

960

#

961

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

962

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

963

#

964

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

965

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

966

#

967

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

968

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

969

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

970

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

971

# retains the role in the binding.

972

#

973

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

974

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

975

# deleted. For example,

976

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

977

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

978

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

979

# role in the binding.

980

#

981

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

982

# identifier) representing a Google group that has been recently

983

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

984

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

985

# recovered group retains the role in the binding.

986

#

987

#

988

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

989

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

990

#

Bu Sun Kim

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

[diff] [blame]

991

"A String",

Dan O'Meara

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

[diff] [blame]

992

],

Bu Sun Kim

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

[diff] [blame]

993

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

994

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

Dan O'Meara

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

[diff] [blame]

995

},

996

],

Bu Sun Kim

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

[diff] [blame]

997

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

998

{ # Specifies the audit configuration for a service.

999

# The configuration determines which permission types are logged, and what

1000

# identities, if any, are exempted from logging.

1001

# An AuditConfig must have one or more AuditLogConfigs.

1002

#

1003

# If there are AuditConfigs for both `allServices` and a specific service,

1004

# the union of the two AuditConfigs is used for that service: the log_types

1005

# specified in each AuditConfig are enabled, and the exempted_members in each

1006

# AuditLogConfig are exempted.

1007

#

1008

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

1014

# "audit_log_configs": [

1015

# {

1016

# "log_type": "DATA_READ",

1017

# "exempted_members": [

1018

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

1023

# },

1024

# {

1025

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com",

1031

# "audit_log_configs": [

1032

# {

1033

# "log_type": "DATA_READ"

1034

# },

1035

# {

1036

# "log_type": "DATA_WRITE",

1037

# "exempted_members": [

1038

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1047

# logging. It also exempts jose@example.com from DATA_READ logging, and

1048

# aliya@example.com from DATA_WRITE logging.

1049

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1050

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

1055

# {

1056

# "log_type": "DATA_READ",

1057

# "exempted_members": [

1058

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1068

# jose@example.com from DATA_READ logging.

1069

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1070

# permission.

1071

# Follows the same format of Binding.members.

1072

"A String",

1073

],

1074

"logType": "A String", # The log type that this config enables.

1075

},

1076

],

1077

"service": "A String", # Specifies a service that will be enabled for audit logging.

1078

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1079

# `allServices` is a special value that covers all services.

1080

},

1081

],

Bu Sun Kim

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

[diff] [blame]

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

#

1090

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

1091

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

1092

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

1093

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

Bu Sun Kim

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

[diff] [blame]

1094

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

1095

#

1096

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

1097

# are rejected.

1098

#

1099

# Any operation that affects conditional role bindings must specify version

1100

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

1101

#

1102

# * Getting a policy that includes a conditional role binding

1103

# * Adding a conditional role binding to a policy

1104

# * Changing a conditional role binding in a policy

1105

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

1106

# that includes conditions

1107

#

1108

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

1109

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

1110

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

1111

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

1112

#

1113

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

1114

# specify any valid version or leave the field unset.

1115

#

1116

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

1117

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

Bu Sun Kim

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

[diff] [blame]

1118

},

Bu Sun Kim

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

[diff] [blame]

1119

}

1120

1121

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1128

Dan O'Meara

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

[diff] [blame]

1129

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

1130

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

1131

#

1132

#

Dan O'Meara

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

[diff] [blame]

1133

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

1134

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

1135

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

1136

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

1137

# custom role.

Bu Sun Kim

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

[diff] [blame]

1138

#

Bu Sun Kim

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

[diff] [blame]

1139

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

1140

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

1141

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

1142

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

1143

# resources support conditions in their IAM policies, see the

1144

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

Dan O'Meara

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

[diff] [blame]

1145

#

1146

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1147

#

1148

# {

Bu Sun Kim

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

[diff] [blame]

1149

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

1150

# {

Bu Sun Kim

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

[diff] [blame]

1151

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

1152

# "members": [

1153

# "user:mike@example.com",

1154

# "group:admins@example.com",

1155

# "domain:google.com",

1156

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

Bu Sun Kim

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

[diff] [blame]

1157

# ]

1158

# },

1159

# {

Bu Sun Kim

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

[diff] [blame]

1160

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

Bu Sun Kim

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

[diff] [blame]

1161

# "members": [

1162

# "user:eve@example.com"

1163

# ],

Bu Sun Kim

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

[diff] [blame]

1164

# "condition": {

1165

# "title": "expirable access",

1166

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

1167

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

Dan O'Meara

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

[diff] [blame]

1168

# }

Bu Sun Kim

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

[diff] [blame]

1169

# }

Dan O'Meara

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

[diff] [blame]

1170

# ],

Bu Sun Kim

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

[diff] [blame]

1171

# "etag": "BwWWja0YfJA=",

1172

# "version": 3

Bu Sun Kim

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

[diff] [blame]

1173

# }

1174

#

Dan O'Meara

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

[diff] [blame]

1175

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1180

# - group:admins@example.com

1181

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1182

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

1183

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1184

# - members:

Dan O'Meara

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

[diff] [blame]

1185

# - user:eve@example.com

1186

# role: roles/resourcemanager.organizationViewer

1187

# condition:

1188

# title: expirable access

1189

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1190

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

Dan O'Meara

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

[diff] [blame]

1191

# - etag: BwWWja0YfJA=

1192

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1193

#

1194

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

Dan O'Meara

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

[diff] [blame]

1195

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

Bu Sun Kim

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

[diff] [blame]

1196

"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]

1197

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

1198

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

1199

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

Bu Sun Kim

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

[diff] [blame]

1200

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

Bu Sun Kim

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

[diff] [blame]

1201

#

1202

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

1203

# current request.

1204

#

1205

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

1206

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

1207

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

1208

#

1209

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

1210

# [IAM

1211

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

Bu Sun Kim

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

[diff] [blame]

1212

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

1213

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

1214

#

1215

# Example (Comparison):

1216

#

1217

# title: "Summary size limit"

1218

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

1219

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

1220

#

1221

# Example (Equality):

1222

#

1223

# title: "Requestor is owner"

1224

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

1225

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

#

# Example (Logic):

#

# title: "Public documents"

1230

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

1231

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

1232

#

1233

# Example (Data Manipulation):

1234

#

1235

# title: "Notification string"

1236

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

1237

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

1238

#

1239

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

1240

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

1241

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

1242

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

1243

# syntax.

1244

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

1245

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

1246

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

1247

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

Bu Sun Kim

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

[diff] [blame]

1248

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

1249

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

1250

# expression.

Bu Sun Kim

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

[diff] [blame]

1251

},

1252

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

Dan O'Meara

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

[diff] [blame]

1253

# `members` can have the following values:

1254

#

1255

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

1256

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

1257

#

1258

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

1259

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

1260

#

1261

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

1262

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

1263

#

1264

#

1265

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

1266

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

1267

#

1268

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

1269

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

1270

#

1271

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

1272

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

1273

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

1274

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

1275

# retains the role in the binding.

1276

#

1277

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

1278

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

1279

# deleted. For example,

1280

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

1281

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

1282

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

1283

# role in the binding.

1284

#

1285

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

1286

# identifier) representing a Google group that has been recently

1287

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

1288

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

1289

# recovered group retains the role in the binding.

1290

#

1291

#

1292

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

1293

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

1294

#

Bu Sun Kim

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

[diff] [blame]

1295

"A String",

Dan O'Meara

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

[diff] [blame]

1296

],

Bu Sun Kim

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

[diff] [blame]

1297

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

1298

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

Dan O'Meara

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

[diff] [blame]

1299

},

1300

],

Bu Sun Kim

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

[diff] [blame]

1301

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1302

{ # Specifies the audit configuration for a service.

1303

# The configuration determines which permission types are logged, and what

1304

# identities, if any, are exempted from logging.

1305

# An AuditConfig must have one or more AuditLogConfigs.

1306

#

1307

# If there are AuditConfigs for both `allServices` and a specific service,

1308

# the union of the two AuditConfigs is used for that service: the log_types

1309

# specified in each AuditConfig are enabled, and the exempted_members in each

1310

# AuditLogConfig are exempted.

1311

#

1312

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

1318

# "audit_log_configs": [

1319

# {

1320

# "log_type": "DATA_READ",

1321

# "exempted_members": [

1322

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

1327

# },

1328

# {

1329

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com",

1335

# "audit_log_configs": [

1336

# {

1337

# "log_type": "DATA_READ"

1338

# },

1339

# {

1340

# "log_type": "DATA_WRITE",

1341

# "exempted_members": [

1342

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1351

# logging. It also exempts jose@example.com from DATA_READ logging, and

1352

# aliya@example.com from DATA_WRITE logging.

1353

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1354

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

1359

# {

1360

# "log_type": "DATA_READ",

1361

# "exempted_members": [

1362

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1372

# jose@example.com from DATA_READ logging.

1373

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1374

# permission.

1375

# Follows the same format of Binding.members.

1376

"A String",

1377

],

1378

"logType": "A String", # The log type that this config enables.

1379

},

1380

],

1381

"service": "A String", # Specifies a service that will be enabled for audit logging.

1382

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1383

# `allServices` is a special value that covers all services.

1384

},

1385

],

Bu Sun Kim

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

[diff] [blame]

1386

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

1387

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

1388

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

1389

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

1390

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

1391

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

1392

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

1393

#

1394

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

1395

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

1396

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

1397

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

Bu Sun Kim

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

[diff] [blame]

1398

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

1399

#

1400

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

1401

# are rejected.

1402

#

1403

# Any operation that affects conditional role bindings must specify version

1404

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

1405

#

1406

# * Getting a policy that includes a conditional role binding

1407

# * Adding a conditional role binding to a policy

1408

# * Changing a conditional role binding in a policy

1409

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

1410

# that includes conditions

1411

#

1412

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

1413

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

1414

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

1415

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

1416

#

1417

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

1418

# specify any valid version or leave the field unset.

1419

#

1420

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

1421

# [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]

1426

<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]

1427

<pre>Returns permissions that the caller has on the specified instance resource.

1428

1429

Args:

1430

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

1431

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

Dan O'Meara

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

[diff] [blame]

1432

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1433

The object takes the form of:

1434

1435

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1436

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

1437

# wildcards (such as '*' or 'storage.*') are not allowed. For more

Bu Sun Kim

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

[diff] [blame]

1438

# information see

1439

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

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

[diff] [blame]

1440

"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:

1451

1452

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1453

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

Bu Sun Kim

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

[diff] [blame]

1454

# allowed.

Bu Sun Kim

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

[diff] [blame]

1455

"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]

1461

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

Bu Sun Kim

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

[diff] [blame]

1462

<pre>Updates an instance within a project. This method updates only the display

1463

name and type for an Instance. To update other Instance properties, such as

1464

labels, use PartialUpdateInstance.

1465

1466

Args:

Bu Sun Kim

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

[diff] [blame]

1467

Dan O'Meara

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

[diff] [blame]

1468

`projects/{project}/instances/a-z+[a-z0-9]`. (required)

1469

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1470

The object takes the form of:

1471

1472

{ # A collection of Bigtable Tables and

Bu Sun Kim

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

[diff] [blame]

1473

# the resources that serve them.

1474

# All tables in an instance are served from all

1475

# Clusters in the instance.

Bu Sun Kim

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

[diff] [blame]

1476

"state": "A String", # Output only. The current state of the instance.

1477

"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs.

1478

# Can be changed at any time, but should be kept globally unique

1479

# to avoid confusion.

1480

"name": "A String", # The unique name of the instance. Values are of the form

1481

# `projects/{project}/instances/a-z+[a-z0-9]`.

1482

"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.

Bu Sun Kim

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

[diff] [blame]

1483

"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud

1484

# resources into groups that reflect a customer's organizational needs and

Bu Sun Kim

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

[diff] [blame]

1485

# deployment strategies. They can be used to filter resources and aggregate

1486

# metrics.

Bu Sun Kim

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

[diff] [blame]

1487

#

Bu Sun Kim

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

[diff] [blame]

1488

# * Label keys must be between 1 and 63 characters long and must conform to

1489

# the regular expression: `\p{Ll}\p{Lo}{0,62}`.

1490

# * Label values must be between 0 and 63 characters long and must conform to

1491

# the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.

1492

# * No more than 64 labels can be associated with a given resource.

1493

# * Keys and values must both be under 128 bytes.

Bu Sun Kim

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

[diff] [blame]

1494

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1495

},

Bu Sun Kim

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

[diff] [blame]

1496

}

1497

1498

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1505

1506

{ # A collection of Bigtable Tables and

1507

# the resources that serve them.

1508

# All tables in an instance are served from all

1509

# Clusters in the instance.

Bu Sun Kim

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

[diff] [blame]

1510

"state": "A String", # Output only. The current state of the instance.

1511

"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs.

1512

# Can be changed at any time, but should be kept globally unique

1513

# to avoid confusion.

1514

"name": "A String", # The unique name of the instance. Values are of the form

1515

# `projects/{project}/instances/a-z+[a-z0-9]`.

1516

"type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`.

Bu Sun Kim

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

[diff] [blame]

1517

"labels": { # Required. Labels are a flexible and lightweight mechanism for organizing cloud

1518

# resources into groups that reflect a customer's organizational needs and

1519

# deployment strategies. They can be used to filter resources and aggregate

1520

# metrics.

1521

#

1522

# * Label keys must be between 1 and 63 characters long and must conform to

1523

# the regular expression: `\p{Ll}\p{Lo}{0,62}`.

1524

# * Label values must be between 0 and 63 characters long and must conform to

1525

# the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.

1526

# * No more than 64 labels can be associated with a given resource.

1527

# * Keys and values must both be under 128 bytes.

1528

"a_key": "A String",

1529

},

Bu Sun Kim

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

[diff] [blame]

1530

}</pre>

Bu Sun Kim