Blame - docs/dyn/sourcerepo_v1.projects.repos.html - platform/external/python/google-api-python-client

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

[diff] [blame]

78

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

79

<p class="firstline">Creates a repo in the given project with the given name.</p>

Sai Cheemalapati

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

[diff] [blame]

80

Thomas Coffee

2f24537

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

[diff] [blame]

81

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

Sai Cheemalapati

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

[diff] [blame]

82

<p class="firstline">Deletes a repo.</p>

83

Thomas Coffee

2f24537

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

[diff] [blame]

84

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

Sai Cheemalapati

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

[diff] [blame]

85

<p class="firstline">Returns information about a repo.</p>

86

Dan O'Meara

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

[diff] [blame]

87

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

Sai Cheemalapati

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

[diff] [blame]

88

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

89

Bu Sun Kim

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

[diff] [blame^]

90

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

91

<p class="firstline">Returns all repos belonging to a project. The sizes of the repos are</p>

92

93

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

94

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

Sai Cheemalapati

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

[diff] [blame]

95

Dan O'Meara

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">Updates information about a repo.</p>

98

Dan O'Meara

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

[diff] [blame]

99

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

100

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

101

Bu Sun Kim

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

[diff] [blame]

102

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

103

<p class="firstline">Synchronize a connected repo.</p>

104

Dan O'Meara

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

[diff] [blame]

105

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

106

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

107

<h3>Method Details</h3>

108

Dan O'Meara

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

[diff] [blame]

109

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

110

<pre>Creates a repo in the given project with the given name.

Sai Cheemalapati

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

[diff] [blame]

111

112

If the named repository already exists, `CreateRepo` returns

`ALREADY_EXISTS`.

Args:

parent: string, The project in which to create the repo. Values are of the form

Dan O'Meara

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

[diff] [blame]

117

`projects/<project>`. (required)

118

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

119

The object takes the form of:

120

121

{ # A repository (or repo) is a Git repository storing versioned source content.

Bu Sun Kim

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

[diff] [blame^]

122

"mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.

Bu Sun Kim

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

[diff] [blame]

123

# Read-only field.

Bu Sun Kim

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

[diff] [blame^]

124

# hosting service, for example GitHub or Bitbucket.

125

"deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.

126

# Removing this key from the other service would deauthorize

127

# Google Cloud Source Repositories from mirroring.

128

"url": "A String", # URL of the main repository at the other hosting service.

129

"webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.

130

# Removing this webhook from the other hosting service will stop

131

# Google Cloud Source Repositories from receiving notifications,

132

# and thereby disabling mirroring.

133

},

134

"url": "A String", # URL to clone the repository from Google Cloud Source Repositories.

135

# Read-only field.

136

"pubsubConfigs": { # How this repository publishes a change in the repository through Cloud

Bu Sun Kim

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

[diff] [blame]

137

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame^]

138

"a_key": { # Configuration to publish a Cloud Pub/Sub message.

139

"serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub

Bu Sun Kim

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

[diff] [blame]

140

# messages. This service account needs to be in the same project as the

141

# PubsubConfig. When added, the caller needs to have

142

# iam.serviceAccounts.actAs permission on this service account. If

143

# unspecified, it defaults to the compute engine default service account.

Bu Sun Kim

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

[diff] [blame^]

144

"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.

145

"topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form

146

# `projects/<project>/topics/<topic>`. The project needs to be the same

147

# project as this config is in.

Bu Sun Kim

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

[diff] [blame]

148

},

149

},

Bu Sun Kim

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

[diff] [blame^]

150

"size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only

Bu Sun Kim

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

[diff] [blame]

151

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

152

"name": "A String", # Resource name of the repository, of the form

Dan O'Meara

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

[diff] [blame]

153

# `projects/<project>/repos/<repo>`. The repo name may contain slashes.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

154

# eg, `projects/myproject/repos/name/with/slash`

Sai Cheemalapati

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

[diff] [blame]

155

}

156

157

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

164

165

{ # A repository (or repo) is a Git repository storing versioned source content.

Bu Sun Kim

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

[diff] [blame^]

166

"mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.

Bu Sun Kim

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

[diff] [blame]

167

# Read-only field.

Bu Sun Kim

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

[diff] [blame^]

168

# hosting service, for example GitHub or Bitbucket.

169

"deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.

170

# Removing this key from the other service would deauthorize

171

# Google Cloud Source Repositories from mirroring.

172

"url": "A String", # URL of the main repository at the other hosting service.

173

"webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.

174

# Removing this webhook from the other hosting service will stop

175

# Google Cloud Source Repositories from receiving notifications,

176

# and thereby disabling mirroring.

177

},

178

"url": "A String", # URL to clone the repository from Google Cloud Source Repositories.

179

# Read-only field.

180

"pubsubConfigs": { # How this repository publishes a change in the repository through Cloud

Bu Sun Kim

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

[diff] [blame]

181

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame^]

182

