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

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

<p class="firstline">Checks replication consistency based on a consistency token, that is, if</p>

80

Dan O'Meara

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

[diff] [blame]

81

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

82

<p class="firstline">Creates a new table in the specified instance.</p>

83

84

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

85

<p class="firstline">Permanently deletes a specified table and all of its data.</p>

86

Dan O'Meara

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Permanently drop/delete a row range from a specified table. The request can</p>

89

90

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

91

<p class="firstline">Generates a consistency token for a Table, which can be used in</p>

92

Bu Sun Kim

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Gets metadata information about the specified table.</p>

95

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

Bu Sun Kim

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

[diff] [blame]

98

Bu Sun Kim

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Lists all tables served from a specified instance.</p>

101

102

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

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

<p class="firstline">Performs a series of column family modifications on the specified table.</p>

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

<p class="firstline">Sets the access control policy on a Table resource.</p>

Bu Sun Kim

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

[diff] [blame]

110

Dan O'Meara

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

[diff] [blame]

111

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

112

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

113

<h3>Method Details</h3>

114

Dan O'Meara

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

[diff] [blame]

115

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

Bu Sun Kim

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

[diff] [blame]

116

<pre>Checks replication consistency based on a consistency token, that is, if

117

replication has caught up based on the conditions specified in the token

118

and the check request.

119

120

Args:

Dan O'Meara

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

[diff] [blame]

121

name: string, Required. The unique name of the Table for which to check replication consistency.

Bu Sun Kim

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

[diff] [blame]

122

Values are of the form

Dan O'Meara

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

[diff] [blame]

123

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

124

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

125

The object takes the form of:

126

127

{ # Request message for

128

# google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

Bu Sun Kim

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

[diff] [blame]

129

"consistencyToken": "A String", # Required. The token created using GenerateConsistencyToken for the Table.

Bu Sun Kim

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

[diff] [blame]

130

}

131

132

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

139

140

{ # Response message for

141

# google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

Bu Sun Kim

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

[diff] [blame]

142

"consistent": True or False, # True only if the token is consistent. A token is consistent if replication

Bu Sun Kim

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

[diff] [blame]

143

# has caught up with the restrictions specified in the request.

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

148

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

149

<pre>Creates a new table in the specified instance.

150

The table can be created with a full set of initial column families,

151

specified in the request.

152

153

Args:

Dan O'Meara

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

[diff] [blame]

154

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

155

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

156

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

157

The object takes the form of:

158

159

{ # Request message for

160

# google.bigtable.admin.v2.BigtableTableAdmin.CreateTable

Bu Sun Kim

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

[diff] [blame]

161

"table": { # A collection of user data indexed by row, column, and timestamp. # Required. The Table to create.

162

# Each table is served using the resources of its parent cluster.

163

"name": "A String", # Output only. The unique name of the table. Values are of the form

164

# `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.

165

# Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`

166

"clusterStates": { # Output only. Map from cluster ID to per-cluster table state.

167

# If it could not be determined whether or not the table has data in a

168

# particular cluster (for example, if its zone is unavailable), then

169

# there will be an entry for the cluster with UNKNOWN `replication_status`.

170

# Views: `REPLICATION_VIEW`, `FULL`

171

"a_key": { # The state of a table's data in a particular cluster.

172

"replicationState": "A String", # Output only. The state of replication for the table in this cluster.

173

},

174

},

175

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

176

# The granularity (i.e. `MILLIS`) at which timestamps are stored in

177

# this table. Timestamps not matching the granularity will be rejected.

178

# If unspecified at creation time, the value will be set to `MILLIS`.

179

# Views: `SCHEMA_VIEW`, `FULL`.

180

"columnFamilies": { # (`CreationOnly`)

181

# The column families configured for this table, mapped by column family ID.

182

# Views: `SCHEMA_VIEW`, `FULL`

183

"a_key": { # A set of columns within a table which share a common configuration.

184

"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.

185

# Must serialize to at most 500 bytes.

186

#

187

# NOTE: Garbage collection executes opportunistically in the background, and

188

# so it's possible for reads to return a cell even if it matches the active

189

# GC expression for its family.

Bu Sun Kim

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

[diff] [blame]

190

"maxNumVersions": 42, # Delete all cells in a column except the most recent N.

191

"maxAge": "A String", # Delete cells in a column older than the given age.

192

# Values must be at least one millisecond, and will be truncated to

193

# microsecond granularity.

Bu Sun Kim

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

[diff] [blame]

194

"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.

195

"rules": [ # Only delete cells which would be deleted by every element of `rules`.

196

# Object with schema name: GcRule

197

],

198

},

199

"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.

200

"rules": [ # Delete cells which would be deleted by any element of `rules`.

201

# Object with schema name: GcRule

202

],

203

},

Bu Sun Kim

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

[diff] [blame]

},

},

},

},

Bu Sun Kim

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

[diff] [blame]

208

"tableId": "A String", # Required. The name by which the new table should be referred to within the parent

209

# instance, e.g., `foobar` rather than `{parent}/tables/foobar`.

210

# Maximum 50 characters.

211

"initialSplits": [ # The optional list of row keys that will be used to initially split the

212

# table into several tablets (tablets are similar to HBase regions).

213

# Given two split keys, `s1` and `s2`, three tablets will be created,

214

# spanning the key ranges: `[, s1), [s1, s2), [s2, )`.

#

# Example:

#

# * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",`

219

# `"other", "zz"]`

220

# * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]`

221

# * Key assignment:

222

# - Tablet 1 `[, apple) => {"a"}.`

223

# - Tablet 2 `[apple, customer_1) => {"apple", "custom"}.`

224

# - Tablet 3 `[customer_1, customer_2) => {"customer_1"}.`

225

# - Tablet 4 `[customer_2, other) => {"customer_2"}.`

226

# - Tablet 5 `[other, ) => {"other", "zz"}.`

227

{ # An initial split point for a newly created table.

228

"key": "A String", # Row key to use as an initial tablet boundary.

229

},

230

],

