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-05-27 12:20:54 -0700

[diff] [blame^]

134

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

135

# Fields marked `OutputOnly` must be left blank.

136

# the resources that serve them.

137

# All tables in an instance are served from all

138

# Clusters in the instance.

139

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

140

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

141

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

142

# metrics.

143

#

144

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

145

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

146

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

147

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

148

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

149

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

150

"a_key": "A String",

151

},

152

"state": "A String", # (`OutputOnly`)

153

# The current state of the instance.

154

"name": "A String", # Required. (`OutputOnly`)

155

# The unique name of the instance. Values are of the form

156

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

157

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

158

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

159

# to avoid confusion.

160

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

161

},

162

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

163

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

Bu Sun Kim

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

[diff] [blame]

164

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

Bu Sun Kim

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

[diff] [blame]

165

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

166

# `projects/myproject/instances/myinstance`.

Bu Sun Kim

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

[diff] [blame]

167

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

Bu Sun Kim

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

[diff] [blame]

168

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

169

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

170

# Fields marked `OutputOnly` must be left blank.

Dan O'Meara

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

[diff] [blame]

171

# Currently, at most four clusters can be specified.

Bu Sun Kim

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

[diff] [blame]

172

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

Bu Sun Kim

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

[diff] [blame]

173

# of serving all Tables in the parent

174

# Instance.

Bu Sun Kim

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

[diff] [blame^]

175

"name": "A String", # Required. (`OutputOnly`)

176

# The unique name of the cluster. Values are of the form

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

Bu Sun Kim

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

[diff] [blame]

179

# throughput and more consistent performance.

Bu Sun Kim

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

[diff] [blame]

180

"defaultStorageType": "A String", # (`CreationOnly`)

181

# The type of storage used by this cluster to serve its

182

# parent instance's tables, unless explicitly overridden.

183

"location": "A String", # (`CreationOnly`)

184

# The location where this cluster's nodes and storage reside. For best

Bu Sun Kim

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

[diff] [blame]

185

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

186

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

Dan O'Meara

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

[diff] [blame]

187

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

Bu Sun Kim

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

[diff] [blame]

188

"state": "A String", # (`OutputOnly`)

189

# The current state of the cluster.

Bu Sun Kim

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

[diff] [blame]

190

},

191

},

Bu Sun Kim

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

[diff] [blame]

192

}

193

194

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

201

202

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

203

# network API call.

Bu Sun Kim

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

[diff] [blame]

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

212

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

Dan O'Meara

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

[diff] [blame]

213

},

Bu Sun Kim

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

[diff] [blame]

214

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

215

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

216

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

Bu Sun Kim

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

[diff] [blame]

217

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

Bu Sun Kim

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

[diff] [blame]

218

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

Dan O'Meara

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

[diff] [blame]

219

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

220

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

Bu Sun Kim

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

[diff] [blame]

221

#

Dan O'Meara

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

[diff] [blame]

222

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

223

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

Bu Sun Kim

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

[diff] [blame]

224

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

Bu Sun Kim

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

[diff] [blame]

225

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

226

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

Bu Sun Kim

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

[diff] [blame]

227

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

Bu Sun Kim

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

[diff] [blame]

228

# message types for APIs to use.

229

{

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.

Bu Sun Kim

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

[diff] [blame]

231

},

232

],

Bu Sun Kim

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

[diff] [blame^]

233

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

Bu Sun Kim

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

[diff] [blame]

234

},

Bu Sun Kim

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

[diff] [blame^]

235

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

236

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

237

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

238

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

239

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

240

},

241

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

242

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

243

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

249

<pre>Delete an instance from a project.

250

251

Args:

Dan O'Meara

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

[diff] [blame]

252

253

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

Bu Sun Kim

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

[diff] [blame]

254

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

261

262

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

263

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

264

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

265

#

266

# service Foo {

267

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

268

# }

269

#

270

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

}</pre>

</div>

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

276

<pre>Gets information about an instance.

277

278

Args:

Dan O'Meara

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

[diff] [blame]

279

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

280

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

Bu Sun Kim

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

[diff] [blame]

281

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

288

289

