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

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

[diff] [blame]

78

<code><a href="spanner_v1.projects.instances.backupOperations.html">backupOperations()</a></code>

79

</p>

80

<p class="firstline">Returns the backupOperations Resource.</p>

81

82

83

<code><a href="spanner_v1.projects.instances.backups.html">backups()</a></code>

84

</p>

85

<p class="firstline">Returns the backups Resource.</p>

86

87

88

<code><a href="spanner_v1.projects.instances.databaseOperations.html">databaseOperations()</a></code>

89

</p>

90

<p class="firstline">Returns the databaseOperations Resource.</p>

91

92

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

93

<code><a href="spanner_v1.projects.instances.databases.html">databases()</a></code>

94

</p>

95

<p class="firstline">Returns the databases Resource.</p>

96

97

98

<code><a href="spanner_v1.projects.instances.operations.html">operations()</a></code>

99

</p>

100

<p class="firstline">Returns the operations Resource.</p>

101

102

Dan O'Meara

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

[diff] [blame]

103

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

104

<p class="firstline">Creates an instance and begins preparing it to begin serving. The</p>

105

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

106

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

107

<p class="firstline">Deletes an instance.</p>

108

Dan O'Meara

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

[diff] [blame]

109

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

110

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

111

Bu Sun Kim

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

[diff] [blame]

112

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

113

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

114

Bu Sun Kim

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

[diff] [blame^]

115

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

116

<p class="firstline">Lists all instances in the given project.</p>

117

118

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

119

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

120

Dan O'Meara

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

[diff] [blame]

121

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

122

<p class="firstline">Updates an instance, and begins allocating or releasing resources</p>

123

Dan O'Meara

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

[diff] [blame]

124

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

125

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

126

Dan O'Meara

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

[diff] [blame]

127

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

128

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

129

<h3>Method Details</h3>

130

Dan O'Meara

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

[diff] [blame]

131

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

132

<pre>Creates an instance and begins preparing it to begin serving. The

133

returned long-running operation

134

can be used to track the progress of preparing the new

135

instance. The instance name is assigned by the caller. If the

136

named instance already exists, `CreateInstance` returns

137

`ALREADY_EXISTS`.

138

139

Immediately upon completion of this request:

140

141

* The instance is readable via the API, with all requested attributes

142

but no allocated resources. Its state is `CREATING`.

143

144

Until completion of the returned operation:

145

146

* Cancelling the operation renders the instance immediately unreadable

147

via the API.

148

* The instance can be deleted.

149

* All other attempts to modify the instance are rejected.

150

151

Upon completion of the returned operation:

152

153

* Billing for all successfully-allocated resources begins (some types

154

may have lower than the requested levels).

155

* Databases can be created in the instance.

Bu Sun Kim

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

[diff] [blame^]

156

* The instance's allocated resource levels are readable via the API.

157

* The instance's state becomes `READY`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

158

159

The returned long-running operation will

Dan O'Meara

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

[diff] [blame]

160

have a name of the format `<instance_name>/operations/<operation_id>` and

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

161

can be used to track creation of the instance. The

162

metadata field type is

163

CreateInstanceMetadata.

164

The response field type is

165

Instance, if successful.

166

167

Args:

168

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

Dan O'Meara

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

[diff] [blame]

169

are of the form `projects/<project>`. (required)

170

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

171

The object takes the form of:

172

173