Bu Sun Kim

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

[diff] [blame]

231

}

232

233

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

240

241

{ # A collection of user data indexed by row, column, and timestamp.

242

# Each table is served using the resources of its parent cluster.

Bu Sun Kim

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

[diff] [blame]

243

"name": "A String", # Output only. The unique name of the table. Values are of the form

244

# `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.

245

# Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`

246

"clusterStates": { # Output only. Map from cluster ID to per-cluster table state.

Bu Sun Kim

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

[diff] [blame]

247

# If it could not be determined whether or not the table has data in a

248

# particular cluster (for example, if its zone is unavailable), then

249

# there will be an entry for the cluster with UNKNOWN `replication_status`.

250

# Views: `REPLICATION_VIEW`, `FULL`

Bu Sun Kim

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

[diff] [blame]

251

"a_key": { # The state of a table's data in a particular cluster.

252

"replicationState": "A String", # Output only. The state of replication for the table in this cluster.

Bu Sun Kim

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

[diff] [blame]

253

},

254

},

Bu Sun Kim

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

[diff] [blame]

255

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

Bu Sun Kim

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

[diff] [blame]

256

# The granularity (i.e. `MILLIS`) at which timestamps are stored in

257

# this table. Timestamps not matching the granularity will be rejected.

258

# If unspecified at creation time, the value will be set to `MILLIS`.

259

# Views: `SCHEMA_VIEW`, `FULL`.

Bu Sun Kim

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

[diff] [blame]

260

"columnFamilies": { # (`CreationOnly`)

261

# The column families configured for this table, mapped by column family ID.

262

# Views: `SCHEMA_VIEW`, `FULL`

263

"a_key": { # A set of columns within a table which share a common configuration.

264

"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.

265

# Must serialize to at most 500 bytes.

266

#

267

# NOTE: Garbage collection executes opportunistically in the background, and

268

# so it's possible for reads to return a cell even if it matches the active

269

# GC expression for its family.

Bu Sun Kim

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

[diff] [blame]

270

"maxNumVersions": 42, # Delete all cells in a column except the most recent N.

271

"maxAge": "A String", # Delete cells in a column older than the given age.

272

# Values must be at least one millisecond, and will be truncated to

273

# microsecond granularity.

Bu Sun Kim

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

[diff] [blame]

274

"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.

275

"rules": [ # Only delete cells which would be deleted by every element of `rules`.

276

# Object with schema name: GcRule

277

],

278

},

279

"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.

280

"rules": [ # Delete cells which would be deleted by any element of `rules`.

281

# Object with schema name: GcRule

282

],

283

},

Bu Sun Kim

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

[diff] [blame]

284

},

285

},

286

},

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>

292

<pre>Permanently deletes a specified table and all of its data.

293

294

Args:

Dan O'Meara

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

[diff] [blame]

295

name: string, Required. The unique name of the table to be deleted.

Bu Sun Kim

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

[diff] [blame]

296

Values are of the form

Dan O'Meara

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

[diff] [blame]

297

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

Bu Sun Kim

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

[diff] [blame]

298

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

305

306

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

307

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

308

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

309

#

310

# service Foo {

311

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

312

# }

313

#

314

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

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

319

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

Bu Sun Kim

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

[diff] [blame]

320

<pre>Permanently drop/delete a row range from a specified table. The request can

321

specify whether to delete all rows in a table, or only those that match a

322

particular prefix.

323

324

Args:

Dan O'Meara

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

[diff] [blame]

325

name: string, Required. The unique name of the table on which to drop a range of rows.

Bu Sun Kim

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

[diff] [blame]

326

Values are of the form

Dan O'Meara

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

[diff] [blame]

327

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

328

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

329

The object takes the form of:

330

331

{ # Request message for

332

# google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange

Bu Sun Kim

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

[diff] [blame]

333

"rowKeyPrefix": "A String", # Delete all rows that start with this row key prefix. Prefix cannot be

Bu Sun Kim

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

[diff] [blame]

334

# zero length.

Bu Sun Kim

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

[diff] [blame]

335

"deleteAllDataFromTable": True or False, # Delete all rows in the table. Setting this to false is a no-op.

Bu Sun Kim

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

[diff] [blame]

336

}

337

338

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

345

346

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

347

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

348

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

349

#

350

# service Foo {

351

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

352

# }

353

#

354

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

}</pre>

</div>

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

360

<pre>Generates a consistency token for a Table, which can be used in

361

CheckConsistency to check whether mutations to the table that finished

362

before this call started have been replicated. The tokens will be available

363

for 90 days.

364

365

Args:

Dan O'Meara

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

[diff] [blame]

366

name: string, Required. The unique name of the Table for which to create a consistency token.

Bu Sun Kim

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

[diff] [blame]

367

Values are of the form

Dan O'Meara

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

[diff] [blame]

368

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

Bu Sun Kim

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

[diff] [blame]

369

body: object, The request body.

370

The object takes the form of:

371

372

{ # Request message for

373

# google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken

374

}

375

376

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

383

384

