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