"a_key": { # Configuration to publish a Cloud Pub/Sub message.

183

"serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub

Bu Sun Kim

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

[diff] [blame]

184

# messages. This service account needs to be in the same project as the

185

# PubsubConfig. When added, the caller needs to have

186

# iam.serviceAccounts.actAs permission on this service account. If

187

# unspecified, it defaults to the compute engine default service account.

Bu Sun Kim

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

[diff] [blame^]

188

"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.

189

"topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form

190

# `projects/<project>/topics/<topic>`. The project needs to be the same

191

# project as this config is in.

Bu Sun Kim

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

[diff] [blame]

192

},

193

},

Bu Sun Kim

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

[diff] [blame^]

194

"size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only

Bu Sun Kim

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

[diff] [blame]

195

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

196

"name": "A String", # Resource name of the repository, of the form

Dan O'Meara

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

[diff] [blame]

197

# `projects/<project>/repos/<repo>`. The repo name may contain slashes.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

198

# eg, `projects/myproject/repos/name/with/slash`

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Thomas Coffee

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

[diff] [blame]

203

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

Sai Cheemalapati

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

[diff] [blame]

<pre>Deletes a repo.

Args:

Dan O'Meara

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

[diff] [blame]

208

`projects/<project>/repos/<repo>`. (required)

Sai Cheemalapati

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

[diff] [blame]

209

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

216

217

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

218

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

219

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

220

#

221

# service Foo {

222

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

223

# }

224

#

225

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

}</pre>

</div>

Thomas Coffee

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

[diff] [blame]

230

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

Sai Cheemalapati

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

[diff] [blame]

231

<pre>Returns information about a repo.

Args:

Dan O'Meara

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

[diff] [blame]

235

`projects/<project>/repos/<repo>`. (required)

Sai Cheemalapati

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

[diff] [blame]

236

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

243

244

{ # A repository (or repo) is a Git repository storing versioned source content.

Bu Sun Kim

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

[diff] [blame^]

245

"mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.

Bu Sun Kim

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

[diff] [blame]

246

# Read-only field.

Bu Sun Kim

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

[diff] [blame^]

247

# hosting service, for example GitHub or Bitbucket.

248

"deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.

249

# Removing this key from the other service would deauthorize

250

# Google Cloud Source Repositories from mirroring.

251

"url": "A String", # URL of the main repository at the other hosting service.

252

"webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.

253

# Removing this webhook from the other hosting service will stop

254

# Google Cloud Source Repositories from receiving notifications,

255

# and thereby disabling mirroring.

256

},

257

"url": "A String", # URL to clone the repository from Google Cloud Source Repositories.

258

# Read-only field.

259

"pubsubConfigs": { # How this repository publishes a change in the repository through Cloud

Bu Sun Kim

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

[diff] [blame]

260

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame^]

261

"a_key": { # Configuration to publish a Cloud Pub/Sub message.

262

"serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub

Bu Sun Kim

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

[diff] [blame]

263

# messages. This service account needs to be in the same project as the

264

# PubsubConfig. When added, the caller needs to have

265

# iam.serviceAccounts.actAs permission on this service account. If

266

# unspecified, it defaults to the compute engine default service account.

Bu Sun Kim

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

[diff] [blame^]

267

"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.

268

"topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form

269

# `projects/<project>/topics/<topic>`. The project needs to be the same

270

# project as this config is in.

Bu Sun Kim

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

[diff] [blame]

271

},

272

},

Bu Sun Kim

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

[diff] [blame^]

273

"size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only

Bu Sun Kim

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

[diff] [blame]

274

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

275

"name": "A String", # Resource name of the repository, of the form

Dan O'Meara

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

[diff] [blame]

276

# `projects/<project>/repos/<repo>`. The repo name may contain slashes.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

277

# eg, `projects/myproject/repos/name/with/slash`

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]

282

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

Sai Cheemalapati

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

[diff] [blame]

283

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

284

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

set.

Args:

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

289

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

Dan O'Meara

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

[diff] [blame]

290

options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.

291

292

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

293

rejected.

294

295

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

296

Policies without any conditional bindings may specify any valid value or

297

leave the field unset.

Sai Cheemalapati

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