{ # Response message for

385

# google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken

Bu Sun Kim

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

[diff] [blame]

386

"consistencyToken": "A String", # The generated consistency token.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

391

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

Bu Sun Kim

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

[diff] [blame]

392

<pre>Gets metadata information about the specified table.

393

394

Args:

Dan O'Meara

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

[diff] [blame]

395

name: string, Required. The unique name of the requested table.

Bu Sun Kim

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

[diff] [blame]

396

Values are of the form

Dan O'Meara

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

[diff] [blame]

397

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

Bu Sun Kim

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

[diff] [blame]

398

view: string, The view to be applied to the returned table's fields.

399

Defaults to `SCHEMA_VIEW` if unspecified.

Bu Sun Kim

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

[diff] [blame]

400

x__xgafv: string, V1 error format.

401

Allowed values

402

1 - v1 error format

403

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

404

405

Returns:

406

An object of the form:

407

408

{ # A collection of user data indexed by row, column, and timestamp.

409

# Each table is served using the resources of its parent cluster.

Bu Sun Kim

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

[diff] [blame]

410

"name": "A String", # Output only. The unique name of the table. Values are of the form

411

# `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.

412

# Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`

413

"clusterStates": { # Output only. Map from cluster ID to per-cluster table state.

Bu Sun Kim

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

[diff] [blame]

414

# If it could not be determined whether or not the table has data in a

415

# particular cluster (for example, if its zone is unavailable), then

416

# there will be an entry for the cluster with UNKNOWN `replication_status`.

417

# Views: `REPLICATION_VIEW`, `FULL`

Bu Sun Kim

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

[diff] [blame]

418

"a_key": { # The state of a table's data in a particular cluster.

419

"replicationState": "A String", # Output only. The state of replication for the table in this cluster.

Bu Sun Kim

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

[diff] [blame]

420

},

421

},

Bu Sun Kim

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

[diff] [blame]

422

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

Bu Sun Kim

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

[diff] [blame]

423

# The granularity (i.e. `MILLIS`) at which timestamps are stored in

424

# this table. Timestamps not matching the granularity will be rejected.

425

# If unspecified at creation time, the value will be set to `MILLIS`.

426

# Views: `SCHEMA_VIEW`, `FULL`.

Bu Sun Kim

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

[diff] [blame]

427

"columnFamilies": { # (`CreationOnly`)

428

# The column families configured for this table, mapped by column family ID.

429

# Views: `SCHEMA_VIEW`, `FULL`

430

"a_key": { # A set of columns within a table which share a common configuration.

431

"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.

432

# Must serialize to at most 500 bytes.

433

#

434

# NOTE: Garbage collection executes opportunistically in the background, and

435

# so it's possible for reads to return a cell even if it matches the active

436

# GC expression for its family.

Bu Sun Kim

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

[diff] [blame]

437

"maxNumVersions": 42, # Delete all cells in a column except the most recent N.

438

"maxAge": "A String", # Delete cells in a column older than the given age.

439

# Values must be at least one millisecond, and will be truncated to

440

# microsecond granularity.

Bu Sun Kim

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

[diff] [blame]

441

"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.

442

"rules": [ # Only delete cells which would be deleted by every element of `rules`.

443

# Object with schema name: GcRule

444

],

445

},

446

"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.

447

"rules": [ # Delete cells which would be deleted by any element of `rules`.

448

# Object with schema name: GcRule

449

],

450

},

Bu Sun Kim

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

[diff] [blame]

451

},

452

},

453

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

459

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

Dan O'Meara

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

[diff] [blame]

460

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

461

set.

Bu Sun Kim

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

[diff] [blame]

462

463

Args:

464

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

465

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

466

body: object, The request body.

467

The object takes the form of:

468

469

{ # Request message for `GetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

470

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

471

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

Bu Sun Kim

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

[diff] [blame]

472

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

Dan O'Meara

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

[diff] [blame]

473

#

474

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

475

# rejected.

476

#

477

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

478

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

479

# leave the field unset.

480

},

Bu Sun Kim

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

[diff] [blame]

481

}

482

483

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

490

Dan O'Meara

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

[diff] [blame]

491

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

492

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

493

#

494

#

Dan O'Meara

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

[diff] [blame]

495

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

496

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

497

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

498

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

499

# custom role.

Bu Sun Kim

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

[diff] [blame]

500

#

Dan O'Meara

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

[diff] [blame]

501

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

502

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

503

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

504

# request, the resource, or both.

505

#

506

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

507

#

508

# {

Bu Sun Kim

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

[diff] [blame]

509

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

510

# {

Bu Sun Kim

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

[diff] [blame]

511

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

512

# "members": [

513

# "user:mike@example.com",

514

# "group:admins@example.com",

515

# "domain:google.com",

516

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

Bu Sun Kim

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

[diff] [blame]

517

# ]

518

# },

519

# {

Bu Sun Kim

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

[diff] [blame]

520

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

521

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

522

# "condition": {

523

# "title": "expirable access",

524

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

525

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

Dan O'Meara

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

[diff] [blame]

526

# }

Bu Sun Kim

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

[diff] [blame]

527

# }

Dan O'Meara

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

[diff] [blame]

528

# ],

Bu Sun Kim

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

[diff] [blame]

529

# "etag": "BwWWja0YfJA=",

530

# "version": 3

Bu Sun Kim

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

[diff] [blame]

531

# }

532

#

Dan O'Meara

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

[diff] [blame]

533

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

538

# - group:admins@example.com

539

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

540

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

541

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

542

# - members:

Dan O'Meara

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

[diff] [blame]

543

# - user:eve@example.com

544

# role: roles/resourcemanager.organizationViewer

545

# condition:

546

# title: expirable access

547

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

548

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

Dan O'Meara

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

[diff] [blame]

