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-07-22 17:02:09 -0700

[diff] [blame^]

90

<code><a href="#list">list(name, pageSize=None, pageToken=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

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

Bu Sun Kim

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

[diff] [blame]

123

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame]

124

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

Bu Sun Kim

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

[diff] [blame]

125

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

126

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

127

# project as this config is in.

Bu Sun Kim

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

[diff] [blame^]

128

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

Bu Sun Kim

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

[diff] [blame]

129

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

130

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

131

# PubsubConfig. When added, the caller needs to have

132

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

133

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

134

},

135

},

Bu Sun Kim

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

[diff] [blame^]

136

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

137

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

138

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

Bu Sun Kim

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

[diff] [blame]

139

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

140

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

141

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

142

# Read-only field.

143

# hosting service, for example GitHub or Bitbucket.

144

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

145

# Removing this webhook from the other hosting service will stop

146

# Google Cloud Source Repositories from receiving notifications,

147

# and thereby disabling mirroring.

148

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

149

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

150

# Removing this key from the other service would deauthorize

151

# Google Cloud Source Repositories from mirroring.

152

},

153

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

154

# Read-only field.

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

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

Bu Sun Kim

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

[diff] [blame]

167

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame]

168

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

Bu Sun Kim

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

[diff] [blame]

169

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

170

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

171

# project as this config is in.

Bu Sun Kim

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

[diff] [blame^]

172

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

Bu Sun Kim

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

[diff] [blame]

173

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

174

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

175

# PubsubConfig. When added, the caller needs to have

176

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

177

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

178

},

179

},

Bu Sun Kim

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

[diff] [blame^]

180

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

181

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

182

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

Bu Sun Kim

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

[diff] [blame]

183

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

184

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

185

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

186

# Read-only field.

187

# hosting service, for example GitHub or Bitbucket.

188

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

189

# Removing this webhook from the other hosting service will stop

190

# Google Cloud Source Repositories from receiving notifications,

191

# and thereby disabling mirroring.

192

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

193

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

194

# Removing this key from the other service would deauthorize

195

# Google Cloud Source Repositories from mirroring.

196

},

197

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

198

# Read-only field.

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

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

Bu Sun Kim

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

[diff] [blame]

246

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame]

247

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

Bu Sun Kim

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

[diff] [blame]

248

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

249

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

250

# project as this config is in.

Bu Sun Kim

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

[diff] [blame^]

251

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

Bu Sun Kim

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

[diff] [blame]

252

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

253

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

254

# PubsubConfig. When added, the caller needs to have

255

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

256

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

257

},

258

},

Bu Sun Kim

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

[diff] [blame^]

259

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

260

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

261

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

Bu Sun Kim

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

[diff] [blame]

262

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

263

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

264

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

265

# Read-only field.

266

# hosting service, for example GitHub or Bitbucket.

267

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

268

# Removing this webhook from the other hosting service will stop

269

# Google Cloud Source Repositories from receiving notifications,

270

# and thereby disabling mirroring.

271

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

272

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

273

# Removing this key from the other service would deauthorize

274

# Google Cloud Source Repositories from mirroring.

275

},

276

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

277

# Read-only field.

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.

Bu Sun Kim

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

[diff] [blame^]

298

299

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

300