[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

Dan O'Meara

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

[diff] [blame]

306

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

307

# controls for Google Cloud resources.

Sai Cheemalapati

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

[diff] [blame]

308

#

309

#

Dan O'Meara

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

[diff] [blame]

310

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

311

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

312

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

313

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

314

# custom role.

Sai Cheemalapati

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

[diff] [blame]

315

#

Dan O'Meara

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

[diff] [blame]

316

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

317

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

318

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

319

# request, the resource, or both.

320

#

321

# **JSON example:**

Sai Cheemalapati

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

[diff] [blame]

322

#

323

# {

Bu Sun Kim

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

[diff] [blame^]

324

# "bindings": [

Sai Cheemalapati

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

[diff] [blame]

325

# {

Bu Sun Kim

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

[diff] [blame^]

326

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

327

# "members": [

328

# "user:mike@example.com",

329

# "group:admins@example.com",

330

# "domain:google.com",

331

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

Sai Cheemalapati

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

[diff] [blame]

332

# ]

333

# },

334

# {

Bu Sun Kim

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

[diff] [blame^]

335

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

336

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

337

# "condition": {

338

# "title": "expirable access",

339

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

340

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

Dan O'Meara

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

[diff] [blame]

341

# }

Sai Cheemalapati

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

[diff] [blame]

342

# }

Dan O'Meara

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

[diff] [blame]

343

# ],

Bu Sun Kim

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

[diff] [blame^]

344

# "etag": "BwWWja0YfJA=",

345

# "version": 3

Sai Cheemalapati

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

[diff] [blame]

346

# }

347

#

Dan O'Meara

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

[diff] [blame]

348

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

353

# - group:admins@example.com

354

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

355

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

356

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

357

# - members:

Dan O'Meara

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

[diff] [blame]

358

# - user:eve@example.com

359

# role: roles/resourcemanager.organizationViewer

360

# condition:

361

# title: expirable access

362

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame^]

363

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

Dan O'Meara

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

[diff] [blame]

364

# - etag: BwWWja0YfJA=

365

# - version: 3

Bu Sun Kim

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

[diff] [blame]

366

#

Sai Cheemalapati

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

[diff] [blame]

367

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

Dan O'Meara

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

[diff] [blame]

368

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

Bu Sun Kim

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

[diff] [blame^]

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

#

377

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

378

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

379

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

380

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

381

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

382

#

383

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

384

# are rejected.

385

#

386

# Any operation that affects conditional role bindings must specify version

387

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

388

#

389

# * Getting a policy that includes a conditional role binding

390

# * Adding a conditional role binding to a policy

391

# * Changing a conditional role binding in a policy

392

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

393

# that includes conditions

394

#

395

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

396

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

397

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

398

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

399

#

400

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

401

# specify any valid version or leave the field unset.

402

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

403

{ # Specifies the audit configuration for a service.

404

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

405

# identities, if any, are exempted from logging.

406

# An AuditConfig must have one or more AuditLogConfigs.

407

#

408

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

409

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

410

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

411

# AuditLogConfig are exempted.

412

#

413

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

419

# "audit_log_configs": [

420

# {

421

# "log_type": "DATA_READ",

422

# "exempted_members": [

423

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

428

# },

429

# {

430

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

436

# "audit_log_configs": [

437

# {

438

# "log_type": "DATA_READ",

439

# },

440

# {

441

# "log_type": "DATA_WRITE",

442

# "exempted_members": [

443

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

452

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

453

# aliya@example.com from DATA_WRITE logging.

454

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

455

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

# Example:

#

# {

# "audit_log_configs": [

460

# {

461

# "log_type": "DATA_READ",

462

# "exempted_members": [

463

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

473

# jose@example.com from DATA_READ logging.

474

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

475

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

476

# permission.

477

# Follows the same format of Binding.members.

"A String",

],

},

],

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

483

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

484

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

485

},

486

],

487

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

488

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

489

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

490

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

Bu Sun Kim

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

[diff] [blame^]

491

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

Dan O'Meara

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

[diff] [blame]

492

# `members` can have the following values:

493

#

494

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

495

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

496

#

497

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

498

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

499

#

500

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

501

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

502

#

503

#

504

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

505

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

506

#

507

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

508

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

509

#

510

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

511

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

512

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

513

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

514

# retains the role in the binding.

515

#

516

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

517

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

518

# deleted. For example,

519

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

520

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

521

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

522

# role in the binding.

523

#

524

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

525

# identifier) representing a Google group that has been recently

526

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

527

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

528

# recovered group retains the role in the binding.

529

#

530

#

531

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

532

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

533

#

Bu Sun Kim

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

[diff] [blame^]

534

"A String",

Dan O'Meara

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

[diff] [blame]

535

],

Bu Sun Kim

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

[diff] [blame^]

536

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

537

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

538

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

Dan O'Meara

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

[diff] [blame]

539

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

540

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

541

# independently.

542

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

543

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

544

#

545

# Example (Comparison):

546

#

Bu Sun Kim

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

[diff] [blame^]

547

# title: "Summary size limit"

548

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

549

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

Dan O'Meara

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

[diff] [blame]

550

#

551

# Example (Equality):

552

#

Bu Sun Kim

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

[diff] [blame^]

553

# title: "Requestor is owner"

554

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

555

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

Dan O'Meara

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

[diff] [blame]

556

#

557

# Example (Logic):

558

#

Bu Sun Kim

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

[diff] [blame^]

559

# title: "Public documents"

560

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

561

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

Dan O'Meara

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

[diff] [blame]

562

#

563

# Example (Data Manipulation):

564

#

Bu Sun Kim

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

[diff] [blame^]

565

# title: "Notification string"

566

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