549

# - etag: BwWWja0YfJA=

550

# - version: 3

Bu Sun Kim

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

[diff] [blame]

551

#

552

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

Dan O'Meara

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

[diff] [blame]

553

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

Bu Sun Kim

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

[diff] [blame]

554

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

Dan O'Meara

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

[diff] [blame]

555

#

556

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

557

# are rejected.

558

#

559

# Any operation that affects conditional role bindings must specify version

560

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

561

#

562

# * Getting a policy that includes a conditional role binding

563

# * Adding a conditional role binding to a policy

564

# * Changing a conditional role binding in a policy

565

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

566

# that includes conditions

567

#

568

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

569

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

570

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

571

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

572

#

573

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

574

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

575

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

576

{ # Specifies the audit configuration for a service.

577

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

578

# identities, if any, are exempted from logging.

579

# An AuditConfig must have one or more AuditLogConfigs.

580

#

581

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

582

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

583

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

584

# AuditLogConfig are exempted.

585

#

586

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

592

# "audit_log_configs": [

593

# {

594

# "log_type": "DATA_READ",

595

# "exempted_members": [

596

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

601

# },

602

# {

603

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

609

# "audit_log_configs": [

610

# {

611

# "log_type": "DATA_READ",

612

# },

613

# {

614

# "log_type": "DATA_WRITE",

615

# "exempted_members": [

616

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

625

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

626

# aliya@example.com from DATA_WRITE logging.

627

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

628

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

629

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

630

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

631

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

# Example:

#

# {

# "audit_log_configs": [

636

# {

637

# "log_type": "DATA_READ",

638

# "exempted_members": [

639

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

649

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame]

650

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

Bu Sun Kim

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

[diff] [blame]

651

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

652

# permission.

653

# Follows the same format of Binding.members.

654

"A String",

655

],

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]

661

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

662

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

663

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

Bu Sun Kim

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

[diff] [blame]

664

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

665

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

666

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

667

# independently.

668

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

669

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

670

#

671

# Example (Comparison):

672

#

673

# title: "Summary size limit"

674

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

675

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

676

#

677

# Example (Equality):

678

#

679

# title: "Requestor is owner"

680

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

681

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

#

# Example (Logic):

#

# title: "Public documents"

686

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

687

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

688

#

689

# Example (Data Manipulation):

690

#

691

# title: "Notification string"

692

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

693

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

694

#

695

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

696

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

697

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

698

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

699

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

700

# expression.

701

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

702

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

Bu Sun Kim

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

[diff] [blame]

703

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

704

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

705

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

706

# syntax.

Bu Sun Kim

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

[diff] [blame]

707

},

708

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

Dan O'Meara

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

[diff] [blame]

709

# `members` can have the following values:

710

#

711

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

712

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

713

#

714

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

715

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

716

#

717

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

718

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

719

#

720

#

721

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

722

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

723

#

724

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

725

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

726

#

727

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

728

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

729

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

730

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

731

# retains the role in the binding.

732

#

733

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

734

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

735

# deleted. For example,

736

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

737

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

738

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

739

# role in the binding.

740

#

741

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

742

# identifier) representing a Google group that has been recently

743

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

744

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

745

# recovered group retains the role in the binding.

746

#

747

#

748

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

749

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

750

#

Bu Sun Kim

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

[diff] [blame]

751

"A String",

Dan O'Meara

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

[diff] [blame]

752

],

Bu Sun Kim

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

[diff] [blame]

753

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

754

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

Dan O'Meara

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

[diff] [blame]

755

},

756

],

Bu Sun Kim

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

[diff] [blame]

757

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

758

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

759

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

760

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

761

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

762

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

763

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

764

#

765

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

766

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

767

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

768

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

773

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

Bu Sun Kim

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

[diff] [blame]

774

<pre>Lists all tables served from a specified instance.

775

776

Args:

Dan O'Meara

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

[diff] [blame]

777

parent: string, Required. The unique name of the instance for which tables should be listed.

778

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

Bu Sun Kim

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

[diff] [blame]

779

pageToken: string, The value of `next_page_token` returned by a previous call.

Bu Sun Kim

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

[diff] [blame]

780

pageSize: integer, Maximum number of results per page.

781

782

A page_size of zero lets the server choose the number of items to return.

783

A page_size which is strictly positive will return at most that many items.

784

A negative page_size will cause an error.

785

786

Following the first request, subsequent paginated calls are not required

787

to pass a page_size. If a page_size is set in subsequent calls, it must

788

match the page_size given in the first request.

Bu Sun Kim

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

[diff] [blame]

789

view: string, The view to be applied to the returned tables' fields.

Dan O'Meara

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

[diff] [blame]

790

Only NAME_ONLY view (default) and REPLICATION_VIEW are supported.

Bu Sun Kim

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

[diff] [blame]

791

x__xgafv: string, V1 error format.

792

Allowed values

793

1 - v1 error format

794

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

795

796

Returns:

797

An object of the form:

798

799