[IAM

301

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

Sai Cheemalapati

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

[diff] [blame]

302

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

309

Dan O'Meara

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

[diff] [blame]

310

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

311

# controls for Google Cloud resources.

Sai Cheemalapati

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

[diff] [blame]

312

#

313

#

Dan O'Meara

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

[diff] [blame]

314

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

315

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

316

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

317

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

318

# custom role.

Sai Cheemalapati

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

[diff] [blame]

319

#

Bu Sun Kim

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

[diff] [blame^]

320

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

321

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

322

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

323

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

324

# resources support conditions in their IAM policies, see the

325

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

Dan O'Meara

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

[diff] [blame]

326

#

327

# **JSON example:**

Sai Cheemalapati

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

[diff] [blame]

328

#

329

# {

Bu Sun Kim

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

[diff] [blame]

330

# "bindings": [

Sai Cheemalapati

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

[diff] [blame]

331

# {

Bu Sun Kim

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

[diff] [blame]

332

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

333

# "members": [

334

# "user:mike@example.com",

335

# "group:admins@example.com",

336

# "domain:google.com",

337

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

Sai Cheemalapati

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

[diff] [blame]

338

# ]

339

# },

340

# {

Bu Sun Kim

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

[diff] [blame]

341

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

Bu Sun Kim

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

[diff] [blame^]

342

# "members": [

343

# "user:eve@example.com"

344

# ],

Bu Sun Kim

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

[diff] [blame]

345

# "condition": {

346

# "title": "expirable access",

347

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

348

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

Dan O'Meara

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

[diff] [blame]

349

# }

Sai Cheemalapati

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

[diff] [blame]

350

# }

Dan O'Meara

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

[diff] [blame]

351

# ],

Bu Sun Kim

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

[diff] [blame]

352

# "etag": "BwWWja0YfJA=",

353

# "version": 3

Sai Cheemalapati

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

[diff] [blame]

354

# }

355

#

Dan O'Meara

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

[diff] [blame]

356

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

361

# - group:admins@example.com

362

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

363

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

364

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

365

# - members:

Dan O'Meara

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

[diff] [blame]

366

# - user:eve@example.com

367

# role: roles/resourcemanager.organizationViewer

368

# condition:

369

# title: expirable access

370

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

371

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

Dan O'Meara

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

[diff] [blame]

372

# - etag: BwWWja0YfJA=

373

# - version: 3

Bu Sun Kim

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

[diff] [blame]

374

#

Sai Cheemalapati

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

[diff] [blame]

375

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

Dan O'Meara

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

[diff] [blame]

376

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

Bu Sun Kim

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

[diff] [blame]

377

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

378

{ # Specifies the audit configuration for a service.

379

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

380

# identities, if any, are exempted from logging.

381

# An AuditConfig must have one or more AuditLogConfigs.

382

#

383

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

384

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

385

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

386

# AuditLogConfig are exempted.

387

#

388

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

394

# "audit_log_configs": [

395

# {

396

# "log_type": "DATA_READ",

397

# "exempted_members": [

398

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

403

# },

404

# {

405

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

411

# "audit_log_configs": [

412

# {

413

# "log_type": "DATA_READ",

414

# },

415

# {

416

# "log_type": "DATA_WRITE",

417

# "exempted_members": [

418

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

427

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

428

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

429

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

430

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

431

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

Bu Sun Kim

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

[diff] [blame]

432

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

433

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

# Example:

#

# {

# "audit_log_configs": [

438

# {

439

# "log_type": "DATA_READ",

440

# "exempted_members": [

441

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

451

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame^]

452

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

Bu Sun Kim

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

[diff] [blame]

453

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

454

# permission.

455

# Follows the same format of Binding.members.

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame]

460

},

461

],

Bu Sun Kim

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

[diff] [blame^]

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

#

470

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

471

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

472

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

473

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

474

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

475

#

476

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

477

# are rejected.

478

#

479

# Any operation that affects conditional role bindings must specify version

480

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

481

#

482

# * Getting a policy that includes a conditional role binding

483

# * Adding a conditional role binding to a policy

484

# * Changing a conditional role binding in a policy

485

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

486

# that includes conditions

487

#

488

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

489

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

490

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

491

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

492

#

493

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

494

# specify any valid version or leave the field unset.

495

#

496

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

497

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

Bu Sun Kim

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

[diff] [blame]

498

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

499

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

500

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

501

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

Bu Sun Kim

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

[diff] [blame]

502

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

503

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

Bu Sun Kim

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

[diff] [blame]

504

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

505

# `members` can have the following values:

506

#

507

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

508

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

509

#

510

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

511

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

512

#

513

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

514

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

515

#

516

#

517

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

518

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

519

#

520

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

521

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

522

#

523

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

524

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

525

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

526

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

527

# retains the role in the binding.

528

#

529

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

530

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

531

# deleted. For example,

532

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

533

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

534

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

535

# role in the binding.

536

#

537

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

538

# identifier) representing a Google group that has been recently

539

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

540

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

541

# recovered group retains the role in the binding.

542

#

543

#

544

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

545

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

546

#

547

"A String",

548

],

Bu Sun Kim

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

