Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / sourcerepo_v1.projects.repos.html
blob: 34a0474ea4a8ef3e709ee7f999c1ca5b28892ad6 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="sourcerepo_v1.html">Cloud Source Repositories API</a> . <a href="sourcerepo_v1.projects.html">projects</a> . <a href="sourcerepo_v1.projects.repos.html">repos</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Deletes a repo.</p>
83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="firstline">Returns information about a repo.</p>
86<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]87 <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Gets the access control policy for a resource.</p>
89<p class="toc_element">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]90 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
91<p class="firstline">Returns all repos belonging to a project. The sizes of the repos are</p>
92<p class="toc_element">
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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]95<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]96 <code><a href="#patch">patch(name, body, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates information about a repo.</p>
98<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]99 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-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<p class="toc_element">
Bu Sun Kim715bd7f2019-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<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]105 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-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<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]109 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]110 <pre>Creates a repo in the given project with the given name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]111
112If the named repository already exists, `CreateRepo` returns
113`ALREADY_EXISTS`.
114
115Args:
116 parent: string, The project in which to create the repo. Values are of the form
117`projects/<project>`. (required)
118 body: object, The request body. (required)
119 The object takes the form of:
120
121{ # A repository (or repo) is a Git repository storing versioned source content.
122 "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]123 # Read-only field.
124 "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
125 # Pub/Sub. Keyed by the topic names.
126 "a_key": { # Configuration to publish a Cloud Pub/Sub message.
127 "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
128 # `projects/<project>/topics/<topic>`. The project needs to be the same
129 # project as this config is in.
130 "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
131 "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
132 # messages. This service account needs to be in the same project as the
133 # PubsubConfig. When added, the caller needs to have
134 # iam.serviceAccounts.actAs permission on this service account. If
135 # unspecified, it defaults to the compute engine default service account.
136 },
137 },
138 "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
139 # returned by GetRepo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]140 "name": "A String", # Resource name of the repository, of the form
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]141 # `projects/<project>/repos/<repo>`. The repo name may contain slashes.
142 # eg, `projects/myproject/repos/name/with/slash`
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]143 "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]144 # Read-only field.
145 # hosting service, for example GitHub or Bitbucket.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]146 "url": "A String", # URL of the main repository at the other hosting service.
147 "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]148 # Removing this webhook from the other hosting service will stop
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]149 # Google Cloud Source Repositories from receiving notifications,
150 # and thereby disabling mirroring.
151 "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
152 # Removing this key from the other service would deauthorize
153 # Google Cloud Source Repositories from mirroring.
154 },
155}
156
157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162Returns:
163 An object of the form:
164
165 { # A repository (or repo) is a Git repository storing versioned source content.
166 "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]167 # Read-only field.
168 "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
169 # Pub/Sub. Keyed by the topic names.
170 "a_key": { # Configuration to publish a Cloud Pub/Sub message.
171 "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
172 # `projects/<project>/topics/<topic>`. The project needs to be the same
173 # project as this config is in.
174 "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
175 "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
176 # messages. This service account needs to be in the same project as the
177 # PubsubConfig. When added, the caller needs to have
178 # iam.serviceAccounts.actAs permission on this service account. If
179 # unspecified, it defaults to the compute engine default service account.
180 },
181 },
182 "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
183 # returned by GetRepo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]184 "name": "A String", # Resource name of the repository, of the form
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]185 # `projects/<project>/repos/<repo>`. The repo name may contain slashes.
186 # eg, `projects/myproject/repos/name/with/slash`
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]187 "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]188 # Read-only field.
189 # hosting service, for example GitHub or Bitbucket.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]190 "url": "A String", # URL of the main repository at the other hosting service.
191 "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]192 # Removing this webhook from the other hosting service will stop
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]193 # Google Cloud Source Repositories from receiving notifications,
194 # and thereby disabling mirroring.
195 "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
196 # Removing this key from the other service would deauthorize
197 # Google Cloud Source Repositories from mirroring.
198 },
199 }</pre>
200</div>
201
202<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]203 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]204 <pre>Deletes a repo.
205
206Args:
207 name: string, The name of the repo to delete. Values are of the form
208`projects/<project>/repos/<repo>`. (required)
209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
213
214Returns:
215 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 `{}`.
226 }</pre>
227</div>
228
229<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]230 <code class="details" id="get">get(name, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]231 <pre>Returns information about a repo.
232
233Args:
234 name: string, The name of the requested repository. Values are of the form
235`projects/<project>/repos/<repo>`. (required)
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
240
241Returns:
242 An object of the form:
243
244 { # A repository (or repo) is a Git repository storing versioned source content.
245 "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]246 # Read-only field.
247 "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
248 # Pub/Sub. Keyed by the topic names.
249 "a_key": { # Configuration to publish a Cloud Pub/Sub message.
250 "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
251 # `projects/<project>/topics/<topic>`. The project needs to be the same
252 # project as this config is in.
253 "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
254 "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
255 # messages. This service account needs to be in the same project as the
256 # PubsubConfig. When added, the caller needs to have
257 # iam.serviceAccounts.actAs permission on this service account. If
258 # unspecified, it defaults to the compute engine default service account.
259 },
260 },
261 "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
262 # returned by GetRepo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]263 "name": "A String", # Resource name of the repository, of the form
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]264 # `projects/<project>/repos/<repo>`. The repo name may contain slashes.
265 # eg, `projects/myproject/repos/name/with/slash`
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]266 "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]267 # Read-only field.
268 # hosting service, for example GitHub or Bitbucket.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]269 "url": "A String", # URL of the main repository at the other hosting service.
270 "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]271 # Removing this webhook from the other hosting service will stop
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]272 # Google Cloud Source Repositories from receiving notifications,
273 # and thereby disabling mirroring.
274 "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
275 # Removing this key from the other service would deauthorize
276 # Google Cloud Source Repositories from mirroring.
277 },
278 }</pre>
279</div>
280
281<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]282 <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]283 <pre>Gets the access control policy for a resource.
284Returns an empty policy if the resource exists and does not have a policy
285set.
286
287Args:
288 resource: string, REQUIRED: The resource for which the policy is being requested.
289See the operation documentation for the appropriate value for this field. (required)
290 x__xgafv: string, V1 error format.
291 Allowed values
292 1 - v1 error format
293 2 - v2 error format
294
295Returns:
296 An object of the form:
297
298 { # Defines an Identity and Access Management (IAM) policy. It is used to
299 # specify access control policies for Cloud Platform resources.
300 #
301 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]302 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]303 # `members` to a `role`, where the members can be user accounts, Google groups,
304 # Google domains, and service accounts. A `role` is a named list of permissions
305 # defined by IAM.
306 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]307 # **JSON Example**
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]308 #
309 # {
310 # "bindings": [
311 # {
312 # "role": "roles/owner",
313 # "members": [
314 # "user:mike@example.com",
315 # "group:admins@example.com",
316 # "domain:google.com",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]317 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]318 # ]
319 # },
320 # {
321 # "role": "roles/viewer",
322 # "members": ["user:sean@example.com"]
323 # }
324 # ]
325 # }
326 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]327 # **YAML Example**
328 #
329 # bindings:
330 # - members:
331 # - user:mike@example.com
332 # - group:admins@example.com
333 # - domain:google.com
334 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
335 # role: roles/owner
336 # - members:
337 # - user:sean@example.com
338 # role: roles/viewer
339 #
340 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]341 # For a description of IAM and its features, see the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]342 # [IAM developer's guide](https://cloud.google.com/iam/docs).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]343 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
344 { # Specifies the audit configuration for a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]345 # The configuration determines which permission types are logged, and what
346 # identities, if any, are exempted from logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]347 # An AuditConfig must have one or more AuditLogConfigs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]348 #
349 # If there are AuditConfigs for both `allServices` and a specific service,
350 # the union of the two AuditConfigs is used for that service: the log_types
351 # specified in each AuditConfig are enabled, and the exempted_members in each
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]352 # AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]353 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]354 # Example Policy with multiple AuditConfigs:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]355 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]356 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]357 # "audit_configs": [
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]358 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]359 # "service": "allServices"
360 # "audit_log_configs": [
361 # {
362 # "log_type": "DATA_READ",
363 # "exempted_members": [
364 # "user:foo@gmail.com"
365 # ]
366 # },
367 # {
368 # "log_type": "DATA_WRITE",
369 # },
370 # {
371 # "log_type": "ADMIN_READ",
372 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]373 # ]
374 # },
375 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]376 # "service": "fooservice.googleapis.com"
377 # "audit_log_configs": [
378 # {
379 # "log_type": "DATA_READ",
380 # },
381 # {
382 # "log_type": "DATA_WRITE",
383 # "exempted_members": [
384 # "user:bar@gmail.com"
385 # ]
386 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]387 # ]
388 # }
389 # ]
390 # }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]391 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]392 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
393 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
394 # bar@gmail.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]395 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]396 { # Provides the configuration for logging a type of permissions.
397 # Example:
398 #
399 # {
400 # "audit_log_configs": [
401 # {
402 # "log_type": "DATA_READ",
403 # "exempted_members": [
404 # "user:foo@gmail.com"
405 # ]
406 # },
407 # {
408 # "log_type": "DATA_WRITE",
409 # }
410 # ]
411 # }
412 #
413 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
414 # foo@gmail.com from DATA_READ logging.
415 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
416 # permission.
417 # Follows the same format of Binding.members.
418 "A String",
419 ],
420 "logType": "A String", # The log type that this config enables.
421 },
422 ],
423 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]424 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]425 # `allServices` is a special value that covers all services.
426 },
427 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]428 "version": 42, # Deprecated.
429 "bindings": [ # Associates a list of `members` to a `role`.
430 # `bindings` with no members will result in an error.
431 { # Associates `members` with a `role`.
432 "role": "A String", # Role that is assigned to `members`.
433 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
434 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
435 # `members` can have the following values:
436 #
437 # * `allUsers`: A special identifier that represents anyone who is
438 # on the internet; with or without a Google account.
439 #
440 # * `allAuthenticatedUsers`: A special identifier that represents anyone
441 # who is authenticated with a Google account or a service account.
442 #
443 # * `user:{emailid}`: An email address that represents a specific Google
444 # account. For example, `alice@gmail.com` .
445 #
446 #
447 # * `serviceAccount:{emailid}`: An email address that represents a service
448 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
449 #
450 # * `group:{emailid}`: An email address that represents a Google group.
451 # For example, `admins@example.com`.
452 #
453 #
454 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
455 # users of that domain. For example, `google.com` or `example.com`.
456 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]457 "A String",
458 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]459 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
460 # NOTE: An unsatisfied condition will not allow user access via current
461 # binding. Different bindings, including their conditions, are examined
462 # independently.
463 #
464 # title: "User account presence"
465 # description: "Determines whether the request has a user account"
466 # expression: "size(request.user) > 0"
467 "location": "A String", # An optional string indicating the location of the expression for error
468 # reporting, e.g. a file name and a position in the file.
469 "expression": "A String", # Textual representation of an expression in
470 # Common Expression Language syntax.
471 #
472 # The application context of the containing message determines which
473 # well-known feature set of CEL is supported.
474 "description": "A String", # An optional description of the expression. This is a longer text which
475 # describes the expression, e.g. when hovered over it in a UI.
476 "title": "A String", # An optional title for the expression, i.e. a short string describing
477 # its purpose. This can be used e.g. in UIs which allow to enter the
478 # expression.
479 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]480 },
481 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]482 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
483 # prevent simultaneous updates of a policy from overwriting each other.
484 # It is strongly suggested that systems make use of the `etag` in the
485 # read-modify-write cycle to perform policy updates in order to avoid race
486 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
487 # systems are expected to put that etag in the request to `setIamPolicy` to
488 # ensure that their change will be applied to the same version of the policy.
489 #
490 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
491 # policy is overwritten blindly.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]492 }</pre>
493</div>
494
495<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]496 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</code>
497 <pre>Returns all repos belonging to a project. The sizes of the repos are
498not set by ListRepos. To get the size of a repo, use GetRepo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]499
500Args:
501 name: string, The project ID whose repos should be listed. Values are of the form
502`projects/<project>`. (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]503 pageToken: string, Resume listing repositories where a prior ListReposResponse
504left off. This is an opaque token that must be obtained from
505a recent, prior ListReposResponse's next_page_token field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]506 x__xgafv: string, V1 error format.
507 Allowed values
508 1 - v1 error format
509 2 - v2 error format
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]510 pageSize: integer, Maximum number of repositories to return; between 1 and 500.
511If not set or zero, defaults to 100 at the server.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]512
513Returns:
514 An object of the form:
515
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]516 { # Response for ListRepos. The size is not set in the returned repositories.
517 "nextPageToken": "A String", # If non-empty, additional repositories exist within the project. These
518 # can be retrieved by including this value in the next ListReposRequest's
519 # page_token field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]520 "repos": [ # The listed repos.
521 { # A repository (or repo) is a Git repository storing versioned source content.
522 "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]523 # Read-only field.
524 "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
525 # Pub/Sub. Keyed by the topic names.
526 "a_key": { # Configuration to publish a Cloud Pub/Sub message.
527 "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
528 # `projects/<project>/topics/<topic>`. The project needs to be the same
529 # project as this config is in.
530 "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
531 "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
532 # messages. This service account needs to be in the same project as the
533 # PubsubConfig. When added, the caller needs to have
534 # iam.serviceAccounts.actAs permission on this service account. If
535 # unspecified, it defaults to the compute engine default service account.
536 },
537 },
538 "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
539 # returned by GetRepo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]540 "name": "A String", # Resource name of the repository, of the form
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]541 # `projects/<project>/repos/<repo>`. The repo name may contain slashes.
542 # eg, `projects/myproject/repos/name/with/slash`
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]543 "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]544 # Read-only field.
545 # hosting service, for example GitHub or Bitbucket.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]546 "url": "A String", # URL of the main repository at the other hosting service.
547 "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]548 # Removing this webhook from the other hosting service will stop
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]549 # Google Cloud Source Repositories from receiving notifications,
550 # and thereby disabling mirroring.
551 "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
552 # Removing this key from the other service would deauthorize
553 # Google Cloud Source Repositories from mirroring.
554 },
555 },
556 ],
557 }</pre>
558</div>
559
560<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]561 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
562 <pre>Retrieves the next page of results.
563
564Args:
565 previous_request: The request for the previous page. (required)
566 previous_response: The response from the request for the previous page. (required)
567
568Returns:
569 A request object that you can call 'execute()' on to request the next
570 page. Returns None if there are no more items in the collection.
571 </pre>
572</div>
573
574<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]575 <code class="details" id="patch">patch(name, body, x__xgafv=None)</code>
576 <pre>Updates information about a repo.
577
578Args:
579 name: string, The name of the requested repository. Values are of the form
580`projects/<project>/repos/<repo>`. (required)
581 body: object, The request body. (required)
582 The object takes the form of:
583
584{ # Request for UpdateRepo.
585 "repo": { # A repository (or repo) is a Git repository storing versioned source content. # The new configuration for the repository.
586 "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
587 # Read-only field.
588 "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
589 # Pub/Sub. Keyed by the topic names.
590 "a_key": { # Configuration to publish a Cloud Pub/Sub message.
591 "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
592 # `projects/<project>/topics/<topic>`. The project needs to be the same
593 # project as this config is in.
594 "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
595 "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
596 # messages. This service account needs to be in the same project as the
597 # PubsubConfig. When added, the caller needs to have
598 # iam.serviceAccounts.actAs permission on this service account. If
599 # unspecified, it defaults to the compute engine default service account.
600 },
601 },
602 "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
603 # returned by GetRepo.
604 "name": "A String", # Resource name of the repository, of the form
605 # `projects/<project>/repos/<repo>`. The repo name may contain slashes.
606 # eg, `projects/myproject/repos/name/with/slash`
607 "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
608 # Read-only field.
609 # hosting service, for example GitHub or Bitbucket.
610 "url": "A String", # URL of the main repository at the other hosting service.
611 "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
612 # Removing this webhook from the other hosting service will stop
613 # Google Cloud Source Repositories from receiving notifications,
614 # and thereby disabling mirroring.
615 "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
616 # Removing this key from the other service would deauthorize
617 # Google Cloud Source Repositories from mirroring.
618 },
619 },
620 "updateMask": "A String", # A FieldMask specifying which fields of the repo to modify. Only the fields
621 # in the mask will be modified. If no mask is provided, this request is
622 # no-op.
623 }
624
625 x__xgafv: string, V1 error format.
626 Allowed values
627 1 - v1 error format
628 2 - v2 error format
629
630Returns:
631 An object of the form:
632
633 { # A repository (or repo) is a Git repository storing versioned source content.
634 "url": "A String", # URL to clone the repository from Google Cloud Source Repositories.
635 # Read-only field.
636 "pubsubConfigs": { # How this repository publishes a change in the repository through Cloud
637 # Pub/Sub. Keyed by the topic names.
638 "a_key": { # Configuration to publish a Cloud Pub/Sub message.
639 "topic": "A String", # A topic of Cloud Pub/Sub. Values are of the form
640 # `projects/<project>/topics/<topic>`. The project needs to be the same
641 # project as this config is in.
642 "messageFormat": "A String", # The format of the Cloud Pub/Sub messages.
643 "serviceAccountEmail": "A String", # Email address of the service account used for publishing Cloud Pub/Sub
644 # messages. This service account needs to be in the same project as the
645 # PubsubConfig. When added, the caller needs to have
646 # iam.serviceAccounts.actAs permission on this service account. If
647 # unspecified, it defaults to the compute engine default service account.
648 },
649 },
650 "size": "A String", # The disk usage of the repo, in bytes. Read-only field. Size is only
651 # returned by GetRepo.
652 "name": "A String", # Resource name of the repository, of the form
653 # `projects/<project>/repos/<repo>`. The repo name may contain slashes.
654 # eg, `projects/myproject/repos/name/with/slash`
655 "mirrorConfig": { # Configuration to automatically mirror a repository from another # How this repository mirrors a repository managed by another service.
656 # Read-only field.
657 # hosting service, for example GitHub or Bitbucket.
658 "url": "A String", # URL of the main repository at the other hosting service.
659 "webhookId": "A String", # ID of the webhook listening to updates to trigger mirroring.
660 # Removing this webhook from the other hosting service will stop
661 # Google Cloud Source Repositories from receiving notifications,
662 # and thereby disabling mirroring.
663 "deployKeyId": "A String", # ID of the SSH deploy key at the other hosting service.
664 # Removing this key from the other service would deauthorize
665 # Google Cloud Source Repositories from mirroring.
666 },
667 }</pre>
668</div>
669
670<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]671 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]672 <pre>Sets the access control policy on the specified resource. Replaces any
673existing policy.
674
675Args:
676 resource: string, REQUIRED: The resource for which the policy is being specified.
677See the operation documentation for the appropriate value for this field. (required)
678 body: object, The request body. (required)
679 The object takes the form of:
680
681{ # Request message for `SetIamPolicy` method.
682 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
683 # the policy is limited to a few 10s of KB. An empty policy is a
684 # valid policy but certain Cloud Platform services (such as Projects)
685 # might reject them.
686 # specify access control policies for Cloud Platform resources.
687 #
688 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]689 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]690 # `members` to a `role`, where the members can be user accounts, Google groups,
691 # Google domains, and service accounts. A `role` is a named list of permissions
692 # defined by IAM.
693 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]694 # **JSON Example**
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]695 #
696 # {
697 # "bindings": [
698 # {
699 # "role": "roles/owner",
700 # "members": [
701 # "user:mike@example.com",
702 # "group:admins@example.com",
703 # "domain:google.com",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]704 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]705 # ]
706 # },
707 # {
708 # "role": "roles/viewer",
709 # "members": ["user:sean@example.com"]
710 # }
711 # ]
712 # }
713 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]714 # **YAML Example**
715 #
716 # bindings:
717 # - members:
718 # - user:mike@example.com
719 # - group:admins@example.com
720 # - domain:google.com
721 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
722 # role: roles/owner
723 # - members:
724 # - user:sean@example.com
725 # role: roles/viewer
726 #
727 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]728 # For a description of IAM and its features, see the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]729 # [IAM developer's guide](https://cloud.google.com/iam/docs).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]730 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
731 { # Specifies the audit configuration for a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]732 # The configuration determines which permission types are logged, and what
733 # identities, if any, are exempted from logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]734 # An AuditConfig must have one or more AuditLogConfigs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]735 #
736 # If there are AuditConfigs for both `allServices` and a specific service,
737 # the union of the two AuditConfigs is used for that service: the log_types
738 # specified in each AuditConfig are enabled, and the exempted_members in each
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]739 # AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]740 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]741 # Example Policy with multiple AuditConfigs:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]742 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]743 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]744 # "audit_configs": [
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]745 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]746 # "service": "allServices"
747 # "audit_log_configs": [
748 # {
749 # "log_type": "DATA_READ",
750 # "exempted_members": [
751 # "user:foo@gmail.com"
752 # ]
753 # },
754 # {
755 # "log_type": "DATA_WRITE",
756 # },
757 # {
758 # "log_type": "ADMIN_READ",
759 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]760 # ]
761 # },
762 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]763 # "service": "fooservice.googleapis.com"
764 # "audit_log_configs": [
765 # {
766 # "log_type": "DATA_READ",
767 # },
768 # {
769 # "log_type": "DATA_WRITE",
770 # "exempted_members": [
771 # "user:bar@gmail.com"
772 # ]
773 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]774 # ]
775 # }
776 # ]
777 # }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]778 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]779 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
780 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
781 # bar@gmail.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]782 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]783 { # Provides the configuration for logging a type of permissions.
784 # Example:
785 #
786 # {
787 # "audit_log_configs": [
788 # {
789 # "log_type": "DATA_READ",
790 # "exempted_members": [
791 # "user:foo@gmail.com"
792 # ]
793 # },
794 # {
795 # "log_type": "DATA_WRITE",
796 # }
797 # ]
798 # }
799 #
800 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
801 # foo@gmail.com from DATA_READ logging.
802 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
803 # permission.
804 # Follows the same format of Binding.members.
805 "A String",
806 ],
807 "logType": "A String", # The log type that this config enables.
808 },
809 ],
810 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]811 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]812 # `allServices` is a special value that covers all services.
813 },
814 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]815 "version": 42, # Deprecated.
816 "bindings": [ # Associates a list of `members` to a `role`.
817 # `bindings` with no members will result in an error.
818 { # Associates `members` with a `role`.
819 "role": "A String", # Role that is assigned to `members`.
820 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
821 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
822 # `members` can have the following values:
823 #
824 # * `allUsers`: A special identifier that represents anyone who is
825 # on the internet; with or without a Google account.
826 #
827 # * `allAuthenticatedUsers`: A special identifier that represents anyone
828 # who is authenticated with a Google account or a service account.
829 #
830 # * `user:{emailid}`: An email address that represents a specific Google
831 # account. For example, `alice@gmail.com` .
832 #
833 #
834 # * `serviceAccount:{emailid}`: An email address that represents a service
835 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
836 #
837 # * `group:{emailid}`: An email address that represents a Google group.
838 # For example, `admins@example.com`.
839 #
840 #
841 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
842 # users of that domain. For example, `google.com` or `example.com`.
843 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]844 "A String",
845 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]846 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
847 # NOTE: An unsatisfied condition will not allow user access via current
848 # binding. Different bindings, including their conditions, are examined
849 # independently.
850 #
851 # title: "User account presence"
852 # description: "Determines whether the request has a user account"
853 # expression: "size(request.user) > 0"
854 "location": "A String", # An optional string indicating the location of the expression for error
855 # reporting, e.g. a file name and a position in the file.
856 "expression": "A String", # Textual representation of an expression in
857 # Common Expression Language syntax.
858 #
859 # The application context of the containing message determines which
860 # well-known feature set of CEL is supported.
861 "description": "A String", # An optional description of the expression. This is a longer text which
862 # describes the expression, e.g. when hovered over it in a UI.
863 "title": "A String", # An optional title for the expression, i.e. a short string describing
864 # its purpose. This can be used e.g. in UIs which allow to enter the
865 # expression.
866 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]867 },
868 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]869 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
870 # prevent simultaneous updates of a policy from overwriting each other.
871 # It is strongly suggested that systems make use of the `etag` in the
872 # read-modify-write cycle to perform policy updates in order to avoid race
873 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
874 # systems are expected to put that etag in the request to `setIamPolicy` to
875 # ensure that their change will be applied to the same version of the policy.
876 #
877 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
878 # policy is overwritten blindly.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]879 },
880 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]881 # the fields in the mask will be modified. If no mask is provided, the
882 # following default mask is used:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]883 # paths: "bindings, etag"
884 # This field is only used by Cloud IAM.
885 }
886
887 x__xgafv: string, V1 error format.
888 Allowed values
889 1 - v1 error format
890 2 - v2 error format
891
892Returns:
893 An object of the form:
894
895 { # Defines an Identity and Access Management (IAM) policy. It is used to
896 # specify access control policies for Cloud Platform resources.
897 #
898 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]899 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]900 # `members` to a `role`, where the members can be user accounts, Google groups,
901 # Google domains, and service accounts. A `role` is a named list of permissions
902 # defined by IAM.
903 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]904 # **JSON Example**
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]905 #
906 # {
907 # "bindings": [
908 # {
909 # "role": "roles/owner",
910 # "members": [
911 # "user:mike@example.com",
912 # "group:admins@example.com",
913 # "domain:google.com",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]914 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]915 # ]
916 # },
917 # {
918 # "role": "roles/viewer",
919 # "members": ["user:sean@example.com"]
920 # }
921 # ]
922 # }
923 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]924 # **YAML Example**
925 #
926 # bindings:
927 # - members:
928 # - user:mike@example.com
929 # - group:admins@example.com
930 # - domain:google.com
931 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
932 # role: roles/owner
933 # - members:
934 # - user:sean@example.com
935 # role: roles/viewer
936 #
937 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]938 # For a description of IAM and its features, see the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]939 # [IAM developer's guide](https://cloud.google.com/iam/docs).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]940 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
941 { # Specifies the audit configuration for a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]942 # The configuration determines which permission types are logged, and what
943 # identities, if any, are exempted from logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]944 # An AuditConfig must have one or more AuditLogConfigs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]945 #
946 # If there are AuditConfigs for both `allServices` and a specific service,
947 # the union of the two AuditConfigs is used for that service: the log_types
948 # specified in each AuditConfig are enabled, and the exempted_members in each
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]949 # AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]950 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]951 # Example Policy with multiple AuditConfigs:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]952 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]953 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]954 # "audit_configs": [
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]955 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]956 # "service": "allServices"
957 # "audit_log_configs": [
958 # {
959 # "log_type": "DATA_READ",
960 # "exempted_members": [
961 # "user:foo@gmail.com"
962 # ]
963 # },
964 # {
965 # "log_type": "DATA_WRITE",
966 # },
967 # {
968 # "log_type": "ADMIN_READ",
969 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]970 # ]
971 # },
972 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]973 # "service": "fooservice.googleapis.com"
974 # "audit_log_configs": [
975 # {
976 # "log_type": "DATA_READ",
977 # },
978 # {
979 # "log_type": "DATA_WRITE",
980 # "exempted_members": [
981 # "user:bar@gmail.com"
982 # ]
983 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]984 # ]
985 # }
986 # ]
987 # }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]988 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]989 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
990 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
991 # bar@gmail.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]992 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]993 { # Provides the configuration for logging a type of permissions.
994 # Example:
995 #
996 # {
997 # "audit_log_configs": [
998 # {
999 # "log_type": "DATA_READ",
1000 # "exempted_members": [
1001 # "user:foo@gmail.com"
1002 # ]
1003 # },
1004 # {
1005 # "log_type": "DATA_WRITE",
1006 # }
1007 # ]
1008 # }
1009 #
1010 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
1011 # foo@gmail.com from DATA_READ logging.
1012 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1013 # permission.
1014 # Follows the same format of Binding.members.
1015 "A String",
1016 ],
1017 "logType": "A String", # The log type that this config enables.
1018 },
1019 ],
1020 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1021 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1022 # `allServices` is a special value that covers all services.
1023 },
1024 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1025 "version": 42, # Deprecated.
1026 "bindings": [ # Associates a list of `members` to a `role`.
1027 # `bindings` with no members will result in an error.
1028 { # Associates `members` with a `role`.
1029 "role": "A String", # Role that is assigned to `members`.
1030 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1031 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1032 # `members` can have the following values:
1033 #
1034 # * `allUsers`: A special identifier that represents anyone who is
1035 # on the internet; with or without a Google account.
1036 #
1037 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1038 # who is authenticated with a Google account or a service account.
1039 #
1040 # * `user:{emailid}`: An email address that represents a specific Google
1041 # account. For example, `alice@gmail.com` .
1042 #
1043 #
1044 # * `serviceAccount:{emailid}`: An email address that represents a service
1045 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1046 #
1047 # * `group:{emailid}`: An email address that represents a Google group.
1048 # For example, `admins@example.com`.
1049 #
1050 #
1051 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1052 # users of that domain. For example, `google.com` or `example.com`.
1053 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1054 "A String",
1055 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1056 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
1057 # NOTE: An unsatisfied condition will not allow user access via current
1058 # binding. Different bindings, including their conditions, are examined
1059 # independently.
1060 #
1061 # title: "User account presence"
1062 # description: "Determines whether the request has a user account"
1063 # expression: "size(request.user) > 0"
1064 "location": "A String", # An optional string indicating the location of the expression for error
1065 # reporting, e.g. a file name and a position in the file.
1066 "expression": "A String", # Textual representation of an expression in
1067 # Common Expression Language syntax.
1068 #
1069 # The application context of the containing message determines which
1070 # well-known feature set of CEL is supported.
1071 "description": "A String", # An optional description of the expression. This is a longer text which
1072 # describes the expression, e.g. when hovered over it in a UI.
1073 "title": "A String", # An optional title for the expression, i.e. a short string describing
1074 # its purpose. This can be used e.g. in UIs which allow to enter the
1075 # expression.
1076 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1077 },
1078 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1079 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1080 # prevent simultaneous updates of a policy from overwriting each other.
1081 # It is strongly suggested that systems make use of the `etag` in the
1082 # read-modify-write cycle to perform policy updates in order to avoid race
1083 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1084 # systems are expected to put that etag in the request to `setIamPolicy` to
1085 # ensure that their change will be applied to the same version of the policy.
1086 #
1087 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
1088 # policy is overwritten blindly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1089 }</pre>
1090</div>
1091
1092<div class="method">
1093 <code class="details" id="sync">sync(name, body=None, x__xgafv=None)</code>
1094 <pre>Synchronize a connected repo.
1095
1096The response contains SyncRepoMetadata in the metadata field.
1097
1098Args:
1099 name: string, The name of the repo to synchronize. Values are of the form
1100`projects/<project>/repos/<repo>`. (required)
1101 body: object, The request body.
1102 The object takes the form of:
1103
1104{ # Request for SyncRepo.
1105 }
1106
1107 x__xgafv: string, V1 error format.
1108 Allowed values
1109 1 - v1 error format
1110 2 - v2 error format
1111
1112Returns:
1113 An object of the form:
1114
1115 { # This resource represents a long-running operation that is the result of a
1116 # network API call.
1117 "response": { # The normal response of the operation in case of success. If the original
1118 # method returns no data on success, such as `Delete`, the response is
1119 # `google.protobuf.Empty`. If the original method is standard
1120 # `Get`/`Create`/`Update`, the response should be the resource. For other
1121 # methods, the response should have the type `XxxResponse`, where `Xxx`
1122 # is the original method name. For example, if the original method name
1123 # is `TakeSnapshot()`, the inferred response type is
1124 # `TakeSnapshotResponse`.
1125 "a_key": "", # Properties of the object. Contains field @type with type URL.
1126 },
1127 "metadata": { # Service-specific metadata associated with the operation. It typically
1128 # contains progress information and common metadata such as create time.
1129 # Some services might not provide such metadata. Any method that returns a
1130 # long-running operation should document the metadata type, if any.
1131 "a_key": "", # Properties of the object. Contains field @type with type URL.
1132 },
1133 "done": True or False, # If the value is `false`, it means the operation is still in progress.
1134 # If `true`, the operation is completed, and either `error` or `response` is
1135 # available.
1136 "name": "A String", # The server-assigned name, which is only unique within the same service that
1137 # originally returns it. If you use the default HTTP mapping, the
1138 # `name` should have the format of `operations/some/unique/name`.
1139 "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.
1140 # different programming environments, including REST APIs and RPC APIs. It is
1141 # used by [gRPC](https://github.com/grpc). The error model is designed to be:
1142 #
1143 # - Simple to use and understand for most users
1144 # - Flexible enough to meet unexpected needs
1145 #
1146 # # Overview
1147 #
1148 # The `Status` message contains three pieces of data: error code, error
1149 # message, and error details. The error code should be an enum value of
1150 # google.rpc.Code, but it may accept additional error codes if needed. The
1151 # error message should be a developer-facing English message that helps
1152 # developers *understand* and *resolve* the error. If a localized user-facing
1153 # error message is needed, put the localized message in the error details or
1154 # localize it in the client. The optional error details may contain arbitrary
1155 # information about the error. There is a predefined set of error detail types
1156 # in the package `google.rpc` that can be used for common error conditions.
1157 #
1158 # # Language mapping
1159 #
1160 # The `Status` message is the logical representation of the error model, but it
1161 # is not necessarily the actual wire format. When the `Status` message is
1162 # exposed in different client libraries and different wire protocols, it can be
1163 # mapped differently. For example, it will likely be mapped to some exceptions
1164 # in Java, but more likely mapped to some error codes in C.
1165 #
1166 # # Other uses
1167 #
1168 # The error model and the `Status` message can be used in a variety of
1169 # environments, either with or without APIs, to provide a
1170 # consistent developer experience across different environments.
1171 #
1172 # Example uses of this error model include:
1173 #
1174 # - Partial errors. If a service needs to return partial errors to the client,
1175 # it may embed the `Status` in the normal response to indicate the partial
1176 # errors.
1177 #
1178 # - Workflow errors. A typical workflow has multiple steps. Each step may
1179 # have a `Status` message for error reporting.
1180 #
1181 # - Batch operations. If a client uses batch request and batch response, the
1182 # `Status` message should be used directly inside batch response, one for
1183 # each error sub-response.
1184 #
1185 # - Asynchronous operations. If an API call embeds asynchronous operation
1186 # results in its response, the status of those operations should be
1187 # represented directly using the `Status` message.
1188 #
1189 # - Logging. If some API errors are stored in logs, the message `Status` could
1190 # be used directly after any stripping needed for security/privacy reasons.
1191 "message": "A String", # A developer-facing error message, which should be in English. Any
1192 # user-facing error message should be localized and sent in the
1193 # google.rpc.Status.details field, or localized by the client.
1194 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1195 "details": [ # A list of messages that carry the error details. There is a common set of
1196 # message types for APIs to use.
1197 {
1198 "a_key": "", # Properties of the object. Contains field @type with type URL.
1199 },
1200 ],
1201 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1202 }</pre>
1203</div>
1204
1205<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1206 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1207 <pre>Returns permissions that a caller has on the specified resource.
1208If the resource does not exist, this will return an empty set of
1209permissions, not a NOT_FOUND error.
1210
1211Args:
1212 resource: string, REQUIRED: The resource for which the policy detail is being requested.
1213See the operation documentation for the appropriate value for this field. (required)
1214 body: object, The request body. (required)
1215 The object takes the form of:
1216
1217{ # Request message for `TestIamPermissions` method.
1218 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1219 # wildcards (such as '*' or 'storage.*') are not allowed. For more
1220 # information see
1221 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1222 "A String",
1223 ],
1224 }
1225
1226 x__xgafv: string, V1 error format.
1227 Allowed values
1228 1 - v1 error format
1229 2 - v2 error format
1230
1231Returns:
1232 An object of the form:
1233
1234 { # Response message for `TestIamPermissions` method.
1235 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1236 # allowed.
1237 "A String",
1238 ],
1239 }</pre>
1240</div>
1241
1242</body></html>