{ # Response message for

800

# google.bigtable.admin.v2.BigtableTableAdmin.ListTables

Bu Sun Kim

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

[diff] [blame]

801

"tables": [ # The tables present in the requested instance.

Bu Sun Kim

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

[diff] [blame]

802

{ # A collection of user data indexed by row, column, and timestamp.

803

# Each table is served using the resources of its parent cluster.

Bu Sun Kim

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

[diff] [blame]

804

"name": "A String", # Output only. The unique name of the table. Values are of the form

805

# `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.

806

# Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`

807

"clusterStates": { # Output only. Map from cluster ID to per-cluster table state.

Bu Sun Kim

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

[diff] [blame]

808

# If it could not be determined whether or not the table has data in a

809

# particular cluster (for example, if its zone is unavailable), then

810

# there will be an entry for the cluster with UNKNOWN `replication_status`.

811

# Views: `REPLICATION_VIEW`, `FULL`

Bu Sun Kim

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

[diff] [blame]

812

"a_key": { # The state of a table's data in a particular cluster.

813

"replicationState": "A String", # Output only. The state of replication for the table in this cluster.

Bu Sun Kim

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

[diff] [blame]

814

},

815

},

Bu Sun Kim

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

[diff] [blame]

816

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

Bu Sun Kim

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

[diff] [blame]

817

# The granularity (i.e. `MILLIS`) at which timestamps are stored in

818

# this table. Timestamps not matching the granularity will be rejected.

819

# If unspecified at creation time, the value will be set to `MILLIS`.

820

# Views: `SCHEMA_VIEW`, `FULL`.

Bu Sun Kim

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

[diff] [blame]

821

"columnFamilies": { # (`CreationOnly`)

822

# The column families configured for this table, mapped by column family ID.

823

# Views: `SCHEMA_VIEW`, `FULL`

824

"a_key": { # A set of columns within a table which share a common configuration.

825

"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.

826

# Must serialize to at most 500 bytes.

827

#

828

# NOTE: Garbage collection executes opportunistically in the background, and

829

# so it's possible for reads to return a cell even if it matches the active

830

# GC expression for its family.

Bu Sun Kim

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

[diff] [blame]

831

"maxNumVersions": 42, # Delete all cells in a column except the most recent N.

832

"maxAge": "A String", # Delete cells in a column older than the given age.

833

# Values must be at least one millisecond, and will be truncated to

834

# microsecond granularity.

Bu Sun Kim

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

[diff] [blame]

835

"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.

836

"rules": [ # Only delete cells which would be deleted by every element of `rules`.

837

# Object with schema name: GcRule

838

],

839

},

840

"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.

841

"rules": [ # Delete cells which would be deleted by any element of `rules`.

842

# Object with schema name: GcRule

843

],

844

},

Bu Sun Kim

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

[diff] [blame]

845

},

846

},

847

},

Bu Sun Kim

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

[diff] [blame]

848

},

849

],

Bu Sun Kim

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

[diff] [blame]

850

"nextPageToken": "A String", # Set if not all tables could be returned in a single response.

851

# Pass this value to `page_token` in another request to get the next

852

# page of results.

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>

858

<pre>Retrieves the next page of results.

859

860

Args:

861

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

862

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

863

864

Returns:

Bu Sun Kim

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

[diff] [blame]

865

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]

866

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]

871

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

Bu Sun Kim

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

[diff] [blame]

872

<pre>Performs a series of column family modifications on the specified table.

873

Either all or none of the modifications will occur before this method

874

returns, but data requests received prior to that point may see a table

875

where only some modifications have taken effect.

876

877

Args:

Dan O'Meara

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

[diff] [blame]

878

name: string, Required. The unique name of the table whose families should be modified.

Bu Sun Kim

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

[diff] [blame]

879

Values are of the form

Dan O'Meara

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

[diff] [blame]

880

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

881

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

882

The object takes the form of:

883

884

{ # Request message for

885

# google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies

Bu Sun Kim

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

[diff] [blame]

886

"modifications": [ # Required. Modifications to be atomically applied to the specified table's families.

Bu Sun Kim

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

[diff] [blame]

887

# Entries are applied in order, meaning that earlier modifications can be

888

# masked by later ones (in the case of repeated updates to the same family,

889

# for example).

890

{ # A create, update, or delete of a particular column family.

Bu Sun Kim

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

[diff] [blame]

891

"id": "A String", # The ID of the column family to be modified.

Bu Sun Kim

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

[diff] [blame]

892

"update": { # A set of columns within a table which share a common configuration. # Update an existing column family to the specified schema, or fail

Bu Sun Kim

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

[diff] [blame]

893

# if no column family exists with the given ID.

Bu Sun Kim

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

[diff] [blame]

894

"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.

Bu Sun Kim

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

[diff] [blame]

895

# Must serialize to at most 500 bytes.

896

#

897

# NOTE: Garbage collection executes opportunistically in the background, and

Bu Sun Kim

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

[diff] [blame]

898

# so it's possible for reads to return a cell even if it matches the active

Bu Sun Kim

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

[diff] [blame]

899

# GC expression for its family.

Bu Sun Kim

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

[diff] [blame]

900

"maxNumVersions": 42, # Delete all cells in a column except the most recent N.

901

"maxAge": "A String", # Delete cells in a column older than the given age.

902

# Values must be at least one millisecond, and will be truncated to

903

# microsecond granularity.

Bu Sun Kim

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

[diff] [blame]

904

"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.

905

"rules": [ # Only delete cells which would be deleted by every element of `rules`.

Bu Sun Kim

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

[diff] [blame]

906

# Object with schema name: GcRule

907

],

908

},

Bu Sun Kim

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

[diff] [blame]

909

"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.

910

"rules": [ # Delete cells which would be deleted by any element of `rules`.

Bu Sun Kim

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

[diff] [blame]

911

# Object with schema name: GcRule

912

],

913

},

Bu Sun Kim

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

[diff] [blame]

914

},

915

},

Bu Sun Kim

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

[diff] [blame]

916