{ # A collection of Bigtable Tables and

Bu Sun Kim

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

[diff] [blame^]

290

# the resources that serve them.

291

# All tables in an instance are served from all

292

# Clusters in the instance.

293

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

294

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

295

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

296

# metrics.

297

#

298

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

299

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

300

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

301

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

302

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

303

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

304

"a_key": "A String",

305

},

306

"state": "A String", # (`OutputOnly`)

307

# The current state of the instance.

308

"name": "A String", # Required. (`OutputOnly`)

309

# The unique name of the instance. Values are of the form

310

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

311

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

312

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

313

# to avoid confusion.

314

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

315

}</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>

320

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

321

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

322

323

Args:

324

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

325

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

326

body: object, The request body.

327

The object takes the form of:

328

329

{ # Request message for `GetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

330

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

331

# `GetIamPolicy`. This field is only used by Cloud IAM.

Bu Sun Kim

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

[diff] [blame]

332

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

Dan O'Meara

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

[diff] [blame]

333

#

334

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

335

# rejected.

336

#

337

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

338

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

339

# leave the field unset.

340

},

Bu Sun Kim

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

[diff] [blame]

341

}

342

343

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

350

Dan O'Meara

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

[diff] [blame]

351

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

352

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

353

#

354

#

Dan O'Meara

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

[diff] [blame]

355

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

356

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

357

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

358

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

359

# custom role.

Bu Sun Kim

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

[diff] [blame]

360

#

Dan O'Meara

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

[diff] [blame]

361

# Optionally, a `binding` can specify a `condition`, which is a logical

362

# expression that allows access to a resource only if the expression evaluates

363

# to `true`. A condition can add constraints based on attributes of the

364

# request, the resource, or both.

365

#

366

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

367

#

368

# {

Bu Sun Kim

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

[diff] [blame]

369

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

370

# {

Bu Sun Kim

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

[diff] [blame]

371

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

372

# "members": [

373

# "user:mike@example.com",

374

# "group:admins@example.com",

375

# "domain:google.com",

376

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

Bu Sun Kim

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

[diff] [blame]

377

# ]

378

# },

379

# {

Bu Sun Kim

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

[diff] [blame]

380

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

381

# "members": ["user:eve@example.com"],

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

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

Dan O'Meara

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

[diff] [blame]

415

#

416

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

417

# are rejected.

418

#

419

# Any operation that affects conditional role bindings must specify version

420

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

421

#

422

# * Getting a policy that includes a conditional role binding

423

# * Adding a conditional role binding to a policy

424

# * Changing a conditional role binding in a policy

425

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

426

# that includes conditions

427

#

428

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

429

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

430

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

431

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

432

#

433

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

434

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

435

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

436

{ # Specifies the audit configuration for a service.

437

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

438

# identities, if any, are exempted from logging.

439

# An AuditConfig must have one or more AuditLogConfigs.

440

#

441

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

442

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

443

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

444

# AuditLogConfig are exempted.

445

#

446

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

452

# "audit_log_configs": [

453

# {

454

# "log_type": "DATA_READ",

455

# "exempted_members": [

456

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

461

# },

462

# {

463

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

469

# "audit_log_configs": [

470

# {

471

# "log_type": "DATA_READ",

472

# },

473

# {

474

# "log_type": "DATA_WRITE",

475

# "exempted_members": [

476

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

485

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

486

# aliya@example.com from DATA_WRITE logging.

487

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

488

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

489

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

490

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

491

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

# Example:

#

# {

# "audit_log_configs": [

496

# {

497

# "log_type": "DATA_READ",

498

# "exempted_members": [

499

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

509

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame^]

510

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

Bu Sun Kim

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

[diff] [blame]

511

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

512

# permission.

513

# Follows the same format of Binding.members.

514

"A String",

515

],

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

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

521

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

522

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

523

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

Bu Sun Kim

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

[diff] [blame]

524

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

525

# NOTE: An unsatisfied condition will not allow user access via current

526

# binding. Different bindings, including their conditions, are examined

527

# independently.

528

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

529

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

530

#

531

# Example (Comparison):

532

#

533

# title: "Summary size limit"

534

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

535

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

536

#

537

# Example (Equality):

538

#

539

# title: "Requestor is owner"

540

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

541

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

#

# Example (Logic):

#

# title: "Public documents"

546

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

547

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

548