567

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

Dan O'Meara

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

[diff] [blame]

568

#

569

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

570

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

571

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame^]

572

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

Dan O'Meara

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

[diff] [blame]

573

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

574

# expression.

Bu Sun Kim

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

[diff] [blame^]

575

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

576

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

577

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

578

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

579

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

580

# syntax.

Dan O'Meara

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

[diff] [blame]

581

},

582

},

583

],

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

588

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

589

<pre>Returns all repos belonging to a project. The sizes of the repos are

590

not set by ListRepos. To get the size of a repo, use GetRepo.

Sai Cheemalapati

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

[diff] [blame]

591

592

Args:

593

name: string, The project ID whose repos should be listed. Values are of the form

Dan O'Meara

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

[diff] [blame]

594

`projects/<project>`. (required)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

595

pageToken: string, Resume listing repositories where a prior ListReposResponse

596

left off. This is an opaque token that must be obtained from

Bu Sun Kim

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

[diff] [blame^]

597

a recent, prior ListReposResponse's next_page_token field.

598

pageSize: integer, Maximum number of repositories to return; between 1 and 500.

599

If not set or zero, defaults to 100 at the server.

Sai Cheemalapati

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

[diff] [blame]

600

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

607

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

608

{ # Response for ListRepos. The size is not set in the returned repositories.

Bu Sun Kim

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

[diff] [blame^]

609

"repos": [ # The listed repos.

Sai Cheemalapati

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

[diff] [blame]

610

{ # A repository (or repo) is a Git repository storing versioned source content.

Bu Sun Kim

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

[diff] [blame^]

611

"mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.

Bu Sun Kim

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

[diff] [blame]

612

# Read-only field.

Bu Sun Kim

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

[diff] [blame^]

613

# hosting service, for example GitHub or Bitbucket.

614

"deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.

615

# Removing this key from the other service would deauthorize

616

# Google Cloud Source Repositories from mirroring.

617

"url": "A String", # URL of the main repository at the other hosting service.

618

"webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.

619

# Removing this webhook from the other hosting service will stop

620

# Google Cloud Source Repositories from receiving notifications,

621

# and thereby disabling mirroring.

622

},

623

"url": "A String", # URL to clone the repository from Google Cloud Source Repositories.

624

# Read-only field.

625

"pubsubConfigs": { # How this repository publishes a change in the repository through Cloud

Bu Sun Kim

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

[diff] [blame]

626

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame^]

627

"a_key": { # Configuration to publish a Cloud Pub/Sub message.

628

"serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub

Bu Sun Kim

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

[diff] [blame]

629

# messages. This service account needs to be in the same project as the

630

# PubsubConfig. When added, the caller needs to have

631

# iam.serviceAccounts.actAs permission on this service account. If

632

# unspecified, it defaults to the compute engine default service account.

Bu Sun Kim

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

[diff] [blame^]

633

"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.

634

"topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form

635

# `projects/<project>/topics/<topic>`. The project needs to be the same

636

# project as this config is in.

Bu Sun Kim

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

[diff] [blame]

637

},

638

},

Bu Sun Kim

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

[diff] [blame^]

639

"size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only

Bu Sun Kim

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

[diff] [blame]

640

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

641

"name": "A String", # Resource name of the repository, of the form

Dan O'Meara

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

[diff] [blame]

642

# `projects/<project>/repos/<repo>`. The repo name may contain slashes.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

643

# eg, `projects/myproject/repos/name/with/slash`

Sai Cheemalapati

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

[diff] [blame]

644

},

645

],

Bu Sun Kim

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

[diff] [blame^]

646

"nextPageToken": "A String", # If non-empty, additional repositories exist within the project. These

647

# can be retrieved by including this value in the next ListReposRequest's

648

# page_token field.

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

653

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

654

<pre>Retrieves the next page of results.

655

656

Args:

657

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

658

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

659

660

Returns:

Bu Sun Kim

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

[diff] [blame^]

661

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

662

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]

667

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

Bu Sun Kim

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

[diff] [blame]

668

<pre>Updates information about a repo.

Args:

Dan O'Meara

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

[diff] [blame]

672

`projects/<project>/repos/<repo>`. (required)

673

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

674

The object takes the form of:

675

676