"create": { # A set of columns within a table which share a common configuration. # Create a new column family with the specified schema, or fail if

917

# one already exists with the given ID.

918

"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.

919

# Must serialize to at most 500 bytes.

920

#

921

# NOTE: Garbage collection executes opportunistically in the background, and

922

# so it's possible for reads to return a cell even if it matches the active

923

# GC expression for its family.

Bu Sun Kim

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

[diff] [blame]

924

"maxNumVersions": 42, # Delete all cells in a column except the most recent N.

925

"maxAge": "A String", # Delete cells in a column older than the given age.

926

# Values must be at least one millisecond, and will be truncated to

927

# microsecond granularity.

Bu Sun Kim

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

[diff] [blame]

928

"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.

929

"rules": [ # Only delete cells which would be deleted by every element of `rules`.

930

# Object with schema name: GcRule

931

],

932

},

933

"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.

934

"rules": [ # Delete cells which would be deleted by any element of `rules`.

935

# Object with schema name: GcRule

936

],

937

},

Bu Sun Kim

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

[diff] [blame]

938

},

939

},

940

"drop": True or False, # Drop (delete) the column family with the given ID, or fail if no such

941

# family exists.

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:

953

954

{ # A collection of user data indexed by row, column, and timestamp.

955

# Each table is served using the resources of its parent cluster.

Bu Sun Kim

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

[diff] [blame]

956

"name": "A String", # Output only. The unique name of the table. Values are of the form

957

# `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.

958

# Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`

959

"clusterStates": { # Output only. Map from cluster ID to per-cluster table state.

Bu Sun Kim

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

[diff] [blame]

960

# If it could not be determined whether or not the table has data in a

961

# particular cluster (for example, if its zone is unavailable), then

962

# there will be an entry for the cluster with UNKNOWN `replication_status`.

963

# Views: `REPLICATION_VIEW`, `FULL`

Bu Sun Kim

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

[diff] [blame]

964

"a_key": { # The state of a table's data in a particular cluster.

965

"replicationState": "A String", # Output only. The state of replication for the table in this cluster.

Bu Sun Kim

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

[diff] [blame]

966

},

967

},

Bu Sun Kim

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

[diff] [blame]

968

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

Bu Sun Kim

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

[diff] [blame]

969

# The granularity (i.e. `MILLIS`) at which timestamps are stored in

970

# this table. Timestamps not matching the granularity will be rejected.

971

# If unspecified at creation time, the value will be set to `MILLIS`.

972

# Views: `SCHEMA_VIEW`, `FULL`.

Bu Sun Kim

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

[diff] [blame]

973

"columnFamilies": { # (`CreationOnly`)

974

# The column families configured for this table, mapped by column family ID.

975

# Views: `SCHEMA_VIEW`, `FULL`

976

"a_key": { # A set of columns within a table which share a common configuration.

977

"gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.

978

# Must serialize to at most 500 bytes.

979

#

980

# NOTE: Garbage collection executes opportunistically in the background, and

981

# so it's possible for reads to return a cell even if it matches the active

982

# GC expression for its family.

Bu Sun Kim

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

[diff] [blame]

983

"maxNumVersions": 42, # Delete all cells in a column except the most recent N.

984

"maxAge": "A String", # Delete cells in a column older than the given age.

985

# Values must be at least one millisecond, and will be truncated to

986

# microsecond granularity.

Bu Sun Kim

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

[diff] [blame]

987

"intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.

988

"rules": [ # Only delete cells which would be deleted by every element of `rules`.

989

# Object with schema name: GcRule

990

],

991

},

992

"union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.

993

"rules": [ # Delete cells which would be deleted by any element of `rules`.

994

# Object with schema name: GcRule

995

],

996

},

Bu Sun Kim

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

[diff] [blame]

997

},

998

},

999

},

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]

1004

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

Bu Sun Kim

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

[diff] [blame]

1005

<pre>Sets the access control policy on a Table resource.

Dan O'Meara

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

[diff] [blame]

1006

Replaces any existing policy.

Bu Sun Kim

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

[diff] [blame]

1007

1008

Args:

1009

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

1010

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

Dan O'Meara

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

[diff] [blame]

1011

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1012

The object takes the form of:

1013

1014

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

1015

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

1016

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

1017

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

1018

# might reject them.

Dan O'Meara

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

[diff] [blame]

1019

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

1020

#

1021

#

Dan O'Meara

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

[diff] [blame]

1022

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

1023

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

1024

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

1025

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

1026

# custom role.

Bu Sun Kim

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

[diff] [blame]

1027

#

Dan O'Meara

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

[diff] [blame]

1028

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

1029

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

1030

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

1031

# request, the resource, or both.

1032

#

1033

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1034

#

1035

# {

Bu Sun Kim

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

[diff] [blame]

1036

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

1037

# {

Bu Sun Kim

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

[diff] [blame]

1038

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

1039

# "members": [

1040

# "user:mike@example.com",

1041

# "group:admins@example.com",

1042

# "domain:google.com",

1043

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

Bu Sun Kim

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

[diff] [blame]

1044

# ]

1045

# },

1046

# {

Bu Sun Kim

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

[diff] [blame]

1047

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

1048

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

1049

# "condition": {

1050

# "title": "expirable access",

1051

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

1052

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

Dan O'Meara

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

[diff] [blame]

1053

# }

Bu Sun Kim

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

[diff] [blame]

1054

# }

Dan O'Meara

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

[diff] [blame]

1055

# ],

Bu Sun Kim

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

[diff] [blame]

1056

# "etag": "BwWWja0YfJA=",

1057

# "version": 3

Bu Sun Kim

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

[diff] [blame]

1058

# }

1059

#

Dan O'Meara

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

[diff] [blame]

1060

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1065

# - group:admins@example.com

1066

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1067

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