[diff] [blame^]

549

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

550

#

551

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

552

# current request.

553

#

554

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

555

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

556

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

557

#

558

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

559

# [IAM

560

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

561

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

562

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

563

#

564

# Example (Comparison):

565

#

566

# title: "Summary size limit"

567

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

568

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

569

#

570

# Example (Equality):

571

#

572

# title: "Requestor is owner"

573

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

574

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

#

# Example (Logic):

#

# title: "Public documents"

579

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

580

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

581

#

582

# Example (Data Manipulation):

583

#

584

# title: "Notification string"

585

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

586

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

587

#

588

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

589

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

590

# documentation for additional information.

591

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

592

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

593

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

594

# syntax.

595

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

596

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

597

# expression.

598

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

599

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

600

},

Dan O'Meara

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

[diff] [blame]

601

},

602

],

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

607

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

Sai Cheemalapati

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

[diff] [blame]

608

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

609

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

Sai Cheemalapati

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

[diff] [blame]

610

611

Args:

612

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]

613

`projects/<project>`. (required)

Bu Sun Kim

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

[diff] [blame^]

614

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

615

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

Sai Cheemalapati

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

[diff] [blame]

616

pageToken: string, Resume listing repositories where a prior ListReposResponse

617

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

Bu Sun Kim

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

[diff] [blame]

618

a recent, prior ListReposResponse's next_page_token field.

Sai Cheemalapati

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

[diff] [blame]

619

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

626

Sai Cheemalapati

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

[diff] [blame]

627

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

Bu Sun Kim

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

[diff] [blame]

628

"repos": [ # The listed repos.

Sai Cheemalapati

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

[diff] [blame]

629

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

Bu Sun Kim

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

[diff] [blame]

630

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

Bu Sun Kim

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

[diff] [blame]

631

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame]

632

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

Bu Sun Kim

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

[diff] [blame]

633

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

634

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

635

# project as this config is in.

Bu Sun Kim

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

[diff] [blame^]

636

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

Bu Sun Kim

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

[diff] [blame]

637

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

638

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

639

# PubsubConfig. When added, the caller needs to have

640

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

641

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

642

},

643

},

Bu Sun Kim

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

[diff] [blame^]

644

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

645

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

646

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

Bu Sun Kim

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

[diff] [blame]

647

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

648

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

649

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

650

# Read-only field.

651

# hosting service, for example GitHub or Bitbucket.

652

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

653

# Removing this webhook from the other hosting service will stop

654

# Google Cloud Source Repositories from receiving notifications,

655

# and thereby disabling mirroring.

656

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

657

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

658

# Removing this key from the other service would deauthorize

659

# Google Cloud Source Repositories from mirroring.

660

},

661

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

662

# Read-only field.

Sai Cheemalapati

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

[diff] [blame]

663

},

664

],

Bu Sun Kim

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

[diff] [blame]

665

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

666

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

667

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

672

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

673

<pre>Retrieves the next page of results.

674

675

Args:

676

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

677

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

678

679

Returns:

Bu Sun Kim

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

[diff] [blame]

680

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

Sai Cheemalapati

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

[diff] [blame]

681

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]

686

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

687

<pre>Updates information about a repo.

Args:

Dan O'Meara

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

[diff] [blame]

691

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

692

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

693

The object takes the form of:

694

695

{ # Request for UpdateRepo.

Bu Sun Kim

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

[diff] [blame]

696

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

Bu Sun Kim

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

[diff] [blame]

697

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

Bu Sun Kim

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

[diff] [blame]

698

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame]

699

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

Bu Sun Kim

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

[diff] [blame]

700

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

701

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

702

# project as this config is in.

Bu Sun Kim

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

[diff] [blame^]

703

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

Bu Sun Kim

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

[diff] [blame]

704

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

705

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

706

# PubsubConfig. When added, the caller needs to have

707

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

708

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

709

},

710

},

Bu Sun Kim

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

[diff] [blame^]

711

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

712

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

713

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

Bu Sun Kim

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

[diff] [blame]

714

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

715

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

716

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

717

# Read-only field.

718

# hosting service, for example GitHub or Bitbucket.

719

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

720

# Removing this webhook from the other hosting service will stop