{ # The request for CreateInstance.

Bu Sun Kim

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

[diff] [blame^]

174

"instanceId": "A String", # Required. The ID of the instance to create. Valid identifiers are of the

Bu Sun Kim

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

[diff] [blame]

175

# form `a-z*[a-z0-9]` and must be between 2 and 64 characters in

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

176

# length.

Bu Sun Kim

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

[diff] [blame^]

177

"instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to create. The name may be omitted, but if

Dan O'Meara

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

[diff] [blame]

178

# specified must be `<parent>/instances/<instance_id>`.

Bu Sun Kim

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

[diff] [blame^]

179

"name": "A String", # Required. A unique identifier for the instance, which cannot be changed

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

180

# after the instance is created. Values are of the form

Dan O'Meara

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

[diff] [blame]

181

# `projects/<project>/instances/a-z*[a-z0-9]`. The final

Bu Sun Kim

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

[diff] [blame]

182

# segment of the name must be between 2 and 64 characters in length.

Bu Sun Kim

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

[diff] [blame^]

183

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

184

# Must be unique per project and between 4 and 30 characters in length.

185

"endpointUris": [ # Deprecated. This field is not populated.

186

"A String",

187

],

188

"nodeCount": 42, # The number of nodes allocated to this instance. This

189

# may be zero in API responses for instances that are not yet in state

# `READY`.

#

# See [the

# documentation](https://cloud.google.com/spanner/docs/instances#node_count)

194

# for more information about nodes.

195

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

196

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

197

# deployment strategies. Cloud Labels can be used to filter collections of

198

# resources. They can be used to control how resource metrics are aggregated.

199

# And they can be used as arguments to policy management rules (e.g. route,

200

# firewall, load balancing, etc.).

201

#

202

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

203

# the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

204

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

205

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

206

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

207

#

208

# See https://goo.gl/xmQnxf for more information on and examples of labels.

209

#

210

# If you plan to use labels in your own code, please note that additional

211

# characters may be allowed in the future. And so you are advised to use an

Bu Sun Kim

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

[diff] [blame^]

212

# internal label representation, such as JSON, which doesn't rely upon

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

213

# specific characters being disallowed. For example, representing labels

Bu Sun Kim

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

[diff] [blame^]

214

# as the string: name + "_" + value would prove problematic if we were to

215

# allow "_" in a future release.

216

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

217

},

Bu Sun Kim

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

[diff] [blame^]

218

"config": "A String", # Required. The name of the instance's configuration. Values are of the form

219

# `projects/<project>/instanceConfigs/<configuration>`. See

220

# also InstanceConfig and

221

# ListInstanceConfigs.

222

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

223

# CreateInstance, the state must be

224

# either omitted or set to `CREATING`. For

225

# UpdateInstance, the state must be

226

# either omitted or set to `READY`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

237

238

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

239

# network API call.

Bu Sun Kim

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

[diff] [blame^]

240

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

Bu Sun Kim

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

[diff] [blame]

241

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

242

# available.

Bu Sun Kim

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

[diff] [blame^]

243

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

Bu Sun Kim

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

[diff] [blame]

244

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

245

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

246

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

247

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

248

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

249

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

250

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame^]

251

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

Bu Sun Kim

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

[diff] [blame]

252

},

Bu Sun Kim

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

[diff] [blame^]

253

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

Bu Sun Kim

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

[diff] [blame]

254

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

255

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

Bu Sun Kim

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

[diff] [blame^]

256

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

257

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

258

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

259

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

260

#

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

# message types for APIs to use.

269

{

270

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

},

],

},

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

Dan O'Meara

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

[diff] [blame]

275

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

276

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

277

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

Bu Sun Kim

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

[diff] [blame^]

278

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

Dan O'Meara

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

[diff] [blame]

279

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

284

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

285

<pre>Deletes an instance.

286

287

Immediately upon completion of the request:

288

Bu Sun Kim

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

[diff] [blame^]

289

* Billing ceases for all of the instance's reserved resources.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

Soon afterward:

* The instance and *all of its databases* immediately and

294

irrevocably disappear from the API. All data in the databases

295

is permanently deleted.

296

297

Args:

298

name: string, Required. The name of the instance to be deleted. Values are of the form

Dan O'Meara

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

[diff] [blame]

299