1068

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1069

# - members:

Dan O'Meara

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

[diff] [blame]

1070

# - user:eve@example.com

1071

# role: roles/resourcemanager.organizationViewer

1072

# condition:

1073

# title: expirable access

1074

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1075

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

Dan O'Meara

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

[diff] [blame]

1076

# - etag: BwWWja0YfJA=

1077

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1078

#

1079

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

Dan O'Meara

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

[diff] [blame]

1080

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

Bu Sun Kim

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

[diff] [blame]

1081

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

Dan O'Meara

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

[diff] [blame]

1082

#

1083

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

1084

# are rejected.

1085

#

1086

# Any operation that affects conditional role bindings must specify version

1087

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

1088

#

1089

# * Getting a policy that includes a conditional role binding

1090

# * Adding a conditional role binding to a policy

1091

# * Changing a conditional role binding in a policy

1092

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

1093

# that includes conditions

1094

#

1095

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

1096

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

1097

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

1098

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

1099

#

1100

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

1101

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

1102

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

1103

{ # Specifies the audit configuration for a service.

1104

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

1105

# identities, if any, are exempted from logging.

1106

# An AuditConfig must have one or more AuditLogConfigs.

1107

#

1108

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

1109

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

1110

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

1111

# AuditLogConfig are exempted.

1112

#

1113

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1119

# "audit_log_configs": [

1120

# {

1121

# "log_type": "DATA_READ",

1122

# "exempted_members": [

1123

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1128

# },

1129

# {

1130

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

1136

# "audit_log_configs": [

1137

# {

1138

# "log_type": "DATA_READ",

1139

# },

1140

# {

1141

# "log_type": "DATA_WRITE",

1142

# "exempted_members": [

1143

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

1152

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

1153

# aliya@example.com from DATA_WRITE logging.

1154

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

1155

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

1156

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

1157

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

1158

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

# Example:

#

# {

# "audit_log_configs": [

1163

# {

1164

# "log_type": "DATA_READ",

1165

# "exempted_members": [

1166

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

1176

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame]

1177

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

Bu Sun Kim

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

[diff] [blame]

1178

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

1179

# permission.

1180

# Follows the same format of Binding.members.

1181

"A String",

1182

],

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]

1188

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

1189

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

1190

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

Bu Sun Kim

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

[diff] [blame]

1191

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

1192

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

1193

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

1194

# independently.

1195

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

1196

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

1197

#

1198

# Example (Comparison):

1199

#

1200

# title: "Summary size limit"

1201

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

1202

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

1203

#

1204

# Example (Equality):

1205

#

1206

# title: "Requestor is owner"

1207

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

1208

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

#

# Example (Logic):

#

# title: "Public documents"

1213

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

1214

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

1215

#

1216

# Example (Data Manipulation):

1217

#

1218

# title: "Notification string"

1219

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

1220

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

1221

#

1222

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

1223

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

1224

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

1225

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

1226

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

1227

# expression.

1228

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

1229

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

Bu Sun Kim

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

[diff] [blame]

1230

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

1231

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

1232

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

1233

# syntax.

Bu Sun Kim

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

[diff] [blame]

1234

},

1235

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

Dan O'Meara

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

[diff] [blame]

1236

# `members` can have the following values:

1237

#

1238

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

1239

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

1240

#

1241

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

1242

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

1243

#

1244

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

1245

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

1246

#

1247

#

1248

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

1249

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

1250

#

1251

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

1252

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

1253

#

1254

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

1255

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

1256

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

1257

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

1258

# retains the role in the binding.

1259

#

1260

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

1261

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

1262

# deleted. For example,

1263

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

1264

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

1265

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

1266

# role in the binding.

1267

#

1268

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

1269

# identifier) representing a Google group that has been recently

1270

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

1271

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

1272

# recovered group retains the role in the binding.

1273

#

1274

#

1275

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

1276

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

1277

#

Bu Sun Kim

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

[diff] [blame]

1278

"A String",

Dan O'Meara

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

[diff] [blame]

1279

],

Bu Sun Kim

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

[diff] [blame]

1280

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

1281

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

Dan O'Meara

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

[diff] [blame]

1282

},

1283

],

Bu Sun Kim

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

[diff] [blame]

1284

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

1285

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

1286

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

1287

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

1288

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

1289

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

1290

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

1291

#

1292

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

1293

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

1294

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

1295

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

Bu Sun Kim

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

[diff] [blame]

1296

},

Bu Sun Kim

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

[diff] [blame]

1297

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

1298

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

1299

# following default mask is used:

Bu Sun Kim

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

[diff] [blame]

1300

# paths: "bindings, etag"

Bu Sun Kim

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

[diff] [blame]

1301

# This field is only used by Cloud IAM.

1302

}

1303

1304

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1311

Dan O'Meara

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

[diff] [blame]

1312

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

1313

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

1314

#

1315

#

Dan O'Meara

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

[diff] [blame]

1316

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

1317

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

1318

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

1319

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

1320

# custom role.

Bu Sun Kim

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

[diff] [blame]

1321

#

Dan O'Meara

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

[diff] [blame]

1322

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

1323

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

1324

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

1325

# request, the resource, or both.

1326

#

1327

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1328

#

1329

# {

Bu Sun Kim

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

[diff] [blame]

1330

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

1331

# {

Bu Sun Kim

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

[diff] [blame]

1332

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

1333

# "members": [

1334

# "user:mike@example.com",

1335

# "group:admins@example.com",

1336

# "domain:google.com",

1337

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

Bu Sun Kim

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

[diff] [blame]

1338

# ]

1339

# },

1340

# {