#

549

# Example (Data Manipulation):

550

#

551

# title: "Notification string"

552

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

553

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

554

#

555

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

556

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

557

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

558

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

559

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

560

# expression.

561

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

562

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

Bu Sun Kim

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

[diff] [blame^]

563

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

564

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

565

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

566

# syntax.

Bu Sun Kim

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

[diff] [blame]

567

},

568

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

Dan O'Meara

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

[diff] [blame]

569

# `members` can have the following values:

570

#

571

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

572

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

573

#

574

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

575

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

576

#

577

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

578

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

579

#

580

#

581

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

582

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

583

#

584

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

585

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

586

#

587

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

588

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

589

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

590

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

591

# retains the role in the binding.

592

#

593

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

594

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

595

# deleted. For example,

596

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

597

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

598

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

599

# role in the binding.

600

#

601

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

602

# identifier) representing a Google group that has been recently

603

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

604

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

605

# recovered group retains the role in the binding.

606

#

607

#

608

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

609

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

610

#

Bu Sun Kim

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

[diff] [blame]

611

"A String",

Dan O'Meara

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

[diff] [blame]

612

],

Bu Sun Kim

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

[diff] [blame]

613

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

614

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

Dan O'Meara

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

[diff] [blame]

615

},

616

],

Bu Sun Kim

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

[diff] [blame^]

617

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

618

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

619

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

620

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

621

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

622

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

623

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

624

#

625

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

626

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

627

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

628

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

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>

634

<pre>Lists information about instances in a project.

635

636

Args:

Dan O'Meara

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

[diff] [blame]

637

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

638

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

Bu Sun Kim

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

[diff] [blame]

639

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

640

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

647

648

{ # Response message for BigtableInstanceAdmin.ListInstances.

Bu Sun Kim

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

[diff] [blame]

649

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

Bu Sun Kim

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

[diff] [blame]

650

# due to an outage or some other transient condition.

651

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

652

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

653

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

Dan O'Meara

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

[diff] [blame]

654

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

Bu Sun Kim

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

[diff] [blame]

655

"A String",

Bu Sun Kim

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

[diff] [blame]

656

],

Bu Sun Kim

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

[diff] [blame]

657

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

Bu Sun Kim

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

[diff] [blame^]

658

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

659

{ # A collection of Bigtable Tables and

660

# the resources that serve them.

661

# All tables in an instance are served from all

662

# Clusters in the instance.

663

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

664

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

665

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

666

# metrics.

667

#

668

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

669

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

670

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

671

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

672

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

673

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

674

"a_key": "A String",

675

},

676

"state": "A String", # (`OutputOnly`)

677

# The current state of the instance.

678

"name": "A String", # Required. (`OutputOnly`)

679

# The unique name of the instance. Values are of the form

680

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

681

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

682

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

683

# to avoid confusion.

684

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

685

},

686

],

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>

692

<pre>Retrieves the next page of results.

693

694

Args:

695

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

696

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

697

698

Returns:

Bu Sun Kim

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

[diff] [blame]

699

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]

700

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]

705

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

706

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

707

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

708

709

Args:

Dan O'Meara

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

[diff] [blame]

710

Bu Sun Kim

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

[diff] [blame]

711

The unique name of the instance. Values are of the form

Dan O'Meara

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

[diff] [blame]

712

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

713

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

714

The object takes the form of:

715

716

{ # A collection of Bigtable Tables and

Bu Sun Kim

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

[diff] [blame^]

717

# the resources that serve them.

718

# All tables in an instance are served from all

719

# Clusters in the instance.

720

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

721

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

722

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

723

# metrics.

724

#

725

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

726

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

727

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

728

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

729

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

730

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

731

"a_key": "A String",

732

},

733

"state": "A String", # (`OutputOnly`)

734

# The current state of the instance.

735

"name": "A String", # Required. (`OutputOnly`)

736

# The unique name of the instance. Values are of the form

737

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

738

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

739

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

740

# to avoid confusion.

741

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

742

}

Bu Sun Kim

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

[diff] [blame]

743

Dan O'Meara

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

[diff] [blame]

744

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

Bu Sun Kim

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

[diff] [blame]

745

Must be explicitly set.

746

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

753

754

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

755

# network API call.