`projects/<project>/instances/<instance>` (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

300

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

307

308

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

309

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

310

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

311

#

312

# service Foo {

313

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

314

# }

315

#

316

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

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

321

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

322

<pre>Gets information about a particular instance.

323

324

Args:

325

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

Dan O'Meara

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

[diff] [blame]

326

`projects/<project>/instances/<instance>`. (required)

327

fieldMask: string, If field_mask is present, specifies the subset of Instance fields that

328

should be returned.

329

If absent, all Instance fields are returned.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

330

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

337

338

{ # An isolated set of Cloud Spanner resources on which databases can be hosted.

Bu Sun Kim

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

[diff] [blame^]

339

"name": "A String", # Required. A unique identifier for the instance, which cannot be changed

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

340

# after the instance is created. Values are of the form

Dan O'Meara

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

[diff] [blame]

341

# `projects/<project>/instances/a-z*[a-z0-9]`. The final

Bu Sun Kim

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

[diff] [blame]

342

# segment of the name must be between 2 and 64 characters in length.

Bu Sun Kim

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

[diff] [blame^]

343

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

344

# Must be unique per project and between 4 and 30 characters in length.

345

"endpointUris": [ # Deprecated. This field is not populated.

346

"A String",

347

],

348

"nodeCount": 42, # The number of nodes allocated to this instance. This

349

# may be zero in API responses for instances that are not yet in state

# `READY`.

#

# See [the

# documentation](https://cloud.google.com/spanner/docs/instances#node_count)

354

# for more information about nodes.

355

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

356

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

357

# deployment strategies. Cloud Labels can be used to filter collections of

358

# resources. They can be used to control how resource metrics are aggregated.

359

# And they can be used as arguments to policy management rules (e.g. route,

360

# firewall, load balancing, etc.).

361

#

362

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

363

# the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

364

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

365

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

366

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

367

#

368

# See https://goo.gl/xmQnxf for more information on and examples of labels.

369

#

370

# If you plan to use labels in your own code, please note that additional

371

# characters may be allowed in the future. And so you are advised to use an

Bu Sun Kim

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

[diff] [blame^]

372

# internal label representation, such as JSON, which doesn't rely upon

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

373

# specific characters being disallowed. For example, representing labels

Bu Sun Kim

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

[diff] [blame^]

374

# as the string: name + "_" + value would prove problematic if we were to

375

# allow "_" in a future release.

376

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

377

},

Bu Sun Kim

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

[diff] [blame^]

378

"config": "A String", # Required. The name of the instance's configuration. Values are of the form

379

# `projects/<project>/instanceConfigs/<configuration>`. See

380

# also InstanceConfig and

381

# ListInstanceConfigs.

382

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

383

# CreateInstance, the state must be

384

# either omitted or set to `CREATING`. For

385

# UpdateInstance, the state must be

386

# either omitted or set to `READY`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

391

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

392

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

393

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

394

395

Authorization requires `spanner.instances.getIamPolicy` on

396

resource.

397

398

Args:

Dan O'Meara

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

[diff] [blame]

399

resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources. (required)

Bu Sun Kim

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

[diff] [blame]

400

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

401

The object takes the form of:

402

403

{ # Request message for `GetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame^]

404

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

405

# `GetIamPolicy`.

406

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

Dan O'Meara

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

[diff] [blame]

407

#

408

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

409

# rejected.

410

#

411

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

412

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

413

# leave the field unset.

414

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

415

}

416

417

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

424

Dan O'Meara

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

[diff] [blame]

425

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

426

# controls for Google Cloud resources.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

427

#

428

#

Dan O'Meara

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

[diff] [blame]

429

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

430

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

431

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

432

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

433

# custom role.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

434

#

Dan O'Meara

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

[diff] [blame]

435

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

436

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

437

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

438

# request, the resource, or both.

439

#

440

# **JSON example:**

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

441

#

442

# {

Bu Sun Kim

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

[diff] [blame^]

443

# "bindings": [

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

444

# {

Bu Sun Kim

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

[diff] [blame^]

445

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

446

# "members": [

447

# "user:mike@example.com",

448

# "group:admins@example.com",

449

# "domain:google.com",

450

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

451

# ]

452

# },

453

# {

Bu Sun Kim

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

[diff] [blame^]

454

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

455

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

456

# "condition": {

457

# "title": "expirable access",

458

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

459

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

Dan O'Meara

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

[diff] [blame]

460

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

461

# }

Dan O'Meara

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

[diff] [blame]

462

# ],

Bu Sun Kim

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

[diff] [blame^]

463

# "etag": "BwWWja0YfJA=",

464

# "version": 3

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

465

# }

466

#

Dan O'Meara

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

[diff] [blame]

467

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

472

# - group:admins@example.com

473

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

474

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

475

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

476

# - members:

Dan O'Meara

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

[diff] [blame]

477

# - user:eve@example.com

478

# role: roles/resourcemanager.organizationViewer

479

# condition:

480

# title: expirable access

481

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame^]

482

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

Dan O'Meara

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

[diff] [blame]

483

# - etag: BwWWja0YfJA=

484

# - version: 3

Bu Sun Kim

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

[diff] [blame]

485

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

486

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

Dan O'Meara

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

[diff] [blame]

487

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

Bu Sun Kim

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

[diff] [blame^]

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

#

496

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

497

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

498

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

499

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

500

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

501

#

502

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

503

# are rejected.

504

#

505

# Any operation that affects conditional role bindings must specify version