721

# Google Cloud Source Repositories from receiving notifications,

722

# and thereby disabling mirroring.

723

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

724

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

725

# Removing this key from the other service would deauthorize

726

# Google Cloud Source Repositories from mirroring.

727

},

728

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

729

# Read-only field.

Bu Sun Kim

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

[diff] [blame]

730

},

Bu Sun Kim

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

[diff] [blame^]

731

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

732

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

733

# no-op.

Bu Sun Kim

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

[diff] [blame]

734

}

735

736

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

743

744

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

Bu Sun Kim

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

[diff] [blame]

745

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

Bu Sun Kim

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

[diff] [blame]

746

# Pub/Sub. Keyed by the topic names.

Bu Sun Kim

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

[diff] [blame]

747

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

Bu Sun Kim

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

[diff] [blame]

748

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

749

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

750

# project as this config is in.

Bu Sun Kim

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

[diff] [blame^]

751

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

Bu Sun Kim

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

[diff] [blame]

752

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

753

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

754

# PubsubConfig. When added, the caller needs to have

755

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

756

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

757

},

758

},

Bu Sun Kim

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

[diff] [blame^]

759

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

760

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

761

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

Bu Sun Kim

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

[diff] [blame]

762

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

763

# returned by GetRepo.

Bu Sun Kim

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

[diff] [blame^]

764

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

765

# Read-only field.

766

# hosting service, for example GitHub or Bitbucket.

767

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

768

# Removing this webhook from the other hosting service will stop

769

# Google Cloud Source Repositories from receiving notifications,

770

# and thereby disabling mirroring.

771

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

772

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

773

# Removing this key from the other service would deauthorize

774

# Google Cloud Source Repositories from mirroring.

775

},

776

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

777

# Read-only field.

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]

782

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

Sai Cheemalapati

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

[diff] [blame]

783

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

788

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

Dan O'Meara

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

[diff] [blame]

789

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

790

The object takes the form of:

791

792

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame^]

793

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

794

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

795

# following default mask is used:

796

#

797

# `paths: "bindings, etag"`

Bu Sun Kim

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

[diff] [blame]

798

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

799

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

800

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

801

# might reject them.

Dan O'Meara

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

[diff] [blame]

802

# controls for Google Cloud resources.

Sai Cheemalapati

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

[diff] [blame]

803

#

804

#

Dan O'Meara

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

[diff] [blame]

805

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

806

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

807

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

808

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

809

# custom role.

Sai Cheemalapati

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

[diff] [blame]

810

#

Bu Sun Kim

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

[diff] [blame^]

811

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

812

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

813

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

814

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

815

# resources support conditions in their IAM policies, see the

816

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

Dan O'Meara

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

[diff] [blame]

817

#

818

# **JSON example:**

Sai Cheemalapati

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

[diff] [blame]

819

#

820

# {

Bu Sun Kim

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

[diff] [blame]

821

# "bindings": [

Sai Cheemalapati

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

[diff] [blame]

822

# {

Bu Sun Kim

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

[diff] [blame]

823

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

824

# "members": [

825

# "user:mike@example.com",

826

# "group:admins@example.com",

827

# "domain:google.com",

828

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

Sai Cheemalapati

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

[diff] [blame]

829

# ]

830

# },

831

# {

Bu Sun Kim

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

[diff] [blame]

832

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

Bu Sun Kim

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

[diff] [blame^]

833

# "members": [

834

# "user:eve@example.com"

835

# ],

Bu Sun Kim

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

[diff] [blame]

836

# "condition": {

837

# "title": "expirable access",

838

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

839

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

Dan O'Meara

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

[diff] [blame]

840

# }

Sai Cheemalapati

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

[diff] [blame]

841

# }

Dan O'Meara

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

[diff] [blame]

842

# ],

Bu Sun Kim

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

[diff] [blame]

843

# "etag": "BwWWja0YfJA=",

844

# "version": 3

Sai Cheemalapati

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

[diff] [blame]

845

# }

846

#

Dan O'Meara

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

[diff] [blame]

847

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

852

# - group:admins@example.com

853

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

854

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

855

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

856

# - members:

Dan O'Meara

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

[diff] [blame]

857

# - user:eve@example.com