Bu Sun Kim

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

[diff] [blame]

756

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

757

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

758

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

759

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

760

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

761

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

762

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

763

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

764

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

Dan O'Meara

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

[diff] [blame]

765

},

Bu Sun Kim

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

[diff] [blame]

766

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

767

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

768

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

Bu Sun Kim

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

[diff] [blame]

769

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

Bu Sun Kim

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

[diff] [blame]

770

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

Dan O'Meara

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

[diff] [blame]

771

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

772

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

Bu Sun Kim

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

[diff] [blame]

773

#

Dan O'Meara

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

[diff] [blame]

774

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

775

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

Bu Sun Kim

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

[diff] [blame]

776

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

Bu Sun Kim

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

[diff] [blame]

777

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

778

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

Bu Sun Kim

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

[diff] [blame]

779

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

Bu Sun Kim

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

[diff] [blame]

780

# message types for APIs to use.

781

{

Bu Sun Kim

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

[diff] [blame]

782

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

Bu Sun Kim

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

[diff] [blame]

783

},

784

],

Bu Sun Kim

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

[diff] [blame^]

785

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

Bu Sun Kim

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

[diff] [blame]

786

},

Bu Sun Kim

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

[diff] [blame^]

787

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

788

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

789

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

790

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

791

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

792

},

793

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

794

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

795

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

800

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

801

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

806

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

Dan O'Meara

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

[diff] [blame]

807

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

808

The object takes the form of:

809

810

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

811

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

812

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

813

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

814

# might reject them.

Dan O'Meara

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

[diff] [blame]

815

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

816

#

817

#

Dan O'Meara

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

[diff] [blame]

818

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

819

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

820

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

821

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

822

# custom role.

Bu Sun Kim

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

[diff] [blame]

823

#

Dan O'Meara

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

[diff] [blame]

824

# Optionally, a `binding` can specify a `condition`, which is a logical

825

# expression that allows access to a resource only if the expression evaluates

826

# to `true`. A condition can add constraints based on attributes of the

827

# request, the resource, or both.

828

#

829

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

830

#

831

# {

Bu Sun Kim

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

[diff] [blame]

832

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

833

# {

Bu Sun Kim

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

[diff] [blame]

834

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

835

# "members": [

836

# "user:mike@example.com",

837

# "group:admins@example.com",

838

# "domain:google.com",

839

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

Bu Sun Kim

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

[diff] [blame]

840

# ]

841

# },

842

# {

Bu Sun Kim

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

[diff] [blame]

843

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

844

# "members": ["user:eve@example.com"],

845

# "condition": {

846

# "title": "expirable access",

847

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

848

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

Dan O'Meara

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

[diff] [blame]

849

# }

Bu Sun Kim

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

[diff] [blame]

850

# }

Dan O'Meara

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

[diff] [blame]

851

# ],

Bu Sun Kim

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

[diff] [blame]

852

# "etag": "BwWWja0YfJA=",

853

# "version": 3

Bu Sun Kim

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

[diff] [blame]

854

# }

855

#

Dan O'Meara

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

[diff] [blame]

856

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

861

# - group:admins@example.com

862

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

863

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

864

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

865

# - members:

Dan O'Meara

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

[diff] [blame]

866

# - user:eve@example.com

867

# role: roles/resourcemanager.organizationViewer

868

# condition:

869

# title: expirable access

870

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

871

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

Dan O'Meara

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

[diff] [blame]

872

# - etag: BwWWja0YfJA=

873

# - version: 3

Bu Sun Kim

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

[diff] [blame]

874

#

875

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

Dan O'Meara

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

[diff] [blame]

876

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

Bu Sun Kim

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

[diff] [blame]

877

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

Dan O'Meara

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

[diff] [blame]

878

#

879

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

880

# are rejected.

881

#

882

# Any operation that affects conditional role bindings must specify version

883

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

884

#

885

# * Getting a policy that includes a conditional role binding

886

# * Adding a conditional role binding to a policy

887

# * Changing a conditional role binding in a policy

888

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

889

# that includes conditions

890

#

891

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

892

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

893

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

894

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

895

#

896

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

897

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

898

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

899