506

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

507

#

508

# * Getting a policy that includes a conditional role binding

509

# * Adding a conditional role binding to a policy

510

# * Changing a conditional role binding in a policy

511

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

512

# that includes conditions

513

#

514

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

515

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

516

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

517

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

518

#

519

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

520

# specify any valid version or leave the field unset.

521

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

522

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

523

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

524

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

Bu Sun Kim

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

[diff] [blame^]

525

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

526

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

527

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

528

# independently.

529

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

530

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

531

#

532

# Example (Comparison):

533

#

534

# title: "Summary size limit"

535

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

536

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

537

#

538

# Example (Equality):

539

#

540

# title: "Requestor is owner"

541

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

542

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

#

# Example (Logic):

#

# title: "Public documents"

547

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

548

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

549

#

550

# Example (Data Manipulation):

551

#

552

# title: "Notification string"

553

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

554

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

555

#

556

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

557

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

558

# documentation for additional information.

559

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

560

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

561

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

562

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

563

# expression.

564

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

565

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

566

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

567

# syntax.

568

},

569

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

570

# `members` can have the following values:

571

#

572

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

573

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

574

#

575

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

576

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

577

#

578

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

Dan O'Meara

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

[diff] [blame]

579

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

580

#

581

#

582

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

583

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

584

#

585

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

586

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

587

#

Dan O'Meara

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

[diff] [blame]

588

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

589

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

590

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

591

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

592

# retains the role in the binding.

593

#

594

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

595

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

596

# deleted. For example,

597

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

598

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

599

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

600

# role in the binding.

601

#

602

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

603

# identifier) representing a Google group that has been recently

604

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

605

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

606

# recovered group retains the role in the binding.

607

#

Bu Sun Kim

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

[diff] [blame]

608

#

609

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

610

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

611

#

Bu Sun Kim

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

[diff] [blame^]

612

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

613

],

Bu Sun Kim

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

[diff] [blame^]

614

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

615

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

616

},

617

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

622

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

623

<pre>Lists all instances in the given project.

624

625

Args:

626

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

Dan O'Meara

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

[diff] [blame]

627

requested. Values are of the form `projects/<project>`. (required)

Bu Sun Kim

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

[diff] [blame]

628

filter: string, An expression for filtering the results of the request. Filter rules are

629

case insensitive. The fields eligible for filtering are:

* `name`

* `display_name`

* `labels.key` where key is the name of a label

634

635

Some examples of using filters are:

636

Dan O'Meara

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

[diff] [blame]

637

* `name:*` --> The instance has a name.

Bu Sun Kim

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

[diff] [blame^]

638

* `name:Howl` --> The instance's name contains the string "howl".

Dan O'Meara

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

[diff] [blame]

639

* `name:HOWL` --> Equivalent to above.

640

* `NAME:howl` --> Equivalent to above.

Bu Sun Kim

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

[diff] [blame^]

641

* `labels.env:*` --> The instance has the label "env".

642

* `labels.env:dev` --> The instance has the label "env" and the value of

643

the label contains the string "dev".

644

* `name:howl labels.env:dev` --> The instance's name contains "howl" and

645

it has the label "env" with its value

646

containing "dev".

647

pageToken: string, If non-empty, `page_token` should contain a

648

next_page_token from a

649

previous ListInstancesResponse.

650

pageSize: integer, Number of instances to be returned in the response. If 0 or less, defaults

651

to the server's maximum allowed page size.

652

x__xgafv: string, V1 error format.

653

Allowed values

654

1 - v1 error format

655

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

656

657

Returns:

658

An object of the form:

659

660