{ # Request for UpdateRepo.

Bu Sun Kim

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

[diff] [blame^]

677

"repo": { # A repository (or repo) is a Git repository storing versioned source content. # The new configuration for the repository.

678

"mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.

Bu Sun Kim

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

[diff] [blame]

679

# Read-only field.

Bu Sun Kim

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

[diff] [blame^]

680

# hosting service, for example GitHub or Bitbucket.

681

"deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.

682

# Removing this key from the other service would deauthorize

683

# Google Cloud Source Repositories from mirroring.

684

"url": "A String", # URL of the main repository at the other hosting service.

685

"webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.

686

# Removing this webhook from the other hosting service will stop

687

# Google Cloud Source Repositories from receiving notifications,

688

# and thereby disabling mirroring.

689

},

690

"url": "A String", # URL to clone the repository from Google Cloud Source Repositories.

691

# Read-only field.

692

"pubsubConfigs": { # How this repository publishes a change in the repository through Cloud

Bu Sun Kim

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

[diff] [blame]

693

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame^]

694

"a_key": { # Configuration to publish a Cloud Pub/Sub message.

695

"serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub

Bu Sun Kim

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

[diff] [blame]

696

# messages. This service account needs to be in the same project as the

697

# PubsubConfig. When added, the caller needs to have

698

# iam.serviceAccounts.actAs permission on this service account. If

699

# unspecified, it defaults to the compute engine default service account.

Bu Sun Kim

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

[diff] [blame^]

700

"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.

701

"topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form

702

# `projects/<project>/topics/<topic>`. The project needs to be the same

703

# project as this config is in.

Bu Sun Kim

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

[diff] [blame]

704

},

705

},

Bu Sun Kim

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

[diff] [blame^]

706

"size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only

Bu Sun Kim

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

[diff] [blame]

707

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

708

"name": "A String", # Resource name of the repository, of the form

Dan O'Meara

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

[diff] [blame]

709

# `projects/<project>/repos/<repo>`. The repo name may contain slashes.

Bu Sun Kim

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

[diff] [blame]

710

# eg, `projects/myproject/repos/name/with/slash`

Bu Sun Kim

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

[diff] [blame]

711

},

Bu Sun Kim

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

[diff] [blame^]

712

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

Bu Sun Kim

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

[diff] [blame]

713

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

# no-op.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

724

725

{ # A repository (or repo) is a Git repository storing versioned source content.

Bu Sun Kim

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

[diff] [blame^]

726

"mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.

Bu Sun Kim

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

[diff] [blame]

727

# Read-only field.

Bu Sun Kim

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

[diff] [blame^]

728

# hosting service, for example GitHub or Bitbucket.

729

"deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.

730

# Removing this key from the other service would deauthorize

731

# Google Cloud Source Repositories from mirroring.

732

"url": "A String", # URL of the main repository at the other hosting service.

733

"webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.

734

# Removing this webhook from the other hosting service will stop

735

# Google Cloud Source Repositories from receiving notifications,

736

# and thereby disabling mirroring.

737

},

738

"url": "A String", # URL to clone the repository from Google Cloud Source Repositories.

739

# Read-only field.

740

"pubsubConfigs": { # How this repository publishes a change in the repository through Cloud

Bu Sun Kim

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

[diff] [blame]

741

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame^]

742

"a_key": { # Configuration to publish a Cloud Pub/Sub message.

743

"serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub

Bu Sun Kim

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

[diff] [blame]

744

# messages. This service account needs to be in the same project as the

745

# PubsubConfig. When added, the caller needs to have

746

# iam.serviceAccounts.actAs permission on this service account. If

747

# unspecified, it defaults to the compute engine default service account.

Bu Sun Kim

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

[diff] [blame^]

748

"messageFormat": "A String", # The format of the Cloud Pub/Sub messages.

749

"topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form

750

# `projects/<project>/topics/<topic>`. The project needs to be the same

751

# project as this config is in.

Bu Sun Kim

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

[diff] [blame]

752

},

753

},

Bu Sun Kim

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

[diff] [blame^]

754

"size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only

Bu Sun Kim

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

[diff] [blame]

755

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

756

"name": "A String", # Resource name of the repository, of the form

Dan O'Meara

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

[diff] [blame]

757

# `projects/<project>/repos/<repo>`. The repo name may contain slashes.

Bu Sun Kim

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

[diff] [blame]

758

# eg, `projects/myproject/repos/name/with/slash`

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]

763

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

Sai Cheemalapati

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

[diff] [blame]

764

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

existing policy.

Args:

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

769

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

Dan O'Meara

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

[diff] [blame]

770

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

771

The object takes the form of:

772

773

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame^]

774

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

775

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

776

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

777

# might reject them.

Dan O'Meara

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

[diff] [blame]

778

# controls for Google Cloud resources.

Sai Cheemalapati

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

[diff] [blame]

779

#

780

#

Dan O'Meara

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

[diff] [blame]

781

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

782

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

783

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

784

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

785

# custom role.

Sai Cheemalapati

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

[diff] [blame]

786

#

Dan O'Meara

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

[diff] [blame]

787

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

788

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

789

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

790

# request, the resource, or both.

791

#

792

# **JSON example:**

Sai Cheemalapati

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

[diff] [blame]

793

#

794

# {

Bu Sun Kim

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

[diff] [blame^]

795

# "bindings": [

Sai Cheemalapati

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

[diff] [blame]

796

# {

Bu Sun Kim

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

[diff] [blame^]

797

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

798

# "members": [

799

# "user:mike@example.com",

800

# "group:admins@example.com",

801

# "domain:google.com",

802

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

