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