Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.variables.html
blob: 680a0e233fd19ec05c4eb587ce1e93b976f6062a [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> . <a href="runtimeconfig_v1beta1.projects.configs.variables.html">variables</a></h1>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <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]79<p class="firstline">Creates a variable within the given configuration. You cannot create</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#delete">delete(name, recursive=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]82<p class="firstline">Deletes a variable or multiple variables.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]85<p class="firstline">Gets information about a single variable.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(parent, filter=None, pageToken=None, returnValues=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Lists variables within given a configuration, matching any provided</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <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]94<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]97<p class="firstline">Updates an existing variable with a new value.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code><a href="#watch">watch(name, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]100<p class="firstline">Watches a specific variable and waits for a change in the variable's value.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 <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]104 <pre>Creates a variable within the given configuration. You cannot create
105a variable with a name that is a prefix of an existing variable name, or a
106name that has an existing variable name as a prefix.
107
108To learn more about creating a variable, read the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109[Setting and Getting
110Data](/deployment-manager/runtime-configurator/set-and-get-variables)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]111documentation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]112
113Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]114 parent: string, The path to the RutimeConfig resource that this variable should belong to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115The configuration must exist beforehand; the path must be in the format:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]116
117`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]119 The object takes the form of:
120
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]121{ # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 # The name denotes the hierarchical variable name. For example,
123 # `ports/serving_port` is a valid variable name. The variable value is an
124 # opaque string and only leaf variables can have values (that is, variables
125 # that do not have any child variables).
126 &quot;value&quot;: &quot;A String&quot;, # The binary value of the variable. The length of the value must be less
127 # than 4096 bytes. Empty values are also accepted. The value must be
128 # base64 encoded, and must comply with IETF RFC4648
129 # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
130 # can be set.
131 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the last variable update.
132 # Timestamp will be UTC timestamp.
133 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the variable. The variable state
134 # indicates the outcome of the `variables().watch` call and is visible
135 # through the `get` and `list` calls.
136 &quot;name&quot;: &quot;A String&quot;, # The name of the variable resource, in the format:
137 #
138 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
139 #
140 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
141 # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
142 # file path naming.
143 #
144 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
145 # dashes. Slashes are used as path element separators and are not part of the
146 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
147 # non-slash character. Multiple slashes are coalesced into single slash
148 # character. Each path segment should match
149 # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
150 # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
151 #
152 # Once you create a variable, you cannot change the variable name.
153 &quot;text&quot;: &quot;A String&quot;, # The string value of the variable. The length of the value must be less
154 # than 4096 bytes. Empty values are also accepted. For example,
155 # `text: &quot;my text value&quot;`. The string must be valid UTF-8.
156 }
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]157
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]158 requestId: string, An optional but recommended unique `request_id`. If the server
159receives two `create()` requests with the same
160`request_id`, then the second request will be ignored and the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]161first resource created and stored in the backend is returned.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]162Empty `request_id` fields are ignored.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]163
164It is responsibility of the client to ensure uniqueness of the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]165`request_id` strings.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]166
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]167`request_id` strings are limited to 64 characters.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173Returns:
174 An object of the form:
175
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]176 { # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 # The name denotes the hierarchical variable name. For example,
178 # `ports/serving_port` is a valid variable name. The variable value is an
179 # opaque string and only leaf variables can have values (that is, variables
180 # that do not have any child variables).
181 &quot;value&quot;: &quot;A String&quot;, # The binary value of the variable. The length of the value must be less
182 # than 4096 bytes. Empty values are also accepted. The value must be
183 # base64 encoded, and must comply with IETF RFC4648
184 # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
185 # can be set.
186 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the last variable update.
187 # Timestamp will be UTC timestamp.
188 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the variable. The variable state
189 # indicates the outcome of the `variables().watch` call and is visible
190 # through the `get` and `list` calls.
191 &quot;name&quot;: &quot;A String&quot;, # The name of the variable resource, in the format:
192 #
193 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
194 #
195 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
196 # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
197 # file path naming.
198 #
199 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
200 # dashes. Slashes are used as path element separators and are not part of the
201 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
202 # non-slash character. Multiple slashes are coalesced into single slash
203 # character. Each path segment should match
204 # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
205 # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
206 #
207 # Once you create a variable, you cannot change the variable name.
208 &quot;text&quot;: &quot;A String&quot;, # The string value of the variable. The length of the value must be less
209 # than 4096 bytes. Empty values are also accepted. For example,
210 # `text: &quot;my text value&quot;`. The string must be valid UTF-8.
211 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]212</div>
213
214<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]215 <code class="details" id="delete">delete(name, recursive=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]216 <pre>Deletes a variable or multiple variables.
217
218If you specify a variable name, then that variable is deleted. If you
219specify a prefix and `recursive` is true, then all variables with that
220prefix are deleted. You must set a `recursive` to true if you delete
221variables by prefix.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]222
223Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]224 name: string, The name of the variable to delete, in the format:
225
226`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]227 recursive: boolean, Set to `true` to recursively delete multiple variables with the same
228prefix.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]229 x__xgafv: string, V1 error format.
230 Allowed values
231 1 - v1 error format
232 2 - v2 error format
233
234Returns:
235 An object of the form:
236
237 { # A generic empty message that you can re-use to avoid defining duplicated
238 # empty messages in your APIs. A typical example is to use it as the request
239 # or the response type of an API method. For instance:
240 #
241 # service Foo {
242 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
243 # }
244 #
245 # The JSON representation for `Empty` is empty JSON object `{}`.
246 }</pre>
247</div>
248
249<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]250 <code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]251 <pre>Gets information about a single variable.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]252
253Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]254 name: string, The name of the variable to return, in the format:
255
256`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]257 x__xgafv: string, V1 error format.
258 Allowed values
259 1 - v1 error format
260 2 - v2 error format
261
262Returns:
263 An object of the form:
264
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]265 { # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]266 # The name denotes the hierarchical variable name. For example,
267 # `ports/serving_port` is a valid variable name. The variable value is an
268 # opaque string and only leaf variables can have values (that is, variables
269 # that do not have any child variables).
270 &quot;value&quot;: &quot;A String&quot;, # The binary value of the variable. The length of the value must be less
271 # than 4096 bytes. Empty values are also accepted. The value must be
272 # base64 encoded, and must comply with IETF RFC4648
273 # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
274 # can be set.
275 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the last variable update.
276 # Timestamp will be UTC timestamp.
277 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the variable. The variable state
278 # indicates the outcome of the `variables().watch` call and is visible
279 # through the `get` and `list` calls.
280 &quot;name&quot;: &quot;A String&quot;, # The name of the variable resource, in the format:
281 #
282 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
283 #
284 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
285 # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
286 # file path naming.
287 #
288 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
289 # dashes. Slashes are used as path element separators and are not part of the
290 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
291 # non-slash character. Multiple slashes are coalesced into single slash
292 # character. Each path segment should match
293 # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
294 # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
295 #
296 # Once you create a variable, you cannot change the variable name.
297 &quot;text&quot;: &quot;A String&quot;, # The string value of the variable. The length of the value must be less
298 # than 4096 bytes. Empty values are also accepted. For example,
299 # `text: &quot;my text value&quot;`. The string must be valid UTF-8.
300 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]301</div>
302
303<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]304 <code class="details" id="list">list(parent, filter=None, pageToken=None, returnValues=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 <pre>Lists variables within given a configuration, matching any provided
306filters. This only lists variable names, not the values, unless
307`return_values` is true, in which case only variables that user has IAM
308permission to GetVariable will be returned.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]309
310Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 parent: string, The path to the RuntimeConfig resource for which you want to list
312variables. The configuration must exist beforehand; the path must be in the
313format:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]314
315`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]316 filter: string, Filters variables by matching the specified filter. For example:
317
318`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.
319 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
320returned by a previous list request to get the next page of results.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]321 returnValues: boolean, The flag indicates whether the user wants to return values of variables.
322If true, then only those variables that user has IAM GetVariable permission
323will be returned along with their values.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]324 pageSize: integer, Specifies the number of results to return per page. If there are fewer
325elements than the specified number, returns all elements.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]326 x__xgafv: string, V1 error format.
327 Allowed values
328 1 - v1 error format
329 2 - v2 error format
330
331Returns:
332 An object of the form:
333
334 { # Response for the `ListVariables()` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]335 &quot;variables&quot;: [ # A list of variables and their values. The order of returned variable
336 # objects is arbitrary.
337 { # Describes a single variable within a RuntimeConfig resource.
338 # The name denotes the hierarchical variable name. For example,
339 # `ports/serving_port` is a valid variable name. The variable value is an
340 # opaque string and only leaf variables can have values (that is, variables
341 # that do not have any child variables).
342 &quot;value&quot;: &quot;A String&quot;, # The binary value of the variable. The length of the value must be less
343 # than 4096 bytes. Empty values are also accepted. The value must be
344 # base64 encoded, and must comply with IETF RFC4648
345 # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
346 # can be set.
347 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the last variable update.
348 # Timestamp will be UTC timestamp.
349 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the variable. The variable state
350 # indicates the outcome of the `variables().watch` call and is visible
351 # through the `get` and `list` calls.
352 &quot;name&quot;: &quot;A String&quot;, # The name of the variable resource, in the format:
353 #
354 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
355 #
356 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
357 # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
358 # file path naming.
359 #
360 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
361 # dashes. Slashes are used as path element separators and are not part of the
362 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
363 # non-slash character. Multiple slashes are coalesced into single slash
364 # character. Each path segment should match
365 # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
366 # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
367 #
368 # Once you create a variable, you cannot change the variable name.
369 &quot;text&quot;: &quot;A String&quot;, # The string value of the variable. The length of the value must be less
370 # than 4096 bytes. Empty values are also accepted. For example,
371 # `text: &quot;my text value&quot;`. The string must be valid UTF-8.
372 },
373 ],
374 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token allows you to get the next page of results for list requests.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]375 # If the number of results is larger than `pageSize`, use the `nextPageToken`
376 # as a value for the query parameter `pageToken` in the next list request.
377 # Subsequent list requests will have their own `nextPageToken` to continue
378 # paging through the results
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]379 }</pre>
380</div>
381
382<div class="method">
383 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
384 <pre>Retrieves the next page of results.
385
386Args:
387 previous_request: The request for the previous page. (required)
388 previous_response: The response from the request for the previous page. (required)
389
390Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]391 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]392 page. Returns None if there are no more items in the collection.
393 </pre>
394</div>
395
396<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]397 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]398 <pre>Returns permissions that a caller has on the specified resource.
399If the resource does not exist, this will return an empty set of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]400permissions, not a `NOT_FOUND` error.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]401
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]402Note: This operation is designed to be used for building permission-aware
403UIs and command-line tools, not for authorization checking. This operation
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]404may &quot;fail open&quot; without warning.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]405
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]406Args:
407 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]408See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]409 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]410 The object takes the form of:
411
412{ # Request message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]413 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with
414 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]415 # information see
416 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]417 &quot;A String&quot;,
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]418 ],
419 }
420
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]421 x__xgafv: string, V1 error format.
422 Allowed values
423 1 - v1 error format
424 2 - v2 error format
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]425
426Returns:
427 An object of the form:
428
429 { # Response message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]430 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]431 # allowed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]432 &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]433 ],
434 }</pre>
435</div>
436
437<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]438 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]439 <pre>Updates an existing variable with a new value.
440
441Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]442 name: string, The name of the variable to update, in the format:
443
444`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]445 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]446 The object takes the form of:
447
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]448{ # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]449 # The name denotes the hierarchical variable name. For example,
450 # `ports/serving_port` is a valid variable name. The variable value is an
451 # opaque string and only leaf variables can have values (that is, variables
452 # that do not have any child variables).
453 &quot;value&quot;: &quot;A String&quot;, # The binary value of the variable. The length of the value must be less
454 # than 4096 bytes. Empty values are also accepted. The value must be
455 # base64 encoded, and must comply with IETF RFC4648
456 # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
457 # can be set.
458 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the last variable update.
459 # Timestamp will be UTC timestamp.
460 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the variable. The variable state
461 # indicates the outcome of the `variables().watch` call and is visible
462 # through the `get` and `list` calls.
463 &quot;name&quot;: &quot;A String&quot;, # The name of the variable resource, in the format:
464 #
465 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
466 #
467 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
468 # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
469 # file path naming.
470 #
471 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
472 # dashes. Slashes are used as path element separators and are not part of the
473 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
474 # non-slash character. Multiple slashes are coalesced into single slash
475 # character. Each path segment should match
476 # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
477 # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
478 #
479 # Once you create a variable, you cannot change the variable name.
480 &quot;text&quot;: &quot;A String&quot;, # The string value of the variable. The length of the value must be less
481 # than 4096 bytes. Empty values are also accepted. For example,
482 # `text: &quot;my text value&quot;`. The string must be valid UTF-8.
483 }
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]484
485 x__xgafv: string, V1 error format.
486 Allowed values
487 1 - v1 error format
488 2 - v2 error format
489
490Returns:
491 An object of the form:
492
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]493 { # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]494 # The name denotes the hierarchical variable name. For example,
495 # `ports/serving_port` is a valid variable name. The variable value is an
496 # opaque string and only leaf variables can have values (that is, variables
497 # that do not have any child variables).
498 &quot;value&quot;: &quot;A String&quot;, # The binary value of the variable. The length of the value must be less
499 # than 4096 bytes. Empty values are also accepted. The value must be
500 # base64 encoded, and must comply with IETF RFC4648
501 # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
502 # can be set.
503 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the last variable update.
504 # Timestamp will be UTC timestamp.
505 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the variable. The variable state
506 # indicates the outcome of the `variables().watch` call and is visible
507 # through the `get` and `list` calls.
508 &quot;name&quot;: &quot;A String&quot;, # The name of the variable resource, in the format:
509 #
510 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
511 #
512 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
513 # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
514 # file path naming.
515 #
516 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
517 # dashes. Slashes are used as path element separators and are not part of the
518 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
519 # non-slash character. Multiple slashes are coalesced into single slash
520 # character. Each path segment should match
521 # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
522 # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
523 #
524 # Once you create a variable, you cannot change the variable name.
525 &quot;text&quot;: &quot;A String&quot;, # The string value of the variable. The length of the value must be less
526 # than 4096 bytes. Empty values are also accepted. For example,
527 # `text: &quot;my text value&quot;`. The string must be valid UTF-8.
528 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]529</div>
530
531<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]532 <code class="details" id="watch">watch(name, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]533 <pre>Watches a specific variable and waits for a change in the variable&#x27;s value.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]534When there is a change, this method returns the new value or times out.
535
536If a variable is deleted while being watched, the `variableState` state is
537set to `DELETED` and the method returns the last known variable `value`.
538
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]539If you set the deadline for watching to a larger value than internal
540timeout (60 seconds), the current variable value is returned and the
541`variableState` will be `VARIABLE_STATE_UNSPECIFIED`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]542
543To learn more about creating a watcher, read the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]544[Watching a Variable for
545Changes](/deployment-manager/runtime-configurator/watching-a-variable)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]546documentation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]547
548Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]549 name: string, The name of the variable to watch, in the format:
550
551`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]552 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]553 The object takes the form of:
554
555{ # Request for the `WatchVariable()` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]556 &quot;newerThan&quot;: &quot;A String&quot;, # If specified, checks the current timestamp of the variable and if the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]557 # current timestamp is newer than `newerThan` timestamp, the method returns
558 # immediately.
559 #
560 # If not specified or the variable has an older timestamp, the watcher waits
561 # for a the value to change before returning.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]562 }
563
564 x__xgafv: string, V1 error format.
565 Allowed values
566 1 - v1 error format
567 2 - v2 error format
568
569Returns:
570 An object of the form:
571
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]572 { # Describes a single variable within a RuntimeConfig resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]573 # The name denotes the hierarchical variable name. For example,
574 # `ports/serving_port` is a valid variable name. The variable value is an
575 # opaque string and only leaf variables can have values (that is, variables
576 # that do not have any child variables).
577 &quot;value&quot;: &quot;A String&quot;, # The binary value of the variable. The length of the value must be less
578 # than 4096 bytes. Empty values are also accepted. The value must be
579 # base64 encoded, and must comply with IETF RFC4648
580 # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
581 # can be set.
582 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the last variable update.
583 # Timestamp will be UTC timestamp.
584 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the variable. The variable state
585 # indicates the outcome of the `variables().watch` call and is visible
586 # through the `get` and `list` calls.
587 &quot;name&quot;: &quot;A String&quot;, # The name of the variable resource, in the format:
588 #
589 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
590 #
591 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
592 # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
593 # file path naming.
594 #
595 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
596 # dashes. Slashes are used as path element separators and are not part of the
597 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
598 # non-slash character. Multiple slashes are coalesced into single slash
599 # character. Each path segment should match
600 # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
601 # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
602 #
603 # Once you create a variable, you cannot change the variable name.
604 &quot;text&quot;: &quot;A String&quot;, # The string value of the variable. The length of the value must be less
605 # than 4096 bytes. Empty values are also accepted. For example,
606 # `text: &quot;my text value&quot;`. The string must be valid UTF-8.
607 }</pre>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]608</div>
609
610</body></html>