Sai Cheemalapati

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

[diff] [blame]

803

# ]

804

# },

805

# {

Bu Sun Kim

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

[diff] [blame^]

806

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

807

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

808

# "condition": {

809

# "title": "expirable access",

810

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

811

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

Dan O'Meara

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

[diff] [blame]

812

# }

Sai Cheemalapati

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

[diff] [blame]

813

# }

Dan O'Meara

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

[diff] [blame]

814

# ],

Bu Sun Kim

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

[diff] [blame^]

815

# "etag": "BwWWja0YfJA=",

816

# "version": 3

Sai Cheemalapati

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

[diff] [blame]

817

# }

818

#

Dan O'Meara

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

[diff] [blame]

819

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

824

# - group:admins@example.com

825

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

826

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

827

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

828

# - members:

Dan O'Meara

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

[diff] [blame]

829

# - user:eve@example.com

830

# role: roles/resourcemanager.organizationViewer

831

# condition:

832

# title: expirable access

833

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame^]

834

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

Dan O'Meara

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

[diff] [blame]

835

# - etag: BwWWja0YfJA=

836

# - version: 3

Bu Sun Kim

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

[diff] [blame]

837

#

Sai Cheemalapati

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

[diff] [blame]

838

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

Dan O'Meara

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

[diff] [blame]

839

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

Bu Sun Kim

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

[diff] [blame^]

840

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

841

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

842

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

843

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

844

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

845

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

846

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

847

#

848

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

849

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

850

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

851

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

852

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

853

#

854

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

855

# are rejected.

856

#

857

# Any operation that affects conditional role bindings must specify version

858

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

859

#

860

# * Getting a policy that includes a conditional role binding

861

# * Adding a conditional role binding to a policy

862

# * Changing a conditional role binding in a policy

863

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

864

# that includes conditions

865

#

866

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

867

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

868

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

869

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

870

#

871

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

872

# specify any valid version or leave the field unset.

873

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

874

{ # Specifies the audit configuration for a service.

875

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

876

# identities, if any, are exempted from logging.

877

# An AuditConfig must have one or more AuditLogConfigs.

878

#

879

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

880

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

881

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

882

# AuditLogConfig are exempted.

883

#

884

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

890

# "audit_log_configs": [

891

# {

892

# "log_type": "DATA_READ",

893

# "exempted_members": [

894

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

899

# },

900

# {

901

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

907

# "audit_log_configs": [

908

# {

909

# "log_type": "DATA_READ",

910

# },

911

# {

912

# "log_type": "DATA_WRITE",

913

# "exempted_members": [

914

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

923

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

924

# aliya@example.com from DATA_WRITE logging.

925

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

926

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

# Example:

#

# {

# "audit_log_configs": [

931

# {

932

# "log_type": "DATA_READ",

933

# "exempted_members": [

934

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

944

# jose@example.com from DATA_READ logging.

945

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

946

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

947

# permission.

948

# Follows the same format of Binding.members.

"A String",

],

},

],

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

954

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

955

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

956

},

957

],

958

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

959

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

960

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

961

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

Bu Sun Kim

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

[diff] [blame^]

962

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

Dan O'Meara

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

[diff] [blame]

963

# `members` can have the following values:

964

#

965

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

966

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

967

#

968

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

969

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

970

#

971

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

972

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

973

#

974

#

975

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

976

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

977

#

978

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

979

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

980

#

981

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

982

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

983

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

984

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

985

# retains the role in the binding.

986

#

987

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

988

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

989

# deleted. For example,

990

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

991

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

992

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

993

# role in the binding.

994

#

995

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

996

# identifier) representing a Google group that has been recently

997

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

998

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

999

# recovered group retains the role in the binding.

1000

#

1001

#

1002

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

1003

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

1004

#

Bu Sun Kim

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

[diff] [blame^]

1005

"A String",

Dan O'Meara

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

[diff] [blame]

1006

],

Bu Sun Kim

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

[diff] [blame^]

1007

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

1008

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

1009

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

Dan O'Meara

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

[diff] [blame]

1010

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

1011

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

1012

# independently.

1013

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

1014

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

1015

#

1016

# Example (Comparison):

1017

#

Bu Sun Kim

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

[diff] [blame^]

1018

# title: "Summary size limit"

1019

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

1020

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

Dan O'Meara

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

[diff] [blame]

1021

#

1022

# Example (Equality):

1023

#

Bu Sun Kim

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

[diff] [blame^]

1024

# title: "Requestor is owner"

1025

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

1026

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

Dan O'Meara

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

[diff] [blame]

1027

#

1028

# Example (Logic):

1029

#

Bu Sun Kim

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

[diff] [blame^]

1030

# title: "Public documents"

1031

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

1032

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

Dan O'Meara

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

[diff] [blame]

1033

#

1034

# Example (Data Manipulation):

1035

#

Bu Sun Kim

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

[diff] [blame^]

1036

# title: "Notification string"

1037

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

1038

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