{ # The response for ListInstances.

Bu Sun Kim

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

[diff] [blame^]

661

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

662

{ # An isolated set of Cloud Spanner resources on which databases can be hosted.

Bu Sun Kim

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

[diff] [blame^]

663

"name": "A String", # Required. A unique identifier for the instance, which cannot be changed

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

664

# after the instance is created. Values are of the form

Dan O'Meara

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

[diff] [blame]

665

# `projects/<project>/instances/a-z*[a-z0-9]`. The final

Bu Sun Kim

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

[diff] [blame]

666

# segment of the name must be between 2 and 64 characters in length.

Bu Sun Kim

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

[diff] [blame^]

667

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

668

# Must be unique per project and between 4 and 30 characters in length.

669

"endpointUris": [ # Deprecated. This field is not populated.

670

"A String",

671

],

672

"nodeCount": 42, # The number of nodes allocated to this instance. This

673

# may be zero in API responses for instances that are not yet in state

# `READY`.

#

# See [the

# documentation](https://cloud.google.com/spanner/docs/instances#node_count)

678

# for more information about nodes.

679

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

680

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

681

# deployment strategies. Cloud Labels can be used to filter collections of

682

# resources. They can be used to control how resource metrics are aggregated.

683

# And they can be used as arguments to policy management rules (e.g. route,

684

# firewall, load balancing, etc.).

685

#

686

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

687

# the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

688

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

689

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

690

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

691

#

692

# See https://goo.gl/xmQnxf for more information on and examples of labels.

693

#

694

# If you plan to use labels in your own code, please note that additional

695

# characters may be allowed in the future. And so you are advised to use an

Bu Sun Kim

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

[diff] [blame^]

696

# internal label representation, such as JSON, which doesn't rely upon

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

697

# specific characters being disallowed. For example, representing labels

Bu Sun Kim

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

[diff] [blame^]

698

# as the string: name + "_" + value would prove problematic if we were to

699

# allow "_" in a future release.

700

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

701

},

Bu Sun Kim

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

[diff] [blame^]

702

"config": "A String", # Required. The name of the instance's configuration. Values are of the form

703

# `projects/<project>/instanceConfigs/<configuration>`. See

704

# also InstanceConfig and

705

# ListInstanceConfigs.

706

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

707

# CreateInstance, the state must be

708

# either omitted or set to `CREATING`. For

709

# UpdateInstance, the state must be

710

# either omitted or set to `READY`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

711

},

712

],

Bu Sun Kim

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

[diff] [blame^]

713

"nextPageToken": "A String", # `next_page_token` can be sent in a subsequent

714

# ListInstances call to fetch more

715

# of the matching instances.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

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

721

<pre>Retrieves the next page of results.

722

723

Args:

724

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

725

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

726

727

Returns:

Bu Sun Kim

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

[diff] [blame^]

728

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

729

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]

734

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

735

<pre>Updates an instance, and begins allocating or releasing resources

736

as requested. The returned long-running

737

operation can be used to track the

738

progress of updating the instance. If the named instance does not

739

exist, returns `NOT_FOUND`.

740

741

Immediately upon completion of this request:

742

Bu Sun Kim

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

[diff] [blame^]

743

* For resource types for which a decrease in the instance's allocation

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

744

has been requested, billing is based on the newly-requested level.

745

746

Until completion of the returned operation:

747

Bu Sun Kim

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

[diff] [blame^]

748

* Cancelling the operation sets its metadata's

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

749

cancel_time, and begins

750

restoring resources to their pre-request values. The operation

751

is guaranteed to succeed at undoing all resource changes,

752

after which point it terminates with a `CANCELLED` status.

753

* All other attempts to modify the instance are rejected.

754

* Reading the instance via the API continues to give the pre-request

755

resource levels.

756

757

Upon completion of the returned operation:

758

759

* Billing begins for all successfully-allocated resources (some types

760

may have lower than the requested levels).

Bu Sun Kim

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

[diff] [blame^]

761

* All newly-reserved resources are available for serving the instance's

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

762

tables.

Bu Sun Kim

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

[diff] [blame^]

763

* The instance's new resource levels are readable via the API.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

764

765

The returned long-running operation will

Dan O'Meara

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

[diff] [blame]

766

have a name of the format `<instance_name>/operations/<operation_id>` and

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

767

can be used to track the instance modification. The

768

metadata field type is

769

UpdateInstanceMetadata.

770

The response field type is

771

Instance, if successful.

772

773

Authorization requires `spanner.instances.update` permission on

resource name.

Args:

name: string, Required. A unique identifier for the instance, which cannot be changed

778

after the instance is created. Values are of the form

Dan O'Meara

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

[diff] [blame]

779

`projects/<project>/instances/a-z*[a-z0-9]`. The final

Bu Sun Kim

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

[diff] [blame]

780

segment of the name must be between 2 and 64 characters in length. (required)

Dan O'Meara

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

[diff] [blame]

781

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

782

The object takes the form of:

783

784