858

# role: roles/resourcemanager.organizationViewer

859

# condition:

860

# title: expirable access

861

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

862

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

Dan O'Meara

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

[diff] [blame]

863

# - etag: BwWWja0YfJA=

864

# - version: 3

Bu Sun Kim

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

[diff] [blame]

865

#

Sai Cheemalapati

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

[diff] [blame]

866

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

Dan O'Meara

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

[diff] [blame]

867

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

Bu Sun Kim

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

[diff] [blame]

868

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

869

{ # Specifies the audit configuration for a service.

870

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

871

# identities, if any, are exempted from logging.

872

# An AuditConfig must have one or more AuditLogConfigs.

873

#

874

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

875

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

876

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

877

# AuditLogConfig are exempted.

878

#

879

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

885

# "audit_log_configs": [

886

# {

887

# "log_type": "DATA_READ",

888

# "exempted_members": [

889

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

894

# },

895

# {

896

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

902

# "audit_log_configs": [

903

# {

904

# "log_type": "DATA_READ",

905

# },

906

# {

907

# "log_type": "DATA_WRITE",

908

# "exempted_members": [

909

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

918

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

919

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

920

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

921

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

922

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

Bu Sun Kim

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

[diff] [blame]

923

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

924

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

# Example:

#

# {

# "audit_log_configs": [

929

# {

930

# "log_type": "DATA_READ",

931

# "exempted_members": [

932

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

942

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame^]

943

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

Bu Sun Kim

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

[diff] [blame]

944

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

945

# permission.

946

# Follows the same format of Binding.members.

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame]

951

},

952

],

Bu Sun Kim

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

[diff] [blame^]

953

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

954

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

955

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

956

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

957

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

958

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

959

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

960

#

961

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

962

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

963

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

964

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

965

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

966

#

967

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

968

# are rejected.

969

#

970

# Any operation that affects conditional role bindings must specify version

971

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

972

#

973

# * Getting a policy that includes a conditional role binding

974

# * Adding a conditional role binding to a policy

975

# * Changing a conditional role binding in a policy

976

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

977

# that includes conditions

978

#

979

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

980

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

981

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

982

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

983

#

984

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

985

# specify any valid version or leave the field unset.

986

#

987

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

988

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

Bu Sun Kim

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

[diff] [blame]

989

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

990

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

991

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

992

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

Bu Sun Kim

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

[diff] [blame]

993

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

994

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

Bu Sun Kim

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

[diff] [blame]

995

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

996

# `members` can have the following values:

997

#

998

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

999

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

1000

#

1001

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

1002

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

1003

#

1004

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

1005

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

1006

#

1007

#

1008

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

1009

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

1010

#

1011

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

1012

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

1013

#

1014

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

1015

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

1016

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

1017

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

1018

# retains the role in the binding.

1019

#

1020

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

1021

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

1022

# deleted. For example,

1023

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

1024

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

1025

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

1026

# role in the binding.

1027

#

1028

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

1029

# identifier) representing a Google group that has been recently

1030

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

1031

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

1032

# recovered group retains the role in the binding.

1033

#

1034

#

1035

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

1036

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

1037

#

1038

"A String",

1039

],

Bu Sun Kim

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

[diff] [blame^]

1040

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

1041

#

1042

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

1043

# current request.

1044

#

1045

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

1046

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

1047

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

1048

#

1049

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

1050

# [IAM

1051

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

1052

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

1053

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

1054

#

1055

# Example (Comparison):

1056

#

1057

# title: "Summary size limit"

1058

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

1059

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

1060

#

1061

# Example (Equality):

1062

#

1063

# title: "Requestor is owner"

1064

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

1065

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

#

# Example (Logic):

#

# title: "Public documents"

1070

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

1071

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

1072

#

1073

# Example (Data Manipulation):

1074

#

1075

# title: "Notification string"

1076

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

1077

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

1078

#

1079

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

1080

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

1081

# documentation for additional information.

1082

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

1083

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

1084

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

1085

# syntax.

1086

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

1087

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

1088

# expression.

1089

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

1090

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

1091

},

Dan O'Meara

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

[diff] [blame]

1092

},

1093

],

Sai Cheemalapati

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

[diff] [blame]