{ # Specifies the audit configuration for a service.

900

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

901

# identities, if any, are exempted from logging.

902

# An AuditConfig must have one or more AuditLogConfigs.

903

#

904

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

905

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

906

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

907

# AuditLogConfig are exempted.

908

#

909

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

915

# "audit_log_configs": [

916

# {

917

# "log_type": "DATA_READ",

918

# "exempted_members": [

919

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

924

# },

925

# {

926

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

932

# "audit_log_configs": [

933

# {

934

# "log_type": "DATA_READ",

935

# },

936

# {

937

# "log_type": "DATA_WRITE",

938

# "exempted_members": [

939

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

948

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

949

# aliya@example.com from DATA_WRITE logging.

950

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

951

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

952

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

953

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

954

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

# Example:

#

# {

# "audit_log_configs": [

959

# {

960

# "log_type": "DATA_READ",

961

# "exempted_members": [

962

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

972

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame^]

973

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

Bu Sun Kim

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

[diff] [blame]

974

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

975

# permission.

976

# Follows the same format of Binding.members.

977

"A String",

978

],

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

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

984

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

985

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

986

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

Bu Sun Kim

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

[diff] [blame]

987

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

988

# NOTE: An unsatisfied condition will not allow user access via current

989

# binding. Different bindings, including their conditions, are examined

990

# independently.

991

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

992

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

993

#

994

# Example (Comparison):

995

#

996

# title: "Summary size limit"

997

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

998

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

999

#

1000

# Example (Equality):

1001

#

1002

# title: "Requestor is owner"

1003

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

1004

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

#

# Example (Logic):

#

# title: "Public documents"

1009

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

1010

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

1011

#

1012

# Example (Data Manipulation):

1013

#

1014

# title: "Notification string"

1015

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

1016

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

1017

#

1018

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

1019

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

1020

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

1021

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

1022

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

1023

# expression.

1024

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

1025

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

Bu Sun Kim

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

[diff] [blame^]

1026

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

1027

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

1028

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

1029

# syntax.

Bu Sun Kim

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

[diff] [blame]

1030

},

1031

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

Dan O'Meara

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

[diff] [blame]

1032

# `members` can have the following values:

1033

#

1034

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

1035

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

1036

#

1037

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

1038

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

1039

#

1040

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

1041

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

1042

#

1043

#

1044

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

1045

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

1046

#

1047

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

1048

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

1049

#

1050

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

1051

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

1052

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

1053

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

1054

# retains the role in the binding.

1055

#

1056

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

1057

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

1058

# deleted. For example,

1059

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

1060

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

1061

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

1062

# role in the binding.

1063

#

1064

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

1065

# identifier) representing a Google group that has been recently

1066

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

1067

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

1068

# recovered group retains the role in the binding.

1069

#

1070

#

1071

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

1072

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

1073

#

Bu Sun Kim

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

[diff] [blame]

1074

"A String",

Dan O'Meara

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

[diff] [blame]

1075

],

Bu Sun Kim

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

[diff] [blame]

1076

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

1077

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

Dan O'Meara

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

[diff] [blame]

1078

},

1079

],

Bu Sun Kim

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

[diff] [blame^]

1080

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

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

1087

#

1088

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

1089

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

1090

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

1091

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

Bu Sun Kim

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

[diff] [blame]

1092

},

Bu Sun Kim

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

[diff] [blame]

1093

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

Bu Sun Kim

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

[diff] [blame]

1094

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

1095

# following default mask is used:

Bu Sun Kim

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

[diff] [blame]

1096

# paths: "bindings, etag"

Bu Sun Kim

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

[diff] [blame]

1097

# This field is only used by Cloud IAM.

1098

}

1099

1100

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1107

Dan O'Meara

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

[diff] [blame]

1108

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

1109

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

1110

#

1111

#

Dan O'Meara

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

[diff] [blame]

1112

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

1113

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

1114

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

1115

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

1116

# custom role.

Bu Sun Kim

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

[diff] [blame]

1117

#

Dan O'Meara

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

[diff] [blame]

1118

# Optionally, a `binding` can specify a `condition`, which is a logical

1119

# expression that allows access to a resource only if the expression evaluates

1120

# to `true`. A condition can add constraints based on attributes of the

1121

# request, the resource, or both.

1122

#

1123

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1124

#

