Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.html
blob: fb03b2a75f30f1222be21731227d754dd9a84b90 [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
75<h1><a href="runtimeconfig_v1beta1.html">Google Cloud RuntimeConfig API</a> . <a href="runtimeconfig_v1beta1.projects.html">projects</a> . <a href="runtimeconfig_v1beta1.projects.configs.html">configs</a></h1>
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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]93 <code><a href="#create">create(parent=None, body, 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">
96 <code><a href="#delete">delete(name=None, 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">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]99 <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]102 <code><a href="#getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Gets the access control policy for a resource.</p>
104<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]105 <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]111 <code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
112<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
113<p class="toc_element">
114 <code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
115<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
116<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]117 <code><a href="#update">update(name=None, body, 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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]121 <code class="details" id="create">create(parent=None, body, 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:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]126 parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
127for this request, in the format `projects/[PROJECT_ID]`. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]128 body: object, The request body. (required)
129 The object takes the form of:
130
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]131{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]132 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
133 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]134 "name": "A String", # The resource name of a runtime config. The name must have the format:
135 #
136 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
137 #
138 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
139 # arbitrary name that matches RFC 1035 segment specification. The length of
140 # `[CONFIG_NAME]` must be less than 64 bytes.
141 #
142 # You pick the RuntimeConfig resource name, but the server will validate that
143 # the name adheres to this format. After you create the resource, you cannot
144 # change the resource's name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]145 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]146}
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]147
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]148 requestId: string, An optional but recommended unique `request_id`. If the server
149receives two `create()` requests with the same
150`request_id`, then the second request will be ignored and the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]151first resource created and stored in the backend is returned.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]152Empty `request_id` fields are ignored.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]153
154It is responsibility of the client to ensure uniqueness of the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]155`request_id` strings.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]156
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]157`request_id` strings are limited to 64 characters.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163Returns:
164 An object of the form:
165
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]166 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]167 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
168 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]169 "name": "A String", # The resource name of a runtime config. The name must have the format:
170 #
171 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
172 #
173 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
174 # arbitrary name that matches RFC 1035 segment specification. The length of
175 # `[CONFIG_NAME]` must be less than 64 bytes.
176 #
177 # You pick the RuntimeConfig resource name, but the server will validate that
178 # the name adheres to this format. After you create the resource, you cannot
179 # change the resource's name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]180 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]181 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]182</div>
183
184<div class="method">
185 <code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]186 <pre>Deletes a RuntimeConfig resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]187
188Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]189 name: string, The RuntimeConfig resource to delete, in the format:
190
191`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
196
197Returns:
198 An object of the form:
199
200 { # A generic empty message that you can re-use to avoid defining duplicated
201 # empty messages in your APIs. A typical example is to use it as the request
202 # or the response type of an API method. For instance:
203 #
204 # service Foo {
205 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
206 # }
207 #
208 # The JSON representation for `Empty` is empty JSON object `{}`.
209 }</pre>
210</div>
211
212<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]213 <code class="details" id="get">get(name=None, x__xgafv=None)</code>
214 <pre>Gets information about a RuntimeConfig resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]215
216Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]217 name: string, The name of the RuntimeConfig resource to retrieve, in the format:
218
219`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
224
225Returns:
226 An object of the form:
227
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]228 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]229 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
230 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]231 "name": "A String", # The resource name of a runtime config. The name must have the format:
232 #
233 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
234 #
235 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
236 # arbitrary name that matches RFC 1035 segment specification. The length of
237 # `[CONFIG_NAME]` must be less than 64 bytes.
238 #
239 # You pick the RuntimeConfig resource name, but the server will validate that
240 # the name adheres to this format. After you create the resource, you cannot
241 # change the resource's name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]242 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]243 }</pre>
244</div>
245
246<div class="method">
247 <code class="details" id="getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</code>
248 <pre>Gets the access control policy for a resource.
249Returns an empty policy if the resource exists and does not have a policy
250set.
251
252Args:
253 resource: string, REQUIRED: The resource for which the policy is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]254See the operation documentation for the appropriate value for this field. (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
259
260Returns:
261 An object of the form:
262
263 { # Defines an Identity and Access Management (IAM) policy. It is used to
264 # specify access control policies for Cloud Platform resources.
265 #
266 #
267 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
268 # `members` to a `role`, where the members can be user accounts, Google groups,
269 # Google domains, and service accounts. A `role` is a named list of permissions
270 # defined by IAM.
271 #
272 # **Example**
273 #
274 # {
275 # "bindings": [
276 # {
277 # "role": "roles/owner",
278 # "members": [
279 # "user:mike@example.com",
280 # "group:admins@example.com",
281 # "domain:google.com",
282 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
283 # ]
284 # },
285 # {
286 # "role": "roles/viewer",
287 # "members": ["user:sean@example.com"]
288 # }
289 # ]
290 # }
291 #
292 # For a description of IAM and its features, see the
293 # [IAM developer's guide](https://cloud.google.com/iam).
294 "bindings": [ # Associates a list of `members` to a `role`.
295 # Multiple `bindings` must not be specified for the same `role`.
296 # `bindings` with no members will result in an error.
297 { # Associates `members` with a `role`.
298 "role": "A String", # Role that is assigned to `members`.
299 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
300 # Required
301 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
302 # `members` can have the following values:
303 #
304 # * `allUsers`: A special identifier that represents anyone who is
305 # on the internet; with or without a Google account.
306 #
307 # * `allAuthenticatedUsers`: A special identifier that represents anyone
308 # who is authenticated with a Google account or a service account.
309 #
310 # * `user:{emailid}`: An email address that represents a specific Google
311 # account. For example, `alice@gmail.com` or `joe@example.com`.
312 #
313 #
314 # * `serviceAccount:{emailid}`: An email address that represents a service
315 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
316 #
317 # * `group:{emailid}`: An email address that represents a Google group.
318 # For example, `admins@example.com`.
319 #
320 # * `domain:{domain}`: A Google Apps domain name that represents all the
321 # users of that domain. For example, `google.com` or `example.com`.
322 #
323 "A String",
324 ],
325 },
326 ],
327 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
328 # prevent simultaneous updates of a policy from overwriting each other.
329 # It is strongly suggested that systems make use of the `etag` in the
330 # read-modify-write cycle to perform policy updates in order to avoid race
331 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
332 # systems are expected to put that etag in the request to `setIamPolicy` to
333 # ensure that their change will be applied to the same version of the policy.
334 #
335 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
336 # policy is overwritten blindly.
337 "version": 42, # Version of the `Policy`. The default version is 0.
338 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]339</div>
340
341<div class="method">
342 <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]343 <pre>Lists all the RuntimeConfig resources within project.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]344
345Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]346 parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
347for this request, in the format `projects/[PROJECT_ID]`. (required)
348 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
349returned by a previous list request to get the next page of results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]350 x__xgafv: string, V1 error format.
351 Allowed values
352 1 - v1 error format
353 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]354 pageSize: integer, Specifies the number of results to return per page. If there are fewer
355elements than the specified number, returns all elements.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]356
357Returns:
358 An object of the form:
359
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]360 { # `ListConfigs()` returns the following response. The order of returned
361 # objects is arbitrary; that is, it is not ordered in any particular way.
362 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
363 # If the number of results is larger than `pageSize`, use the `nextPageToken`
364 # as a value for the query parameter `pageToken` in the next list request.
365 # Subsequent list requests will have their own `nextPageToken` to continue
366 # paging through the results
367 "configs": [ # A list of the configurations in the project. The order of returned
368 # objects is arbitrary; that is, it is not ordered in any particular way.
369 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]370 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
371 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]372 "name": "A String", # The resource name of a runtime config. The name must have the format:
373 #
374 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
375 #
376 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
377 # arbitrary name that matches RFC 1035 segment specification. The length of
378 # `[CONFIG_NAME]` must be less than 64 bytes.
379 #
380 # You pick the RuntimeConfig resource name, but the server will validate that
381 # the name adheres to this format. After you create the resource, you cannot
382 # change the resource's name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]383 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]384 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]385 ],
386 }</pre>
387</div>
388
389<div class="method">
390 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
391 <pre>Retrieves the next page of results.
392
393Args:
394 previous_request: The request for the previous page. (required)
395 previous_response: The response from the request for the previous page. (required)
396
397Returns:
398 A request object that you can call 'execute()' on to request the next
399 page. Returns None if there are no more items in the collection.
400 </pre>
401</div>
402
403<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]404 <code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>
405 <pre>Sets the access control policy on the specified resource. Replaces any
406existing policy.
407
408Args:
409 resource: string, REQUIRED: The resource for which the policy is being specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]410See the operation documentation for the appropriate value for this field. (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]411 body: object, The request body. (required)
412 The object takes the form of:
413
414{ # Request message for `SetIamPolicy` method.
415 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
416 # the policy is limited to a few 10s of KB. An empty policy is a
417 # valid policy but certain Cloud Platform services (such as Projects)
418 # might reject them.
419 # specify access control policies for Cloud Platform resources.
420 #
421 #
422 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
423 # `members` to a `role`, where the members can be user accounts, Google groups,
424 # Google domains, and service accounts. A `role` is a named list of permissions
425 # defined by IAM.
426 #
427 # **Example**
428 #
429 # {
430 # "bindings": [
431 # {
432 # "role": "roles/owner",
433 # "members": [
434 # "user:mike@example.com",
435 # "group:admins@example.com",
436 # "domain:google.com",
437 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
438 # ]
439 # },
440 # {
441 # "role": "roles/viewer",
442 # "members": ["user:sean@example.com"]
443 # }
444 # ]
445 # }
446 #
447 # For a description of IAM and its features, see the
448 # [IAM developer's guide](https://cloud.google.com/iam).
449 "bindings": [ # Associates a list of `members` to a `role`.
450 # Multiple `bindings` must not be specified for the same `role`.
451 # `bindings` with no members will result in an error.
452 { # Associates `members` with a `role`.
453 "role": "A String", # Role that is assigned to `members`.
454 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
455 # Required
456 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
457 # `members` can have the following values:
458 #
459 # * `allUsers`: A special identifier that represents anyone who is
460 # on the internet; with or without a Google account.
461 #
462 # * `allAuthenticatedUsers`: A special identifier that represents anyone
463 # who is authenticated with a Google account or a service account.
464 #
465 # * `user:{emailid}`: An email address that represents a specific Google
466 # account. For example, `alice@gmail.com` or `joe@example.com`.
467 #
468 #
469 # * `serviceAccount:{emailid}`: An email address that represents a service
470 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
471 #
472 # * `group:{emailid}`: An email address that represents a Google group.
473 # For example, `admins@example.com`.
474 #
475 # * `domain:{domain}`: A Google Apps domain name that represents all the
476 # users of that domain. For example, `google.com` or `example.com`.
477 #
478 "A String",
479 ],
480 },
481 ],
482 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
483 # prevent simultaneous updates of a policy from overwriting each other.
484 # It is strongly suggested that systems make use of the `etag` in the
485 # read-modify-write cycle to perform policy updates in order to avoid race
486 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
487 # systems are expected to put that etag in the request to `setIamPolicy` to
488 # ensure that their change will be applied to the same version of the policy.
489 #
490 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
491 # policy is overwritten blindly.
492 "version": 42, # Version of the `Policy`. The default version is 0.
493 },
494 }
495
496 x__xgafv: string, V1 error format.
497 Allowed values
498 1 - v1 error format
499 2 - v2 error format
500
501Returns:
502 An object of the form:
503
504 { # Defines an Identity and Access Management (IAM) policy. It is used to
505 # specify access control policies for Cloud Platform resources.
506 #
507 #
508 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
509 # `members` to a `role`, where the members can be user accounts, Google groups,
510 # Google domains, and service accounts. A `role` is a named list of permissions
511 # defined by IAM.
512 #
513 # **Example**
514 #
515 # {
516 # "bindings": [
517 # {
518 # "role": "roles/owner",
519 # "members": [
520 # "user:mike@example.com",
521 # "group:admins@example.com",
522 # "domain:google.com",
523 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
524 # ]
525 # },
526 # {
527 # "role": "roles/viewer",
528 # "members": ["user:sean@example.com"]
529 # }
530 # ]
531 # }
532 #
533 # For a description of IAM and its features, see the
534 # [IAM developer's guide](https://cloud.google.com/iam).
535 "bindings": [ # Associates a list of `members` to a `role`.
536 # Multiple `bindings` must not be specified for the same `role`.
537 # `bindings` with no members will result in an error.
538 { # Associates `members` with a `role`.
539 "role": "A String", # Role that is assigned to `members`.
540 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
541 # Required
542 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
543 # `members` can have the following values:
544 #
545 # * `allUsers`: A special identifier that represents anyone who is
546 # on the internet; with or without a Google account.
547 #
548 # * `allAuthenticatedUsers`: A special identifier that represents anyone
549 # who is authenticated with a Google account or a service account.
550 #
551 # * `user:{emailid}`: An email address that represents a specific Google
552 # account. For example, `alice@gmail.com` or `joe@example.com`.
553 #
554 #
555 # * `serviceAccount:{emailid}`: An email address that represents a service
556 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
557 #
558 # * `group:{emailid}`: An email address that represents a Google group.
559 # For example, `admins@example.com`.
560 #
561 # * `domain:{domain}`: A Google Apps domain name that represents all the
562 # users of that domain. For example, `google.com` or `example.com`.
563 #
564 "A String",
565 ],
566 },
567 ],
568 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
569 # prevent simultaneous updates of a policy from overwriting each other.
570 # It is strongly suggested that systems make use of the `etag` in the
571 # read-modify-write cycle to perform policy updates in order to avoid race
572 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
573 # systems are expected to put that etag in the request to `setIamPolicy` to
574 # ensure that their change will be applied to the same version of the policy.
575 #
576 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
577 # policy is overwritten blindly.
578 "version": 42, # Version of the `Policy`. The default version is 0.
579 }</pre>
580</div>
581
582<div class="method">
583 <code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>
584 <pre>Returns permissions that a caller has on the specified resource.
585If the resource does not exist, this will return an empty set of
586permissions, not a NOT_FOUND error.
587
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]588Note: This operation is designed to be used for building permission-aware
589UIs and command-line tools, not for authorization checking. This operation
590may "fail open" without warning.
591
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]592Args:
593 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]594See the operation documentation for the appropriate value for this field. (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]595 body: object, The request body. (required)
596 The object takes the form of:
597
598{ # Request message for `TestIamPermissions` method.
599 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
600 # wildcards (such as '*' or 'storage.*') are not allowed. For more
601 # information see
602 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
603 "A String",
604 ],
605 }
606
607 x__xgafv: string, V1 error format.
608 Allowed values
609 1 - v1 error format
610 2 - v2 error format
611
612Returns:
613 An object of the form:
614
615 { # Response message for `TestIamPermissions` method.
616 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
617 # allowed.
618 "A String",
619 ],
620 }</pre>
621</div>
622
623<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]624 <code class="details" id="update">update(name=None, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]625 <pre>Updates a RuntimeConfig resource. The configuration must exist beforehand.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]626
627Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]628 name: string, The name of the RuntimeConfig resource to update, in the format:
629
630`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]631 body: object, The request body. (required)
632 The object takes the form of:
633
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]634{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]635 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
636 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]637 "name": "A String", # The resource name of a runtime config. The name must have the format:
638 #
639 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
640 #
641 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
642 # arbitrary name that matches RFC 1035 segment specification. The length of
643 # `[CONFIG_NAME]` must be less than 64 bytes.
644 #
645 # You pick the RuntimeConfig resource name, but the server will validate that
646 # the name adheres to this format. After you create the resource, you cannot
647 # change the resource's name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]648 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]649}
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]650
651 x__xgafv: string, V1 error format.
652 Allowed values
653 1 - v1 error format
654 2 - v2 error format
655
656Returns:
657 An object of the form:
658
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]659 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]660 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
661 # variables.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]662 "name": "A String", # The resource name of a runtime config. The name must have the format:
663 #
664 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
665 #
666 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
667 # arbitrary name that matches RFC 1035 segment specification. The length of
668 # `[CONFIG_NAME]` must be less than 64 bytes.
669 #
670 # You pick the RuntimeConfig resource name, but the server will validate that
671 # the name adheres to this format. After you create the resource, you cannot
672 # change the resource's name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]673 "description": "A String", # An optional description of the RuntimeConfig object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]674 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]675</div>
676
677</body></html>