1094

},

Sai Cheemalapati

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

[diff] [blame]

1095

}

1096

1097

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1104

Dan O'Meara

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

[diff] [blame]

1105

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

1106

# controls for Google Cloud resources.

Sai Cheemalapati

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

[diff] [blame]

1107

#

1108

#

Dan O'Meara

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

[diff] [blame]

1109

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

1110

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

1111

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

1112

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

1113

# custom role.

Sai Cheemalapati

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

[diff] [blame]

1114

#

Bu Sun Kim

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

[diff] [blame^]

1115

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

1116

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

1117

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

1118

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

1119

# resources support conditions in their IAM policies, see the

1120

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

Dan O'Meara

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

[diff] [blame]

1121

#

1122

# **JSON example:**

Sai Cheemalapati

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

[diff] [blame]

1123

#

1124

# {

Bu Sun Kim

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

[diff] [blame]

1125

# "bindings": [

Sai Cheemalapati

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

[diff] [blame]

1126

# {

Bu Sun Kim

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

[diff] [blame]

1127

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

1128

# "members": [

1129

# "user:mike@example.com",

1130

# "group:admins@example.com",

1131

# "domain:google.com",

1132

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

Sai Cheemalapati

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

[diff] [blame]

1133

# ]

1134

# },

1135

# {

Bu Sun Kim

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

[diff] [blame]

1136

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

Bu Sun Kim

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

[diff] [blame^]

1137

# "members": [

1138

# "user:eve@example.com"

1139

# ],

Bu Sun Kim

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

[diff] [blame]

1140

# "condition": {

1141

# "title": "expirable access",

1142

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

1143

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

Dan O'Meara

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

[diff] [blame]

1144

# }

Sai Cheemalapati

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

[diff] [blame]

1145

# }

Dan O'Meara

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

[diff] [blame]

1146

# ],

Bu Sun Kim

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

[diff] [blame]

1147

# "etag": "BwWWja0YfJA=",

1148

# "version": 3

Sai Cheemalapati

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

[diff] [blame]

1149

# }

1150

#

Dan O'Meara

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

[diff] [blame]

1151

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1156

# - group:admins@example.com

1157

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1158

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

1159

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1160

# - members:

Dan O'Meara

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

[diff] [blame]

1161

# - user:eve@example.com

1162

# role: roles/resourcemanager.organizationViewer

1163

# condition:

1164

# title: expirable access

1165

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1166

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

Dan O'Meara

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

[diff] [blame]

1167

# - etag: BwWWja0YfJA=

1168

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1169

#

Sai Cheemalapati

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

[diff] [blame]

1170

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

Dan O'Meara

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

[diff] [blame]

1171

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

Bu Sun Kim

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

[diff] [blame]

1172

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

1173

{ # Specifies the audit configuration for a service.

1174

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

1175

# identities, if any, are exempted from logging.

1176

# An AuditConfig must have one or more AuditLogConfigs.

1177

#

1178

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

1179

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

1180

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

1181

# AuditLogConfig are exempted.

1182

#

1183

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1189

# "audit_log_configs": [

1190

# {

1191

# "log_type": "DATA_READ",

1192

# "exempted_members": [

1193

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1198

# },

1199

# {

1200

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

1206

# "audit_log_configs": [

1207

# {

1208

# "log_type": "DATA_READ",

1209

# },

1210

# {

1211

# "log_type": "DATA_WRITE",

1212

# "exempted_members": [

1213

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

1222

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

1223

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

1224

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

1225

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

1226

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

Bu Sun Kim

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

[diff] [blame]

1227

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

1228

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

# Example:

#

# {

# "audit_log_configs": [

1233

# {

1234

# "log_type": "DATA_READ",

1235

# "exempted_members": [

1236

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

1246

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame^]

1247

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

Bu Sun Kim

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

[diff] [blame]

1248

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

1249

# permission.

1250

# Follows the same format of Binding.members.

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame]

1255

},

1256

],

Bu Sun Kim

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

[diff] [blame^]

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

1263

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

1264

#

1265

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

1266

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

1267

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

1268

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

1269

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

1270

#

1271

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

1272

# are rejected.

1273

#

1274

# Any operation that affects conditional role bindings must specify version