Bu Sun Kim

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

[diff] [blame]

1341

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

1342

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

1343

# "condition": {

1344

# "title": "expirable access",

1345

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

1346

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

Dan O'Meara

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

[diff] [blame]

1347

# }

Bu Sun Kim

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

[diff] [blame]

1348

# }

Dan O'Meara

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

[diff] [blame]

1349

# ],

Bu Sun Kim

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

[diff] [blame]

1350

# "etag": "BwWWja0YfJA=",

1351

# "version": 3

Bu Sun Kim

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

[diff] [blame]

1352

# }

1353

#

Dan O'Meara

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

[diff] [blame]

1354

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1359

# - group:admins@example.com

1360

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1361

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

1362

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1363

# - members:

Dan O'Meara

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

[diff] [blame]

1364

# - user:eve@example.com

1365

# role: roles/resourcemanager.organizationViewer

1366

# condition:

1367

# title: expirable access

1368

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1369

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

Dan O'Meara

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

[diff] [blame]

1370

# - etag: BwWWja0YfJA=

1371

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1372

#

1373

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

Dan O'Meara

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

[diff] [blame]

1374

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

Bu Sun Kim

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

[diff] [blame]

1375

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

Dan O'Meara

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

[diff] [blame]

1376

#

1377

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

1378

# are rejected.

1379

#

1380

# Any operation that affects conditional role bindings must specify version

1381

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

1382

#

1383

# * Getting a policy that includes a conditional role binding

1384

# * Adding a conditional role binding to a policy

1385

# * Changing a conditional role binding in a policy

1386

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

1387

# that includes conditions

1388

#

1389

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

1390

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

1391

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

1392

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

1393

#

1394

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

1395

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

1396

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

1397

{ # Specifies the audit configuration for a service.

1398

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

1399

# identities, if any, are exempted from logging.

1400

# An AuditConfig must have one or more AuditLogConfigs.

1401

#

1402

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

1403

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

1404

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

1405

# AuditLogConfig are exempted.

1406

#

1407

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1413

# "audit_log_configs": [

1414

# {

1415

# "log_type": "DATA_READ",

1416

# "exempted_members": [

1417

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1422

# },

1423

# {

1424

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

1430

# "audit_log_configs": [

1431

# {

1432

# "log_type": "DATA_READ",

1433

# },

1434

# {

1435

# "log_type": "DATA_WRITE",

1436

# "exempted_members": [

1437

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

1446

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

1447

# aliya@example.com from DATA_WRITE logging.

1448

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

1449

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

1450

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

1451

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

1452

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

# Example:

#

# {

# "audit_log_configs": [

1457

# {

1458

# "log_type": "DATA_READ",

1459

# "exempted_members": [

1460

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

1470

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame]

1471

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

Bu Sun Kim

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

[diff] [blame]

1472

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

1473

# permission.

1474

# Follows the same format of Binding.members.

1475

"A String",

1476

],

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]

1482

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

1483

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

1484

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

Bu Sun Kim

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

[diff] [blame]

1485

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

1486

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

1487

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

1488

# independently.

1489

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

1490

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

1491

#

1492

# Example (Comparison):

1493

#

1494

# title: "Summary size limit"

1495

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

1496

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

1497

#

1498

# Example (Equality):

1499

#

1500

# title: "Requestor is owner"

1501

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

1502

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

#

# Example (Logic):

#

# title: "Public documents"

1507

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

1508

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

1509

#

1510

# Example (Data Manipulation):

1511

#

1512

# title: "Notification string"

1513

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

1514

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

1515

#

1516

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

1517

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

1518

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

1519

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

1520

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

1521

# expression.

1522

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

1523

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

Bu Sun Kim

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

[diff] [blame]

1524

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

1525

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

1526

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

1527

# syntax.

Bu Sun Kim

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

[diff] [blame]

1528

},

1529

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

Dan O'Meara

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

[diff] [blame]

1530

# `members` can have the following values:

1531

#

1532

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

1533

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

1534

#

1535

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

1536

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

1537

#

1538

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

1539

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

1540

#

1541

#

1542

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

1543

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

1544

#

1545

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

1546

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

1547

#

1548

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

1549

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

1550

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

1551

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

1552

# retains the role in the binding.

1553

#

1554

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

1555

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

1556

# deleted. For example,

1557

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

1558

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

1559

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

1560

# role in the binding.

1561

#

1562

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

1563

# identifier) representing a Google group that has been recently

1564

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

1565

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

1566

# recovered group retains the role in the binding.

1567

#

1568

#

1569

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

1570

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

1571

#

Bu Sun Kim

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

[diff] [blame]

1572

"A String",

Dan O'Meara

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

[diff] [blame]

1573

],

Bu Sun Kim

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

[diff] [blame]

1574

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

1575

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

Dan O'Meara

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

[diff] [blame]

1576

},

1577

],

Bu Sun Kim

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

[diff] [blame]

1578

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

1579

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

1580

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

1581

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

1582

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

1583

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

1584

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

1585

#

1586

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

1587

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

1588

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

1589

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

1594

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

1595

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

1596

1597

Args:

1598

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

1599

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

Dan O'Meara

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

[diff] [blame]

1600

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1601

The object takes the form of:

1602

1603

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1604

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

1605

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

Bu Sun Kim

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

[diff] [blame]

1606

# information see

1607

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

Bu Sun Kim

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

[diff] [blame]

1608

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

1619

1620

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1621

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

Bu Sun Kim

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

[diff] [blame]

1622

# allowed.

Bu Sun Kim

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

[diff] [blame]

1623

"A String",

Bu Sun Kim