{ # The request for UpdateInstance.

Bu Sun Kim

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

[diff] [blame^]

785

"fieldMask": "A String", # Required. A mask specifying which fields in Instance should be updated.

786

# The field mask must always be specified; this prevents any future fields in

787

# Instance from being erased accidentally by clients that do not know

788

# about them.

789

"instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to update, which must always include the instance

Dan O'Meara

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

[diff] [blame]

790

# name. Otherwise, only fields mentioned in field_mask need be included.

Bu Sun Kim

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

[diff] [blame^]

791

"name": "A String", # Required. A unique identifier for the instance, which cannot be changed

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

792

# after the instance is created. Values are of the form

Dan O'Meara

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

[diff] [blame]

793

# `projects/<project>/instances/a-z*[a-z0-9]`. The final

Bu Sun Kim

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

[diff] [blame]

794

# segment of the name must be between 2 and 64 characters in length.

Bu Sun Kim

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

[diff] [blame^]

795

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

796

# Must be unique per project and between 4 and 30 characters in length.

797

"endpointUris": [ # Deprecated. This field is not populated.

798

"A String",

799

],

800

"nodeCount": 42, # The number of nodes allocated to this instance. This

801

# may be zero in API responses for instances that are not yet in state

# `READY`.

#

# See [the

# documentation](https://cloud.google.com/spanner/docs/instances#node_count)

806

# for more information about nodes.

807

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

808

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

809

# deployment strategies. Cloud Labels can be used to filter collections of

810

# resources. They can be used to control how resource metrics are aggregated.

811

# And they can be used as arguments to policy management rules (e.g. route,

812

# firewall, load balancing, etc.).

813

#

814

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

815

# the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.

816

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

817

# to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

818

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

819

#

820

# See https://goo.gl/xmQnxf for more information on and examples of labels.

821

#

822

# If you plan to use labels in your own code, please note that additional

823

# characters may be allowed in the future. And so you are advised to use an

Bu Sun Kim

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

[diff] [blame^]

824

# internal label representation, such as JSON, which doesn't rely upon

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

825

# specific characters being disallowed. For example, representing labels

Bu Sun Kim

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

[diff] [blame^]

826

# as the string: name + "_" + value would prove problematic if we were to

827

# allow "_" in a future release.

828

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

829

},

Bu Sun Kim

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

[diff] [blame^]

830

"config": "A String", # Required. The name of the instance's configuration. Values are of the form

831

# `projects/<project>/instanceConfigs/<configuration>`. See

832

# also InstanceConfig and

833

# ListInstanceConfigs.

834

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

835

# CreateInstance, the state must be

836

# either omitted or set to `CREATING`. For

837

# UpdateInstance, the state must be

838

# either omitted or set to `READY`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

839

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

840

}

841

842

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

849

850

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

851

# network API call.

Bu Sun Kim

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

[diff] [blame^]

852

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

Bu Sun Kim

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

[diff] [blame]

853

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

854

# available.

Bu Sun Kim

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

[diff] [blame^]

855

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

Bu Sun Kim

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

[diff] [blame]

856

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

857

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

858

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

859

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

860

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

861

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

862

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame^]

863

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

Bu Sun Kim

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

[diff] [blame]

864

},

Bu Sun Kim

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

[diff] [blame^]

865

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

Bu Sun Kim

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

[diff] [blame]

866

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

867

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

Bu Sun Kim

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

[diff] [blame^]

868

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

869

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

870

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

871

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

872

#

873

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

874

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

875

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

876

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

877

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

878

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

879

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

880

# message types for APIs to use.

881

{

882

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

},

],

},

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

Dan O'Meara

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

[diff] [blame]

887

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

888

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

889

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

Bu Sun Kim

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

[diff] [blame^]

890

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

Dan O'Meara

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

[diff] [blame]

891

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

896

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

897

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

898

existing policy.

899

900

Authorization requires `spanner.instances.setIamPolicy` on

901

resource.

902

903

Args:

Dan O'Meara

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

[diff] [blame]

904

resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for databases resources. (required)

905

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

906

The object takes the form of:

907

908

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame^]

909

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

910

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

911

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

912

# might reject them.

Dan O'Meara

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

[diff] [blame]

913

# controls for Google Cloud resources.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

914

#

915

#

Dan O'Meara

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

[diff] [blame]

916

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

917

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

918

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

919

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

920

# custom role.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

921

#

Dan O'Meara

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

[diff] [blame]

922

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

923

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

924

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

925

# request, the resource, or both.

926

#

927

# **JSON example:**

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