Dan O'Meara

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

[diff] [blame]

1039

#

1040

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

1041

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

1042

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame^]

1043

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

Dan O'Meara

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

[diff] [blame]

1044

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

1045

# expression.

Bu Sun Kim

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

[diff] [blame^]

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

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

1049

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

1050

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

1051

# syntax.

Dan O'Meara

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

[diff] [blame]

1052

},

1053

},

1054

],

Sai Cheemalapati

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

[diff] [blame]

1055

},

Bu Sun Kim

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

[diff] [blame^]

1056

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

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

1057

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

1058

# following default mask is used:

Dan O'Meara

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

[diff] [blame]

1059

#

Bu Sun Kim

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

[diff] [blame^]

1060

# `paths: "bindings, etag"`

Sai Cheemalapati

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

[diff] [blame]

1061

}

1062

1063

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1070

Dan O'Meara

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

[diff] [blame]

1071

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

1072

# controls for Google Cloud resources.

Sai Cheemalapati

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

[diff] [blame]

1073

#

1074

#

Dan O'Meara

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

[diff] [blame]

1075

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

1076

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

1077

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

1078

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

1079

# custom role.

Sai Cheemalapati

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

[diff] [blame]

1080

#

Dan O'Meara

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

[diff] [blame]

1081

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

1082

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

1083

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

1084

# request, the resource, or both.

1085

#

1086

# **JSON example:**

Sai Cheemalapati

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

[diff] [blame]

1087

#

1088

# {

Bu Sun Kim

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

[diff] [blame^]

1089

# "bindings": [

Sai Cheemalapati

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

[diff] [blame]

1090

# {

Bu Sun Kim

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

[diff] [blame^]

1091

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

1092

# "members": [

1093

# "user:mike@example.com",

1094

# "group:admins@example.com",

1095

# "domain:google.com",

1096

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

Sai Cheemalapati

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

[diff] [blame]

1097

# ]

1098

# },

1099

# {

Bu Sun Kim

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

[diff] [blame^]

1100

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

1101

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

1102

# "condition": {

1103

# "title": "expirable access",

1104

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

1105

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

Dan O'Meara

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

[diff] [blame]

1106

# }

Sai Cheemalapati

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

[diff] [blame]

1107

# }

Dan O'Meara

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

[diff] [blame]

1108

# ],

Bu Sun Kim

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

[diff] [blame^]

1109

# "etag": "BwWWja0YfJA=",

1110

# "version": 3

Sai Cheemalapati

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

[diff] [blame]

1111

# }

1112

#

Dan O'Meara

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

[diff] [blame]

1113

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1118

# - group:admins@example.com

1119

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1120

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

1121

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1122

# - members:

Dan O'Meara

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

[diff] [blame]

1123

# - user:eve@example.com

1124

# role: roles/resourcemanager.organizationViewer

1125

# condition:

1126

# title: expirable access

1127

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame^]

1128

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

Dan O'Meara

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

[diff] [blame]

1129

# - etag: BwWWja0YfJA=

1130

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1131

#

Sai Cheemalapati

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

[diff] [blame]

1132

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

Dan O'Meara

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

[diff] [blame]

1133

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

Bu Sun Kim

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

[diff] [blame^]

1134

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

1135

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

1136

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

1137

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

1138

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

1139

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

1140

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

1141

#

1142

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

1143

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

1144

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

1145

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

1146

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

1147

#

1148

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

1149

# are rejected.

1150

#

1151

# Any operation that affects conditional role bindings must specify version

1152

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

1153

#

1154

# * Getting a policy that includes a conditional role binding

1155

# * Adding a conditional role binding to a policy

1156

# * Changing a conditional role binding in a policy

1157

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

1158

# that includes conditions

1159

#

1160

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

1161

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

1162

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

1163

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

1164

#

1165

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

1166

# specify any valid version or leave the field unset.

1167

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

1168

{ # Specifies the audit configuration for a service.

1169

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

1170

# identities, if any, are exempted from logging.

1171

# An AuditConfig must have one or more AuditLogConfigs.

1172

#

1173

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

1174

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

1175

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

1176

# AuditLogConfig are exempted.

1177

#

1178

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1184

# "audit_log_configs": [

1185

# {

1186

# "log_type": "DATA_READ",

1187

# "exempted_members": [

1188

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1193

# },

1194

# {

1195

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

1201

# "audit_log_configs": [

1202

# {

1203

# "log_type": "DATA_READ",

1204

# },

1205

# {

1206

# "log_type": "DATA_WRITE",

1207

# "exempted_members": [

1208

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

1217

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

1218

# aliya@example.com from DATA_WRITE logging.

1219

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

1220

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

# Example:

#

# {

# "audit_log_configs": [

1225

# {

1226

# "log_type": "DATA_READ",

1227

# "exempted_members": [

1228

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

1238

# jose@example.com from DATA_READ logging.

1239

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

1240

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

1241

# permission.

1242

# Follows the same format of Binding.members.

"A String",

],

},

],

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