1275

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

1276

#

1277

# * Getting a policy that includes a conditional role binding

1278

# * Adding a conditional role binding to a policy

1279

# * Changing a conditional role binding in a policy

1280

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

1281

# that includes conditions

1282

#

1283

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

1284

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

1285

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

1286

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

1287

#

1288

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

1289

# specify any valid version or leave the field unset.

1290

#

1291

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

1292

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

Bu Sun Kim

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

[diff] [blame]

1293

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

1294

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

1295

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

1296

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

Bu Sun Kim

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

[diff] [blame]

1297

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

1298

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

Bu Sun Kim

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

[diff] [blame]

1299

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

1300

# `members` can have the following values:

1301

#

1302

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

1303

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

1304

#

1305

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

1306

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

1307

#

1308

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

1309

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

1310

#

1311

#

1312

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

1313

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

1314

#

1315

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

1316

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

1317

#

1318

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

1319

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

1320

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

1321

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

1322

# retains the role in the binding.

1323

#

1324

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

1325

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

1326

# deleted. For example,

1327

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

1328

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

1329

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

1330

# role in the binding.

1331

#

1332

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

1333

# identifier) representing a Google group that has been recently

1334

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

1335

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

1336

# recovered group retains the role in the binding.

1337

#

1338

#

1339

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

1340

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

1341

#

1342

"A String",

1343

],

Bu Sun Kim

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

[diff] [blame^]

1344

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

1345

#

1346

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

1347

# current request.

1348

#

1349

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

1350

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

1351

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

1352

#

1353

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

1354

# [IAM

1355

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

1356

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

1357

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

1358

#

1359

# Example (Comparison):

1360

#

1361

# title: "Summary size limit"

1362

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

1363

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

1364

#

1365

# Example (Equality):

1366

#

1367

# title: "Requestor is owner"

1368

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

1369

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

#

# Example (Logic):

#

# title: "Public documents"

1374

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

1375

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

1376

#

1377

# Example (Data Manipulation):

1378

#

1379

# title: "Notification string"

1380

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

1381

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

1382

#

1383

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

1384

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

1385

# documentation for additional information.

1386

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

1387

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

1388

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

1389

# syntax.

1390

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

1391

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

1392

# expression.

1393

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

1394

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

1395

},

Dan O'Meara

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

[diff] [blame]

1396

},

1397

],

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>

1403

<pre>Synchronize a connected repo.

1404

1405

The response contains SyncRepoMetadata in the metadata field.

Args:

Dan O'Meara

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

[diff] [blame]

1409

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

Bu Sun Kim

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

[diff] [blame]

1410

body: object, The request body.

1411

The object takes the form of:

1412

1413

{ # Request for SyncRepo.

1414

}

1415

1416

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1423

1424

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

1425

# network API call.

Bu Sun Kim

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

[diff] [blame^]

1426

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

1427

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

1428

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

1429

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

1430

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

1431

},

1432

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

1433

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

1434

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

1435

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

1436

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

1437

# available.

1438

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

1439

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

1440

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

1441

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

1442

#

1443

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

1444

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

1445

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

1446

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

1447

# message types for APIs to use.

1448

{

1449

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

1450

},

1451

],

1452

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

1453

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

1454

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

1455

},

Bu Sun Kim

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

[diff] [blame]

1456

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

1457

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

1458

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

1459

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

1460

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

1461

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

1462

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

1463

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1464

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

Dan O'Meara

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

[diff] [blame]

1465

},

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]

1470

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

Sai Cheemalapati

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

[diff] [blame]

1471

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

1472

If the resource does not exist, this will return an empty set of

1473

permissions, not a NOT_FOUND error.

1474

1475

Args:

1476

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

1477

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

Dan O'Meara

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

[diff] [blame]

1478

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1479

The object takes the form of:

1480

1481

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1482

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

1483

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

Sai Cheemalapati

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

[diff] [blame]

1484

# information see

1485

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

Bu Sun Kim

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

[diff] [blame]

1486

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

1497

1498

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1499

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

Sai Cheemalapati

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

[diff] [blame]

1500

# allowed.

Bu Sun Kim

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

[diff] [blame]

1501

"A String",

Sai Cheemalapati