928

#

929

# {

Bu Sun Kim

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

[diff] [blame^]

930

# "bindings": [

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

931

# {

Bu Sun Kim

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

[diff] [blame^]

932

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

933

# "members": [

934

# "user:mike@example.com",

935

# "group:admins@example.com",

936

# "domain:google.com",

937

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

938

# ]

939

# },

940

# {

Bu Sun Kim

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

[diff] [blame^]

941

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

942

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

943

# "condition": {

944

# "title": "expirable access",

945

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

946

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

Dan O'Meara

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

[diff] [blame]

947

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

948

# }

Dan O'Meara

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

[diff] [blame]

949

# ],

Bu Sun Kim

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

[diff] [blame^]

950

# "etag": "BwWWja0YfJA=",

951

# "version": 3

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

952

# }

953

#

Dan O'Meara

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

[diff] [blame]

954

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

959

# - group:admins@example.com

960

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

961

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

962

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

963

# - members:

Dan O'Meara

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

[diff] [blame]

964

# - user:eve@example.com

965

# role: roles/resourcemanager.organizationViewer

966

# condition:

967

# title: expirable access

968

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame^]

969

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

Dan O'Meara

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

[diff] [blame]

970

# - etag: BwWWja0YfJA=

971

# - version: 3

Bu Sun Kim

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

[diff] [blame]

972

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

973

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

Dan O'Meara

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

[diff] [blame]

974

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

Bu Sun Kim

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

[diff] [blame^]

975

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

976

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

977

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

978

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

979

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

980

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

981

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

982

#

983

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

984

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

985

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

986

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

987

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

988

#

989

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

990

# are rejected.

991

#

992

# Any operation that affects conditional role bindings must specify version

993

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

994

#

995

# * Getting a policy that includes a conditional role binding

996

# * Adding a conditional role binding to a policy

997

# * Changing a conditional role binding in a policy

998

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

999

# that includes conditions

1000

#

1001

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

1002

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

1003

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

1004

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

1005

#

1006

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

1007

# specify any valid version or leave the field unset.

1008

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

1009

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

1010

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1011

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

Bu Sun Kim

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

[diff] [blame^]

1012

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

1013

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

1014

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

1015

# independently.

1016

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

1017

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

1018

#

1019

# Example (Comparison):

1020

#

1021

# title: "Summary size limit"

1022

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

1023

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

1024

#

1025

# Example (Equality):

1026

#

1027

# title: "Requestor is owner"

1028

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

1029

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

#

# Example (Logic):

#

# title: "Public documents"

1034

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

1035

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

1036

#

1037

# Example (Data Manipulation):

1038

#

1039

# title: "Notification string"

1040

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

1041

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

1042

#

1043

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

1044

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

1045

# documentation for additional information.

1046

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

1047

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

1048

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

1049

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

1050

# expression.

1051

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

1052

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

1053

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

1054

# syntax.

1055

},

1056

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1057

# `members` can have the following values:

1058

#

1059

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

1060

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

1061

#

1062

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

1063

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

1064

#

1065

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

Dan O'Meara

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

[diff] [blame]

1066

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1067

#

1068

#

1069

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

1070

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

1071

#

1072

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

1073

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

1074

#

Dan O'Meara

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

[diff] [blame]

1075

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

1076

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

1077

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

1078

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

1079

# retains the role in the binding.

1080

#

1081

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

1082

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

1083

# deleted. For example,

1084

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

1085

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

1086

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

1087

# role in the binding.

1088

#

1089

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

1090

# identifier) representing a Google group that has been recently

1091

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

1092

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

1093

# recovered group retains the role in the binding.

1094

#

Bu Sun Kim

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

[diff] [blame]

1095

#

1096

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1097

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

1098

#

Bu Sun Kim

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

[diff] [blame^]

1099

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1100

],

Bu Sun Kim

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

[diff] [blame^]

1101

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

1102

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1103

},

1104

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1105

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1106

}

1107

1108

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1115

Dan O'Meara

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

[diff] [blame]

1116

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

1117

# controls for Google Cloud resources.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1118

#

1119

#

Dan O'Meara

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

[diff] [blame]

1120

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

1121

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

1122

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

1123

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

1124

# custom role.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1125

#

Dan O'Meara

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

[diff] [blame]

1126

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

1127

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

1128

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

1129

# request, the resource, or both.

1130

#

1131