1248

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

1249

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

1250

},

1251

],

1252

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

1253

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

1254

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

1255

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

Bu Sun Kim

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

[diff] [blame^]

1256

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

Dan O'Meara

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

[diff] [blame]

1257

# `members` can have the following values:

1258

#

1259

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

1260

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

1261

#

1262

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

1263

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

1264

#

1265

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

1266

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

1267

#

1268

#

1269

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

1270

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

1271

#

1272

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

1273

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

1274

#

1275

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

1276

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

1277

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

1278

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

1279

# retains the role in the binding.

1280

#

1281

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

1282

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

1283

# deleted. For example,

1284

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

1285

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

1286

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

1287

# role in the binding.

1288

#

1289

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

1290

# identifier) representing a Google group that has been recently

1291

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

1292

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

1293

# recovered group retains the role in the binding.

1294

#

1295

#

1296

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

1297

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

1298

#

Bu Sun Kim

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

[diff] [blame^]

1299

"A String",

Dan O'Meara

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

[diff] [blame]

1300

],

Bu Sun Kim

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

[diff] [blame^]

1301

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

1302

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

1303

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

Dan O'Meara

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

[diff] [blame]

1304

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

1305

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

1306

# independently.

1307

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

1308

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

1309

#

1310

# Example (Comparison):

1311

#

Bu Sun Kim

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

[diff] [blame^]

1312

# title: "Summary size limit"

1313

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

1314

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

Dan O'Meara

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

[diff] [blame]

1315

#

1316

# Example (Equality):

1317

#

Bu Sun Kim

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

[diff] [blame^]

1318

# title: "Requestor is owner"

1319

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

1320

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

Dan O'Meara

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

[diff] [blame]

1321

#

1322

# Example (Logic):

1323

#

Bu Sun Kim

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

[diff] [blame^]

1324

# title: "Public documents"

1325

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

1326

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

Dan O'Meara

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

[diff] [blame]

1327

#

1328

# Example (Data Manipulation):

1329

#

Bu Sun Kim

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

[diff] [blame^]

1330

# title: "Notification string"

1331

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

1332

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

Dan O'Meara

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

[diff] [blame]

1333

#

1334

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

1335

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

1336

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame^]

1337

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

Dan O'Meara

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

[diff] [blame]

1338

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

1339

# expression.

Bu Sun Kim

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

[diff] [blame^]

1340

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

1341

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

1342

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

1343

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

1344

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

1345

# syntax.

Dan O'Meara

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

[diff] [blame]

1346

},

1347

},

1348

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

1354

<pre>Synchronize a connected repo.

1355

1356

The response contains SyncRepoMetadata in the metadata field.

Args:

Dan O'Meara

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

[diff] [blame]

1360

`projects/<project>/repos/<repo>`. (required)

Bu Sun Kim

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

[diff] [blame]

1361

body: object, The request body.

1362

The object takes the form of:

1363

1364

{ # Request for SyncRepo.

1365

}

1366

1367

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1374

1375

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

1376

# network API call.

Bu Sun Kim

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

[diff] [blame^]

1377

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

Bu Sun Kim

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

[diff] [blame]

1378

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

1379

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

1380

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

Bu Sun Kim

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

[diff] [blame^]

1381

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

Bu Sun Kim

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

[diff] [blame]

1382

},

Bu Sun Kim

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

[diff] [blame^]

1383

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

Dan O'Meara

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

[diff] [blame]

1384

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

1385

# available.

Bu Sun Kim

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

[diff] [blame^]

1386

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

Dan O'Meara

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

[diff] [blame]

1387

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

1388

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

1389

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

1390

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

1391

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

1392

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

1393

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame^]

1394

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

Dan O'Meara

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

[diff] [blame]

1395

},

Bu Sun Kim

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

[diff] [blame^]

1396

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

Dan O'Meara

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

[diff] [blame]

1397

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

1398

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

Bu Sun Kim

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

[diff] [blame^]

1399

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

1400

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

1401

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

1402

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

1403

#

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1410

# message types for APIs to use.

1411

{

1412

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

1413

},

1414

],

1415

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

1416

},

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]

1421

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

Sai Cheemalapati

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

[diff] [blame]

1422

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

1423

If the resource does not exist, this will return an empty set of

1424

permissions, not a NOT_FOUND error.

1425

1426

Args:

1427

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

1428

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

Dan O'Meara

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

[diff] [blame]

1429

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1430

The object takes the form of:

1431

1432

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame^]

1433

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

1434

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

Sai Cheemalapati

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

[diff] [blame]

1435

# information see

1436

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

Bu Sun Kim

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

[diff] [blame^]

1437

"A String",

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:

1448

1449

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame^]

1450

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

Sai Cheemalapati

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

[diff] [blame]

1451

# allowed.

Bu Sun Kim

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

[diff] [blame^]

1452

"A String",

Sai Cheemalapati