1125

# {

Bu Sun Kim

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

[diff] [blame]

1126

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

1127

# {

Bu Sun Kim

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

[diff] [blame]

1128

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

1129

# "members": [

1130

# "user:mike@example.com",

1131

# "group:admins@example.com",

1132

# "domain:google.com",

1133

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

Bu Sun Kim

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

[diff] [blame]

1134

# ]

1135

# },

1136

# {

Bu Sun Kim

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

[diff] [blame]

1137

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

1138

# "members": ["user:eve@example.com"],

1139

# "condition": {

1140

# "title": "expirable access",

1141

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

1142

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

Dan O'Meara

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

[diff] [blame]

1143

# }

Bu Sun Kim

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

[diff] [blame]

1144

# }

Dan O'Meara

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

[diff] [blame]

1145

# ],

Bu Sun Kim

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

[diff] [blame]

1146

# "etag": "BwWWja0YfJA=",

1147

# "version": 3

Bu Sun Kim

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

[diff] [blame]

1148

# }

1149

#

Dan O'Meara

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

[diff] [blame]

1150

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1155

# - group:admins@example.com

1156

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1157

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

1158

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1159

# - members:

Dan O'Meara

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

[diff] [blame]

1160

# - user:eve@example.com

1161

# role: roles/resourcemanager.organizationViewer

1162

# condition:

1163

# title: expirable access

1164

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1165

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

Dan O'Meara

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

[diff] [blame]

1166

# - etag: BwWWja0YfJA=

1167

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1168

#

1169

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

Dan O'Meara

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

[diff] [blame]

1170

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

Bu Sun Kim

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

[diff] [blame]

1171

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

Dan O'Meara

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

[diff] [blame]

1172

#

1173

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

1174

# are rejected.

1175

#

1176

# Any operation that affects conditional role bindings must specify version

1177

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

1178

#

1179

# * Getting a policy that includes a conditional role binding

1180

# * Adding a conditional role binding to a policy

1181

# * Changing a conditional role binding in a policy

1182

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

1183

# that includes conditions

1184

#

1185

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

1186

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

1187

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

1188

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

1189

#

1190

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

1191

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

1192

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

1193

{ # Specifies the audit configuration for a service.

1194

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

1195

# identities, if any, are exempted from logging.

1196

# An AuditConfig must have one or more AuditLogConfigs.

1197

#

1198

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

1199

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

1200

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

1201

# AuditLogConfig are exempted.

1202

#

1203

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1209

# "audit_log_configs": [

1210

# {

1211

# "log_type": "DATA_READ",

1212

# "exempted_members": [

1213

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1218

# },

1219

# {

1220

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

1226

# "audit_log_configs": [

1227

# {

1228

# "log_type": "DATA_READ",

1229

# },

1230

# {

1231

# "log_type": "DATA_WRITE",

1232

# "exempted_members": [

1233

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

1242

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

1243

# aliya@example.com from DATA_WRITE logging.

1244

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

1245

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

1246

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

1247

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

1248

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

# Example:

#

# {

# "audit_log_configs": [

1253

# {

1254

# "log_type": "DATA_READ",

1255

# "exempted_members": [

1256

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

1266

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame^]

1267

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

Bu Sun Kim

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

[diff] [blame]

1268

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

1269

# permission.

1270

# Follows the same format of Binding.members.

1271

"A String",

1272

],

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

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

1278

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

1279

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

1280

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

Bu Sun Kim

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

[diff] [blame]

1281

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

1282

# NOTE: An unsatisfied condition will not allow user access via current

1283

# binding. Different bindings, including their conditions, are examined

1284

# independently.

1285

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

1286

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

1287

#

1288

# Example (Comparison):

1289

#

1290

# title: "Summary size limit"

1291

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

1292

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

1293

#

1294

# Example (Equality):

1295

#

1296

# title: "Requestor is owner"

1297

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

1298

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

#

# Example (Logic):

#

# title: "Public documents"

1303

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

1304

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

1305

#

1306

# Example (Data Manipulation):

1307

#

1308

# title: "Notification string"

1309

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

1310

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

1311

#

1312

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

1313

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

1314

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

1315

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

1316

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

1317

# expression.

1318

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

1319

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

Bu Sun Kim

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