# **JSON example:**

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1132

#

1133

# {

Bu Sun Kim

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

[diff] [blame^]

1134

# "bindings": [

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1135

# {

Bu Sun Kim

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

[diff] [blame^]

1136

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

1137

# "members": [

1138

# "user:mike@example.com",

1139

# "group:admins@example.com",

1140

# "domain:google.com",

1141

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1142

# ]

1143

# },

1144

# {

Bu Sun Kim

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

[diff] [blame^]

1145

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

1146

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

1147

# "condition": {

1148

# "title": "expirable access",

1149

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

1150

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

Dan O'Meara

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

[diff] [blame]

1151

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1152

# }

Dan O'Meara

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

[diff] [blame]

1153

# ],

Bu Sun Kim

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

[diff] [blame^]

1154

# "etag": "BwWWja0YfJA=",

1155

# "version": 3

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1156

# }

1157

#

Dan O'Meara

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

[diff] [blame]

1158

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1163

# - group:admins@example.com

1164

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1165

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

1166

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1167

# - members:

Dan O'Meara

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

[diff] [blame]

1168

# - user:eve@example.com

1169

# role: roles/resourcemanager.organizationViewer

1170

# condition:

1171

# title: expirable access

1172

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame^]

1173

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

Dan O'Meara

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

[diff] [blame]

1174

# - etag: BwWWja0YfJA=

1175

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1176

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1177

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

Dan O'Meara

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

[diff] [blame]

1178

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

Bu Sun Kim

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

[diff] [blame^]

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

#

1187

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

1188

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

1189

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

1190

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

1191

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

1192

#

1193

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

1194

# are rejected.

1195

#

1196

# Any operation that affects conditional role bindings must specify version

1197

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

1198

#

1199

# * Getting a policy that includes a conditional role binding

1200

# * Adding a conditional role binding to a policy

1201

# * Changing a conditional role binding in a policy

1202

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

1203

# that includes conditions

1204

#

1205

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

1206

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

1207

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

1208

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

1209

#

1210

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

1211

# specify any valid version or leave the field unset.

1212

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

1213

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

1214

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1215

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

Bu Sun Kim

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

[diff] [blame^]

1216

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

1217

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

1218

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

1219

# independently.

1220

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

1221

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

1222

#

1223

# Example (Comparison):

1224

#

1225

# title: "Summary size limit"

1226

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

1227

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

1228

#

1229

# Example (Equality):

1230

#

1231

# title: "Requestor is owner"

1232

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

1233

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

#

# Example (Logic):

#

# title: "Public documents"

1238

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

1239

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

1240

#

1241

# Example (Data Manipulation):

1242

#

1243

# title: "Notification string"

1244

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

1245

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

1246

#

1247

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

1248

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

1249

# documentation for additional information.

1250

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

1251

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

1252

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

1253

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

1254

# expression.

1255

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

1256

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

1257

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

1258

# syntax.

1259

},

1260

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1261

# `members` can have the following values:

1262

#

1263

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

1264

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

1265

#

1266

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

1267

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

1268

#

1269

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

Dan O'Meara

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

[diff] [blame]

1270

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1271

#

1272

#

1273

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

1274

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

1275

#

1276

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

1277

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

1278

#

Dan O'Meara

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

[diff] [blame]

1279

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

1280

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

1281

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

1282

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

1283

# retains the role in the binding.

1284

#

1285

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

1286

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

1287

# deleted. For example,

1288

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

1289

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

1290

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

1291

# role in the binding.

1292

#

1293

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

1294

# identifier) representing a Google group that has been recently

1295

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

1296

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

1297

# recovered group retains the role in the binding.

1298

#

Bu Sun Kim

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

[diff] [blame]

1299

#

1300

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1301

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

1302

#

Bu Sun Kim

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

[diff] [blame^]

1303

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1304

],

Bu Sun Kim

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

[diff] [blame^]

1305

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

1306

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1307

},

1308

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1313

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1314

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

1315

1316

Attempting this RPC on a non-existent Cloud Spanner instance resource will

1317

result in a NOT_FOUND error if the user has `spanner.instances.list`

1318

permission on the containing Google Cloud Project. Otherwise returns an

1319

empty set of permissions.

1320

1321

Args:

Dan O'Meara

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

[diff] [blame]

1322

resource: string, REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources. (required)

1323

body: object, The request body.

Sai Cheemalapati