Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.html
blob: 12c4c02872a0697521ba26970434f9ffd0c27170 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="runtimeconfig_v1beta1.html">Cloud Runtime Configuration API</a> . <a href="runtimeconfig_v1beta1.projects.html">projects</a> . <a href="runtimeconfig_v1beta1.projects.configs.html">configs</a></h1>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="runtimeconfig_v1beta1.projects.configs.operations.html">operations()</a></code>
79</p>
80<p class="firstline">Returns the operations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="runtimeconfig_v1beta1.projects.configs.variables.html">variables()</a></code>
84</p>
85<p class="firstline">Returns the variables Resource.</p>
86
87<p class="toc_element">
88 <code><a href="runtimeconfig_v1beta1.projects.configs.waiters.html">waiters()</a></code>
89</p>
90<p class="firstline">Returns the waiters Resource.</p>
91
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#create">create(parent, body=None, requestId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]94<p class="firstline">Creates a new RuntimeConfig resource. The configuration name must be</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]96 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]97<p class="firstline">Deletes a RuntimeConfig resource.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]98<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]99 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]100<p class="firstline">Gets information about a RuntimeConfig resource.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]103<p class="firstline">Gets the access control policy for a resource.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]106<p class="firstline">Lists all the RuntimeConfig resources within project.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]107<p class="toc_element">
108 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
109<p class="firstline">Retrieves the next page of results.</p>
110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]112<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]114 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]115<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
116<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]118<p class="firstline">Updates a RuntimeConfig resource. The configuration must exist beforehand.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]119<h3>Method Details</h3>
120<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]121 <code class="details" id="create">create(parent, body=None, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]122 <pre>Creates a new RuntimeConfig resource. The configuration name must be
123unique within project.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]124
125Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 parent: string, The [project
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127ID](https://support.google.com/cloud/answer/6158840?hl=en&amp;ref_topic=6158848)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]128for this request, in the format `projects/[PROJECT_ID]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]130 The object takes the form of:
131
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]132{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]133 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
134 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]135 "name": "A String", # The resource name of a runtime config. The name must have the format:
136 #
137 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
138 #
139 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 # arbitrary name that matches the
141 # `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.
142 # The length of `[CONFIG_NAME]` must be less than 64 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]143 #
144 # You pick the RuntimeConfig resource name, but the server will validate that
145 # the name adheres to this format. After you create the resource, you cannot
146 # change the resource's name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]148}
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]149
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]150 requestId: string, An optional but recommended unique `request_id`. If the server
151receives two `create()` requests with the same
152`request_id`, then the second request will be ignored and the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]153first resource created and stored in the backend is returned.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]154Empty `request_id` fields are ignored.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]155
156It is responsibility of the client to ensure uniqueness of the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]157`request_id` strings.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]158
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]159`request_id` strings are limited to 64 characters.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
164
165Returns:
166 An object of the form:
167
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]168 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]169 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
170 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]171 "name": "A String", # The resource name of a runtime config. The name must have the format:
172 #
173 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
174 #
175 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 # arbitrary name that matches the
177 # `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.
178 # The length of `[CONFIG_NAME]` must be less than 64 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]179 #
180 # You pick the RuntimeConfig resource name, but the server will validate that
181 # the name adheres to this format. After you create the resource, you cannot
182 # change the resource's name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]184 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]185</div>
186
187<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]188 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]189 <pre>Deletes a RuntimeConfig resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]190
191Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]192 name: string, The RuntimeConfig resource to delete, in the format:
193
194`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
199
200Returns:
201 An object of the form:
202
203 { # A generic empty message that you can re-use to avoid defining duplicated
204 # empty messages in your APIs. A typical example is to use it as the request
205 # or the response type of an API method. For instance:
206 #
207 # service Foo {
208 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
209 # }
210 #
211 # The JSON representation for `Empty` is empty JSON object `{}`.
212 }</pre>
213</div>
214
215<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]216 <code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]217 <pre>Gets information about a RuntimeConfig resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]218
219Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]220 name: string, The name of the RuntimeConfig resource to retrieve, in the format:
221
222`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
227
228Returns:
229 An object of the form:
230
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]231 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]232 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
233 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]234 "name": "A String", # The resource name of a runtime config. The name must have the format:
235 #
236 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
237 #
238 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 # arbitrary name that matches the
240 # `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.
241 # The length of `[CONFIG_NAME]` must be less than 64 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]242 #
243 # You pick the RuntimeConfig resource name, but the server will validate that
244 # the name adheres to this format. After you create the resource, you cannot
245 # change the resource's name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]247 }</pre>
248</div>
249
250<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]251 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]252 <pre>Gets the access control policy for a resource.
253Returns an empty policy if the resource exists and does not have a policy
254set.
255
256Args:
257 resource: string, REQUIRED: The resource for which the policy is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]258See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]259 options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.
260
261Valid values are 0, 1, and 3. Requests specifying an invalid value will be
262rejected.
263
264Requests for policies with any conditional bindings must specify version 3.
265Policies without any conditional bindings may specify any valid value or
266leave the field unset.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]267 x__xgafv: string, V1 error format.
268 Allowed values
269 1 - v1 error format
270 2 - v2 error format
271
272Returns:
273 An object of the form:
274
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]275 { # An Identity and Access Management (IAM) policy, which specifies access
276 # controls for Google Cloud resources.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]277 #
278 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]279 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
280 # `members` to a single `role`. Members can be user accounts, service accounts,
281 # Google groups, and domains (such as G Suite). A `role` is a named list of
282 # permissions; each `role` can be an IAM predefined role or a user-created
283 # custom role.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]284 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]285 # Optionally, a `binding` can specify a `condition`, which is a logical
286 # expression that allows access to a resource only if the expression evaluates
287 # to `true`. A condition can add constraints based on attributes of the
288 # request, the resource, or both.
289 #
290 # **JSON example:**
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]291 #
292 # {
293 # "bindings": [
294 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]295 # "role": "roles/resourcemanager.organizationAdmin",
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]296 # "members": [
297 # "user:mike@example.com",
298 # "group:admins@example.com",
299 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]300 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]301 # ]
302 # },
303 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 # "role": "roles/resourcemanager.organizationViewer",
305 # "members": ["user:eve@example.com"],
306 # "condition": {
307 # "title": "expirable access",
308 # "description": "Does not grant access after Sep 2020",
309 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
310 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]311 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]312 # ],
313 # "etag": "BwWWja0YfJA=",
314 # "version": 3
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]315 # }
316 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]317 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318 #
319 # bindings:
320 # - members:
321 # - user:mike@example.com
322 # - group:admins@example.com
323 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]324 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
325 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]327 # - user:eve@example.com
328 # role: roles/resourcemanager.organizationViewer
329 # condition:
330 # title: expirable access
331 # description: Does not grant access after Sep 2020
332 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
333 # - etag: BwWWja0YfJA=
334 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]336 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]337 # [IAM documentation](https://cloud.google.com/iam/docs/).
338 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
339 # `condition` that determines how and when the `bindings` are applied. Each
340 # of the `bindings` must contain at least one member.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]341 { # Associates `members` with a `role`.
342 "role": "A String", # Role that is assigned to `members`.
343 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]344 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
345 # `members` can have the following values:
346 #
347 # * `allUsers`: A special identifier that represents anyone who is
348 # on the internet; with or without a Google account.
349 #
350 # * `allAuthenticatedUsers`: A special identifier that represents anyone
351 # who is authenticated with a Google account or a service account.
352 #
353 # * `user:{emailid}`: An email address that represents a specific Google
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354 # account. For example, `alice@example.com` .
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]355 #
356 #
357 # * `serviceAccount:{emailid}`: An email address that represents a service
358 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
359 #
360 # * `group:{emailid}`: An email address that represents a Google group.
361 # For example, `admins@example.com`.
362 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]363 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
364 # identifier) representing a user that has been recently deleted. For
365 # example, `alice@example.com?uid=123456789012345678901`. If the user is
366 # recovered, this value reverts to `user:{emailid}` and the recovered user
367 # retains the role in the binding.
368 #
369 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
370 # unique identifier) representing a service account that has been recently
371 # deleted. For example,
372 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
373 # If the service account is undeleted, this value reverts to
374 # `serviceAccount:{emailid}` and the undeleted service account retains the
375 # role in the binding.
376 #
377 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
378 # identifier) representing a Google group that has been recently
379 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
380 # the group is recovered, this value reverts to `group:{emailid}` and the
381 # recovered group retains the role in the binding.
382 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]383 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]384 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]385 # users of that domain. For example, `google.com` or `example.com`.
386 #
387 "A String",
388 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]389 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 # NOTE: An unsatisfied condition will not allow user access via current
391 # binding. Different bindings, including their conditions, are examined
392 # independently.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]393 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
394 # are documented at https://github.com/google/cel-spec.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]395 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]396 # Example (Comparison):
397 #
398 # title: "Summary size limit"
399 # description: "Determines if a summary is less than 100 chars"
400 # expression: "document.summary.size() &lt; 100"
401 #
402 # Example (Equality):
403 #
404 # title: "Requestor is owner"
405 # description: "Determines if requestor is the document owner"
406 # expression: "document.owner == request.auth.claims.email"
407 #
408 # Example (Logic):
409 #
410 # title: "Public documents"
411 # description: "Determine whether the document should be publicly visible"
412 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
413 #
414 # Example (Data Manipulation):
415 #
416 # title: "Notification string"
417 # description: "Create a notification string with a timestamp."
418 # expression: "'New message received at ' + string(document.create_time)"
419 #
420 # The exact variables and functions that may be referenced within an expression
421 # are determined by the service that evaluates it. See the service
422 # documentation for additional information.
423 "description": "A String", # Optional. Description of the expression. This is a longer text which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424 # describes the expression, e.g. when hovered over it in a UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]425 "expression": "A String", # Textual representation of an expression in Common Expression Language
426 # syntax.
427 "location": "A String", # Optional. String indicating the location of the expression for error
428 # reporting, e.g. a file name and a position in the file.
429 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]430 # its purpose. This can be used e.g. in UIs which allow to enter the
431 # expression.
432 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]433 },
434 ],
435 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
436 # prevent simultaneous updates of a policy from overwriting each other.
437 # It is strongly suggested that systems make use of the `etag` in the
438 # read-modify-write cycle to perform policy updates in order to avoid race
439 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
440 # systems are expected to put that etag in the request to `setIamPolicy` to
441 # ensure that their change will be applied to the same version of the policy.
442 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]443 # **Important:** If you use IAM Conditions, you must include the `etag` field
444 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
445 # you to overwrite a version `3` policy with a version `1` policy, and all of
446 # the conditions in the version `3` policy are lost.
447 "version": 42, # Specifies the format of the policy.
448 #
449 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
450 # are rejected.
451 #
452 # Any operation that affects conditional role bindings must specify version
453 # `3`. This requirement applies to the following operations:
454 #
455 # * Getting a policy that includes a conditional role binding
456 # * Adding a conditional role binding to a policy
457 # * Changing a conditional role binding in a policy
458 # * Removing any role binding, with or without a condition, from a policy
459 # that includes conditions
460 #
461 # **Important:** If you use IAM Conditions, you must include the `etag` field
462 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
463 # you to overwrite a version `3` policy with a version `1` policy, and all of
464 # the conditions in the version `3` policy are lost.
465 #
466 # If a policy does not include any conditions, operations on that policy may
467 # specify any valid version or leave the field unset.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]468 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]469</div>
470
471<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]472 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]473 <pre>Lists all the RuntimeConfig resources within project.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]474
475Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]476 parent: string, The [project
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]477ID](https://support.google.com/cloud/answer/6158840?hl=en&amp;ref_topic=6158848)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]478for this request, in the format `projects/[PROJECT_ID]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]479 pageSize: integer, Specifies the number of results to return per page. If there are fewer
480elements than the specified number, returns all elements.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]481 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
482returned by a previous list request to get the next page of results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]483 x__xgafv: string, V1 error format.
484 Allowed values
485 1 - v1 error format
486 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]487
488Returns:
489 An object of the form:
490
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]491 { # `ListConfigs()` returns the following response. The order of returned
492 # objects is arbitrary; that is, it is not ordered in any particular way.
493 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
494 # If the number of results is larger than `pageSize`, use the `nextPageToken`
495 # as a value for the query parameter `pageToken` in the next list request.
496 # Subsequent list requests will have their own `nextPageToken` to continue
497 # paging through the results
498 "configs": [ # A list of the configurations in the project. The order of returned
499 # objects is arbitrary; that is, it is not ordered in any particular way.
500 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]501 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
502 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]503 "name": "A String", # The resource name of a runtime config. The name must have the format:
504 #
505 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
506 #
507 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]508 # arbitrary name that matches the
509 # `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.
510 # The length of `[CONFIG_NAME]` must be less than 64 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]511 #
512 # You pick the RuntimeConfig resource name, but the server will validate that
513 # the name adheres to this format. After you create the resource, you cannot
514 # change the resource's name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]515 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]516 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]517 ],
518 }</pre>
519</div>
520
521<div class="method">
522 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
523 <pre>Retrieves the next page of results.
524
525Args:
526 previous_request: The request for the previous page. (required)
527 previous_response: The response from the request for the previous page. (required)
528
529Returns:
530 A request object that you can call 'execute()' on to request the next
531 page. Returns None if there are no more items in the collection.
532 </pre>
533</div>
534
535<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]536 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]537 <pre>Sets the access control policy on the specified resource. Replaces any
538existing policy.
539
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]540Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
541
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]542Args:
543 resource: string, REQUIRED: The resource for which the policy is being specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]544See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]545 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]546 The object takes the form of:
547
548{ # Request message for `SetIamPolicy` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]549 "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]550 # the policy is limited to a few 10s of KB. An empty policy is a
551 # valid policy but certain Cloud Platform services (such as Projects)
552 # might reject them.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]553 # controls for Google Cloud resources.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]554 #
555 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]556 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
557 # `members` to a single `role`. Members can be user accounts, service accounts,
558 # Google groups, and domains (such as G Suite). A `role` is a named list of
559 # permissions; each `role` can be an IAM predefined role or a user-created
560 # custom role.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]561 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]562 # Optionally, a `binding` can specify a `condition`, which is a logical
563 # expression that allows access to a resource only if the expression evaluates
564 # to `true`. A condition can add constraints based on attributes of the
565 # request, the resource, or both.
566 #
567 # **JSON example:**
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]568 #
569 # {
570 # "bindings": [
571 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]572 # "role": "roles/resourcemanager.organizationAdmin",
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]573 # "members": [
574 # "user:mike@example.com",
575 # "group:admins@example.com",
576 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]577 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]578 # ]
579 # },
580 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]581 # "role": "roles/resourcemanager.organizationViewer",
582 # "members": ["user:eve@example.com"],
583 # "condition": {
584 # "title": "expirable access",
585 # "description": "Does not grant access after Sep 2020",
586 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
587 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]588 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]589 # ],
590 # "etag": "BwWWja0YfJA=",
591 # "version": 3
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]592 # }
593 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]594 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]595 #
596 # bindings:
597 # - members:
598 # - user:mike@example.com
599 # - group:admins@example.com
600 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]601 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
602 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]603 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]604 # - user:eve@example.com
605 # role: roles/resourcemanager.organizationViewer
606 # condition:
607 # title: expirable access
608 # description: Does not grant access after Sep 2020
609 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
610 # - etag: BwWWja0YfJA=
611 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]612 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]613 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]614 # [IAM documentation](https://cloud.google.com/iam/docs/).
615 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
616 # `condition` that determines how and when the `bindings` are applied. Each
617 # of the `bindings` must contain at least one member.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]618 { # Associates `members` with a `role`.
619 "role": "A String", # Role that is assigned to `members`.
620 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]621 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
622 # `members` can have the following values:
623 #
624 # * `allUsers`: A special identifier that represents anyone who is
625 # on the internet; with or without a Google account.
626 #
627 # * `allAuthenticatedUsers`: A special identifier that represents anyone
628 # who is authenticated with a Google account or a service account.
629 #
630 # * `user:{emailid}`: An email address that represents a specific Google
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]631 # account. For example, `alice@example.com` .
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]632 #
633 #
634 # * `serviceAccount:{emailid}`: An email address that represents a service
635 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
636 #
637 # * `group:{emailid}`: An email address that represents a Google group.
638 # For example, `admins@example.com`.
639 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]640 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
641 # identifier) representing a user that has been recently deleted. For
642 # example, `alice@example.com?uid=123456789012345678901`. If the user is
643 # recovered, this value reverts to `user:{emailid}` and the recovered user
644 # retains the role in the binding.
645 #
646 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
647 # unique identifier) representing a service account that has been recently
648 # deleted. For example,
649 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
650 # If the service account is undeleted, this value reverts to
651 # `serviceAccount:{emailid}` and the undeleted service account retains the
652 # role in the binding.
653 #
654 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
655 # identifier) representing a Google group that has been recently
656 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
657 # the group is recovered, this value reverts to `group:{emailid}` and the
658 # recovered group retains the role in the binding.
659 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]660 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]661 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]662 # users of that domain. For example, `google.com` or `example.com`.
663 #
664 "A String",
665 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]666 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]667 # NOTE: An unsatisfied condition will not allow user access via current
668 # binding. Different bindings, including their conditions, are examined
669 # independently.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]670 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
671 # are documented at https://github.com/google/cel-spec.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]672 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]673 # Example (Comparison):
674 #
675 # title: "Summary size limit"
676 # description: "Determines if a summary is less than 100 chars"
677 # expression: "document.summary.size() &lt; 100"
678 #
679 # Example (Equality):
680 #
681 # title: "Requestor is owner"
682 # description: "Determines if requestor is the document owner"
683 # expression: "document.owner == request.auth.claims.email"
684 #
685 # Example (Logic):
686 #
687 # title: "Public documents"
688 # description: "Determine whether the document should be publicly visible"
689 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
690 #
691 # Example (Data Manipulation):
692 #
693 # title: "Notification string"
694 # description: "Create a notification string with a timestamp."
695 # expression: "'New message received at ' + string(document.create_time)"
696 #
697 # The exact variables and functions that may be referenced within an expression
698 # are determined by the service that evaluates it. See the service
699 # documentation for additional information.
700 "description": "A String", # Optional. Description of the expression. This is a longer text which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]701 # describes the expression, e.g. when hovered over it in a UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]702 "expression": "A String", # Textual representation of an expression in Common Expression Language
703 # syntax.
704 "location": "A String", # Optional. String indicating the location of the expression for error
705 # reporting, e.g. a file name and a position in the file.
706 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]707 # its purpose. This can be used e.g. in UIs which allow to enter the
708 # expression.
709 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]710 },
711 ],
712 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
713 # prevent simultaneous updates of a policy from overwriting each other.
714 # It is strongly suggested that systems make use of the `etag` in the
715 # read-modify-write cycle to perform policy updates in order to avoid race
716 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
717 # systems are expected to put that etag in the request to `setIamPolicy` to
718 # ensure that their change will be applied to the same version of the policy.
719 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]720 # **Important:** If you use IAM Conditions, you must include the `etag` field
721 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
722 # you to overwrite a version `3` policy with a version `1` policy, and all of
723 # the conditions in the version `3` policy are lost.
724 "version": 42, # Specifies the format of the policy.
725 #
726 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
727 # are rejected.
728 #
729 # Any operation that affects conditional role bindings must specify version
730 # `3`. This requirement applies to the following operations:
731 #
732 # * Getting a policy that includes a conditional role binding
733 # * Adding a conditional role binding to a policy
734 # * Changing a conditional role binding in a policy
735 # * Removing any role binding, with or without a condition, from a policy
736 # that includes conditions
737 #
738 # **Important:** If you use IAM Conditions, you must include the `etag` field
739 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
740 # you to overwrite a version `3` policy with a version `1` policy, and all of
741 # the conditions in the version `3` policy are lost.
742 #
743 # If a policy does not include any conditions, operations on that policy may
744 # specify any valid version or leave the field unset.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]745 },
746 }
747
748 x__xgafv: string, V1 error format.
749 Allowed values
750 1 - v1 error format
751 2 - v2 error format
752
753Returns:
754 An object of the form:
755
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]756 { # An Identity and Access Management (IAM) policy, which specifies access
757 # controls for Google Cloud resources.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]758 #
759 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]760 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
761 # `members` to a single `role`. Members can be user accounts, service accounts,
762 # Google groups, and domains (such as G Suite). A `role` is a named list of
763 # permissions; each `role` can be an IAM predefined role or a user-created
764 # custom role.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]765 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]766 # Optionally, a `binding` can specify a `condition`, which is a logical
767 # expression that allows access to a resource only if the expression evaluates
768 # to `true`. A condition can add constraints based on attributes of the
769 # request, the resource, or both.
770 #
771 # **JSON example:**
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]772 #
773 # {
774 # "bindings": [
775 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]776 # "role": "roles/resourcemanager.organizationAdmin",
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]777 # "members": [
778 # "user:mike@example.com",
779 # "group:admins@example.com",
780 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]781 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]782 # ]
783 # },
784 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]785 # "role": "roles/resourcemanager.organizationViewer",
786 # "members": ["user:eve@example.com"],
787 # "condition": {
788 # "title": "expirable access",
789 # "description": "Does not grant access after Sep 2020",
790 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
791 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]792 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]793 # ],
794 # "etag": "BwWWja0YfJA=",
795 # "version": 3
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]796 # }
797 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]798 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]799 #
800 # bindings:
801 # - members:
802 # - user:mike@example.com
803 # - group:admins@example.com
804 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]805 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
806 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]807 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]808 # - user:eve@example.com
809 # role: roles/resourcemanager.organizationViewer
810 # condition:
811 # title: expirable access
812 # description: Does not grant access after Sep 2020
813 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
814 # - etag: BwWWja0YfJA=
815 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]816 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]817 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]818 # [IAM documentation](https://cloud.google.com/iam/docs/).
819 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
820 # `condition` that determines how and when the `bindings` are applied. Each
821 # of the `bindings` must contain at least one member.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]822 { # Associates `members` with a `role`.
823 "role": "A String", # Role that is assigned to `members`.
824 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]825 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
826 # `members` can have the following values:
827 #
828 # * `allUsers`: A special identifier that represents anyone who is
829 # on the internet; with or without a Google account.
830 #
831 # * `allAuthenticatedUsers`: A special identifier that represents anyone
832 # who is authenticated with a Google account or a service account.
833 #
834 # * `user:{emailid}`: An email address that represents a specific Google
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]835 # account. For example, `alice@example.com` .
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]836 #
837 #
838 # * `serviceAccount:{emailid}`: An email address that represents a service
839 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
840 #
841 # * `group:{emailid}`: An email address that represents a Google group.
842 # For example, `admins@example.com`.
843 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]844 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
845 # identifier) representing a user that has been recently deleted. For
846 # example, `alice@example.com?uid=123456789012345678901`. If the user is
847 # recovered, this value reverts to `user:{emailid}` and the recovered user
848 # retains the role in the binding.
849 #
850 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
851 # unique identifier) representing a service account that has been recently
852 # deleted. For example,
853 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
854 # If the service account is undeleted, this value reverts to
855 # `serviceAccount:{emailid}` and the undeleted service account retains the
856 # role in the binding.
857 #
858 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
859 # identifier) representing a Google group that has been recently
860 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
861 # the group is recovered, this value reverts to `group:{emailid}` and the
862 # recovered group retains the role in the binding.
863 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]864 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]865 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]866 # users of that domain. For example, `google.com` or `example.com`.
867 #
868 "A String",
869 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]870 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]871 # NOTE: An unsatisfied condition will not allow user access via current
872 # binding. Different bindings, including their conditions, are examined
873 # independently.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]874 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
875 # are documented at https://github.com/google/cel-spec.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]876 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]877 # Example (Comparison):
878 #
879 # title: "Summary size limit"
880 # description: "Determines if a summary is less than 100 chars"
881 # expression: "document.summary.size() &lt; 100"
882 #
883 # Example (Equality):
884 #
885 # title: "Requestor is owner"
886 # description: "Determines if requestor is the document owner"
887 # expression: "document.owner == request.auth.claims.email"
888 #
889 # Example (Logic):
890 #
891 # title: "Public documents"
892 # description: "Determine whether the document should be publicly visible"
893 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
894 #
895 # Example (Data Manipulation):
896 #
897 # title: "Notification string"
898 # description: "Create a notification string with a timestamp."
899 # expression: "'New message received at ' + string(document.create_time)"
900 #
901 # The exact variables and functions that may be referenced within an expression
902 # are determined by the service that evaluates it. See the service
903 # documentation for additional information.
904 "description": "A String", # Optional. Description of the expression. This is a longer text which
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]905 # describes the expression, e.g. when hovered over it in a UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]906 "expression": "A String", # Textual representation of an expression in Common Expression Language
907 # syntax.
908 "location": "A String", # Optional. String indicating the location of the expression for error
909 # reporting, e.g. a file name and a position in the file.
910 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]911 # its purpose. This can be used e.g. in UIs which allow to enter the
912 # expression.
913 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]914 },
915 ],
916 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
917 # prevent simultaneous updates of a policy from overwriting each other.
918 # It is strongly suggested that systems make use of the `etag` in the
919 # read-modify-write cycle to perform policy updates in order to avoid race
920 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
921 # systems are expected to put that etag in the request to `setIamPolicy` to
922 # ensure that their change will be applied to the same version of the policy.
923 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]924 # **Important:** If you use IAM Conditions, you must include the `etag` field
925 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
926 # you to overwrite a version `3` policy with a version `1` policy, and all of
927 # the conditions in the version `3` policy are lost.
928 "version": 42, # Specifies the format of the policy.
929 #
930 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
931 # are rejected.
932 #
933 # Any operation that affects conditional role bindings must specify version
934 # `3`. This requirement applies to the following operations:
935 #
936 # * Getting a policy that includes a conditional role binding
937 # * Adding a conditional role binding to a policy
938 # * Changing a conditional role binding in a policy
939 # * Removing any role binding, with or without a condition, from a policy
940 # that includes conditions
941 #
942 # **Important:** If you use IAM Conditions, you must include the `etag` field
943 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
944 # you to overwrite a version `3` policy with a version `1` policy, and all of
945 # the conditions in the version `3` policy are lost.
946 #
947 # If a policy does not include any conditions, operations on that policy may
948 # specify any valid version or leave the field unset.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]949 }</pre>
950</div>
951
952<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]953 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]954 <pre>Returns permissions that a caller has on the specified resource.
955If the resource does not exist, this will return an empty set of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]956permissions, not a `NOT_FOUND` error.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]957
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]958Note: This operation is designed to be used for building permission-aware
959UIs and command-line tools, not for authorization checking. This operation
960may "fail open" without warning.
961
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]962Args:
963 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]964See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]965 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]966 The object takes the form of:
967
968{ # Request message for `TestIamPermissions` method.
969 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
970 # wildcards (such as '*' or 'storage.*') are not allowed. For more
971 # information see
972 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
973 "A String",
974 ],
975 }
976
977 x__xgafv: string, V1 error format.
978 Allowed values
979 1 - v1 error format
980 2 - v2 error format
981
982Returns:
983 An object of the form:
984
985 { # Response message for `TestIamPermissions` method.
986 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
987 # allowed.
988 "A String",
989 ],
990 }</pre>
991</div>
992
993<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]994 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]995 <pre>Updates a RuntimeConfig resource. The configuration must exist beforehand.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]996
997Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]998 name: string, The name of the RuntimeConfig resource to update, in the format:
999
1000`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1001 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1002 The object takes the form of:
1003
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1004{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1005 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
1006 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1007 "name": "A String", # The resource name of a runtime config. The name must have the format:
1008 #
1009 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
1010 #
1011 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1012 # arbitrary name that matches the
1013 # `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.
1014 # The length of `[CONFIG_NAME]` must be less than 64 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1015 #
1016 # You pick the RuntimeConfig resource name, but the server will validate that
1017 # the name adheres to this format. After you create the resource, you cannot
1018 # change the resource's name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1019 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1020}
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1021
1022 x__xgafv: string, V1 error format.
1023 Allowed values
1024 1 - v1 error format
1025 2 - v2 error format
1026
1027Returns:
1028 An object of the form:
1029
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1030 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1031 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
1032 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1033 "name": "A String", # The resource name of a runtime config. The name must have the format:
1034 #
1035 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
1036 #
1037 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1038 # arbitrary name that matches the
1039 # `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.
1040 # The length of `[CONFIG_NAME]` must be less than 64 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1041 #
1042 # You pick the RuntimeConfig resource name, but the server will validate that
1043 # the name adheres to this format. After you create the resource, you cannot
1044 # change the resource's name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1045 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1046 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1047</div>
1048
1049</body></html>