[diff] [blame^]

1320

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

1321

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

1322

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

1323

# syntax.

Bu Sun Kim

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

[diff] [blame]

1324

},

1325

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

Dan O'Meara

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

[diff] [blame]

1326

# `members` can have the following values:

1327

#

1328

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

1329

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

1330

#

1331

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

1332

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

1333

#

1334

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

1335

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

1336

#

1337

#

1338

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

1339

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

1340

#

1341

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

1342

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

1343

#

1344

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

1345

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

1346

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

1347

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

1348

# retains the role in the binding.

1349

#

1350

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

1351

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

1352

# deleted. For example,

1353

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

1354

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

1355

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

1356

# role in the binding.

1357

#

1358

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

1359

# identifier) representing a Google group that has been recently

1360

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

1361

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

1362

# recovered group retains the role in the binding.

1363

#

1364

#

1365

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

1366

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

1367

#

Bu Sun Kim

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

[diff] [blame]

1368

"A String",

Dan O'Meara

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

[diff] [blame]

1369

],

Bu Sun Kim

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

[diff] [blame]

1370

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

1371

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

Dan O'Meara

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

[diff] [blame]

1372

},

1373

],

Bu Sun Kim

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

[diff] [blame^]

1374

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

1375

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

1376

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

1377

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

1378

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

1379

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

1380

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

1381

#

1382

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

1383

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

1384

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

1385

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

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]

1390

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

1391

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

1392

1393

Args:

1394

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

1395

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

Dan O'Meara

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

[diff] [blame]

1396

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1397

The object takes the form of:

1398

1399

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1400

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

1401

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

Bu Sun Kim

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

[diff] [blame]

1402

# information see

1403

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

Bu Sun Kim

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

[diff] [blame]

1404

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

1415

1416

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1417

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

Bu Sun Kim

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

[diff] [blame]

1418

# allowed.

Bu Sun Kim

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

[diff] [blame]

1419

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

1425

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

1426

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

1427

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

1428

labels, use PartialUpdateInstance.

1429

1430

Args:

Dan O'Meara

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

[diff] [blame]

1431

Bu Sun Kim

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

[diff] [blame]

1432

The unique name of the instance. Values are of the form

Dan O'Meara

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

[diff] [blame]

1433

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

1434

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1435

The object takes the form of:

1436

1437

{ # A collection of Bigtable Tables and

Bu Sun Kim

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

[diff] [blame]

1438

# the resources that serve them.

1439

# All tables in an instance are served from all

1440

# Clusters in the instance.

Bu Sun Kim

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

[diff] [blame]

1441

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

1442

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

Bu Sun Kim

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

[diff] [blame]

1443

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

1444

# metrics.

Bu Sun Kim

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

[diff] [blame^]

1445

#

Bu Sun Kim

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

[diff] [blame]

1446

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

1447

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

1448

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

1449

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

1450

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

1451

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

Bu Sun Kim

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

[diff] [blame]

1452

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1453

},

Bu Sun Kim

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

[diff] [blame]

1454

"state": "A String", # (`OutputOnly`)

1455

# The current state of the instance.

1456

"name": "A String", # Required. (`OutputOnly`)

Bu Sun Kim

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

[diff] [blame]

1457

# The unique name of the instance. Values are of the form

Dan O'Meara

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

[diff] [blame]

1458

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

Bu Sun Kim

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

[diff] [blame]

1459

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

1460

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

1461

# to avoid confusion.

Bu Sun Kim

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

[diff] [blame^]

1462

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

1463

}

1464

1465

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1472

1473

{ # A collection of Bigtable Tables and

1474

# the resources that serve them.

1475

# All tables in an instance are served from all

1476

# Clusters in the instance.

1477

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

1478

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

1479

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

1480

# metrics.

1481

#

1482

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

1483

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

1484

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

1485

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

1486

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

1487

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

1488

"a_key": "A String",

1489

},

1490

"state": "A String", # (`OutputOnly`)

1491

# The current state of the instance.

1492

"name": "A String", # Required. (`OutputOnly`)

1493

# The unique name of the instance. Values are of the form

1494

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

1495

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

1496

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

1497

# to avoid confusion.

1498

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

1499

}</pre>

Bu Sun Kim