Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7d5badbac4f925c1867e20b50cf0a1a70a5fb573 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.variables.html
blob: eef113cf3696496cebd5b174fca300974b3c8459 [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> . <a href="runtimeconfig_v1beta1.projects.configs.variables.html">variables</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent=None, body, 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">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]81 <code><a href="#delete">delete(name=None, recursive=None, x__xgafv=None)</a></code></p>
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">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]84 <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
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">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]87 <code><a href="#list">list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists variables within given a configuration, matching any provided filters.</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">
93 <code><a href="#update">update(name=None, body, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates an existing variable with a new value.</p>
95<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]96 <code><a href="#watch">watch(name=None, body, x__xgafv=None)</a></code></p>
97<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]98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]101 <pre>Creates a variable within the given configuration. You cannot create
102a variable with a name that is a prefix of an existing variable name, or a
103name that has an existing variable name as a prefix.
104
105To learn more about creating a variable, read the
106[Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables)
107documentation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]108
109Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]110 parent: string, The path to the RutimeConfig resource that this variable should belong to.
111The configuration must exist beforehand; the path must by in the format:
112
113`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]114 body: object, The request body. (required)
115 The object takes the form of:
116
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]117{ # Describes a single variable within a RuntimeConfig resource.
118 # The name denotes the hierarchical variable name. For example,
119 # `ports/serving_port` is a valid variable name. The variable value is an
120 # opaque string and only leaf variables can have values (that is, variables
121 # that do not have any child variables).
122 "text": "A String", # The textual value of the variable. The length of the value must be less
123 # than 4096 bytes. Empty values are also accepted.
124 # NB: Only one of value and string_value can be set at the same time.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]125 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]126 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
127 # the outcome of the `variables().watch` call and is visible through the
128 # `get` and `list` calls.
129 "value": "A String", # The binary value of the variable. The length of the value must be less
130 # than 4096 bytes. Empty values are also accepted. The value must be
131 # Base64 encoded.
132 # NB: Only one of value and string_value can be set at the same time.
133 "name": "A String", # The name of the variable resource, in the format:
134 #
135 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
136 #
137 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
138 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
139 # file path naming.
140 #
141 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
142 # dashes. Slashes are used as path element separators and are not part of the
143 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
144 # non-slash character. Multiple slashes are coalesced into single slash
145 # character. Each path segment should follow RFC 1035 segment specification.
146 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
147 #
148 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]149}
150
151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156Returns:
157 An object of the form:
158
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]159 { # Describes a single variable within a RuntimeConfig resource.
160 # The name denotes the hierarchical variable name. For example,
161 # `ports/serving_port` is a valid variable name. The variable value is an
162 # opaque string and only leaf variables can have values (that is, variables
163 # that do not have any child variables).
164 "text": "A String", # The textual value of the variable. The length of the value must be less
165 # than 4096 bytes. Empty values are also accepted.
166 # NB: Only one of value and string_value can be set at the same time.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]167 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]168 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
169 # the outcome of the `variables().watch` call and is visible through the
170 # `get` and `list` calls.
171 "value": "A String", # The binary value of the variable. The length of the value must be less
172 # than 4096 bytes. Empty values are also accepted. The value must be
173 # Base64 encoded.
174 # NB: Only one of value and string_value can be set at the same time.
175 "name": "A String", # The name of the variable resource, in the format:
176 #
177 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
178 #
179 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
180 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
181 # file path naming.
182 #
183 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
184 # dashes. Slashes are used as path element separators and are not part of the
185 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
186 # non-slash character. Multiple slashes are coalesced into single slash
187 # character. Each path segment should follow RFC 1035 segment specification.
188 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
189 #
190 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]191 }</pre>
192</div>
193
194<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]195 <code class="details" id="delete">delete(name=None, recursive=None, x__xgafv=None)</code>
196 <pre>Deletes a variable or multiple variables.
197
198If you specify a variable name, then that variable is deleted. If you
199specify a prefix and `recursive` is true, then all variables with that
200prefix are deleted. You must set a `recursive` to true if you delete
201variables by prefix.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]202
203Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]204 name: string, The name of the variable to delete, in the format:
205
206`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
207 recursive: boolean, Set to `true` to recursively delete multiple variables with the same
208prefix.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
213
214Returns:
215 An object of the form:
216
217 { # A generic empty message that you can re-use to avoid defining duplicated
218 # empty messages in your APIs. A typical example is to use it as the request
219 # or the response type of an API method. For instance:
220 #
221 # service Foo {
222 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
223 # }
224 #
225 # The JSON representation for `Empty` is empty JSON object `{}`.
226 }</pre>
227</div>
228
229<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]230 <code class="details" id="get">get(name=None, x__xgafv=None)</code>
231 <pre>Gets information about a single variable.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]232
233Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]234 name: string, The name of the variable to return, in the format:
235
236`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]237 x__xgafv: string, V1 error format.
238 Allowed values
239 1 - v1 error format
240 2 - v2 error format
241
242Returns:
243 An object of the form:
244
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]245 { # Describes a single variable within a RuntimeConfig resource.
246 # The name denotes the hierarchical variable name. For example,
247 # `ports/serving_port` is a valid variable name. The variable value is an
248 # opaque string and only leaf variables can have values (that is, variables
249 # that do not have any child variables).
250 "text": "A String", # The textual value of the variable. The length of the value must be less
251 # than 4096 bytes. Empty values are also accepted.
252 # NB: Only one of value and string_value can be set at the same time.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]253 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]254 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
255 # the outcome of the `variables().watch` call and is visible through the
256 # `get` and `list` calls.
257 "value": "A String", # The binary value of the variable. The length of the value must be less
258 # than 4096 bytes. Empty values are also accepted. The value must be
259 # Base64 encoded.
260 # NB: Only one of value and string_value can be set at the same time.
261 "name": "A String", # The name of the variable resource, in the format:
262 #
263 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
264 #
265 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
266 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
267 # file path naming.
268 #
269 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
270 # dashes. Slashes are used as path element separators and are not part of the
271 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
272 # non-slash character. Multiple slashes are coalesced into single slash
273 # character. Each path segment should follow RFC 1035 segment specification.
274 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
275 #
276 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]277 }</pre>
278</div>
279
280<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]281 <code class="details" id="list">list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
282 <pre>Lists variables within given a configuration, matching any provided filters.
283This only lists variable names, not the values.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]284
285Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]286 parent: string, The path to the RuntimeConfig resource for which you want to list variables.
287The configuration must exist beforehand; the path must by in the format:
288
289`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
290 pageSize: integer, Specifies the number of results to return per page. If there are fewer
291elements than the specified number, returns all elements.
292 filter: string, Filters variables by matching the specified filter. For example:
293
294`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.
295 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
296returned by a previous list request to get the next page of results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]297 x__xgafv: string, V1 error format.
298 Allowed values
299 1 - v1 error format
300 2 - v2 error format
301
302Returns:
303 An object of the form:
304
305 { # Response for the `ListVariables()` method.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]306 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
307 # If the number of results is larger than `pageSize`, use the `nextPageToken`
308 # as a value for the query parameter `pageToken` in the next list request.
309 # Subsequent list requests will have their own `nextPageToken` to continue
310 # paging through the results
311 "variables": [ # A list of variables and their values. The order of returned variable
312 # objects is arbitrary.
313 { # Describes a single variable within a RuntimeConfig resource.
314 # The name denotes the hierarchical variable name. For example,
315 # `ports/serving_port` is a valid variable name. The variable value is an
316 # opaque string and only leaf variables can have values (that is, variables
317 # that do not have any child variables).
318 "text": "A String", # The textual value of the variable. The length of the value must be less
319 # than 4096 bytes. Empty values are also accepted.
320 # NB: Only one of value and string_value can be set at the same time.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]321 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]322 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
323 # the outcome of the `variables().watch` call and is visible through the
324 # `get` and `list` calls.
325 "value": "A String", # The binary value of the variable. The length of the value must be less
326 # than 4096 bytes. Empty values are also accepted. The value must be
327 # Base64 encoded.
328 # NB: Only one of value and string_value can be set at the same time.
329 "name": "A String", # The name of the variable resource, in the format:
330 #
331 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
332 #
333 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
334 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
335 # file path naming.
336 #
337 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
338 # dashes. Slashes are used as path element separators and are not part of the
339 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
340 # non-slash character. Multiple slashes are coalesced into single slash
341 # character. Each path segment should follow RFC 1035 segment specification.
342 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
343 #
344 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]345 },
346 ],
347 }</pre>
348</div>
349
350<div class="method">
351 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
352 <pre>Retrieves the next page of results.
353
354Args:
355 previous_request: The request for the previous page. (required)
356 previous_response: The response from the request for the previous page. (required)
357
358Returns:
359 A request object that you can call 'execute()' on to request the next
360 page. Returns None if there are no more items in the collection.
361 </pre>
362</div>
363
364<div class="method">
365 <code class="details" id="update">update(name=None, body, x__xgafv=None)</code>
366 <pre>Updates an existing variable with a new value.
367
368Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]369 name: string, The name of the variable to update, in the format:
370
371`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]372 body: object, The request body. (required)
373 The object takes the form of:
374
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]375{ # Describes a single variable within a RuntimeConfig resource.
376 # The name denotes the hierarchical variable name. For example,
377 # `ports/serving_port` is a valid variable name. The variable value is an
378 # opaque string and only leaf variables can have values (that is, variables
379 # that do not have any child variables).
380 "text": "A String", # The textual value of the variable. The length of the value must be less
381 # than 4096 bytes. Empty values are also accepted.
382 # NB: Only one of value and string_value can be set at the same time.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]383 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]384 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
385 # the outcome of the `variables().watch` call and is visible through the
386 # `get` and `list` calls.
387 "value": "A String", # The binary value of the variable. The length of the value must be less
388 # than 4096 bytes. Empty values are also accepted. The value must be
389 # Base64 encoded.
390 # NB: Only one of value and string_value can be set at the same time.
391 "name": "A String", # The name of the variable resource, in the format:
392 #
393 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
394 #
395 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
396 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
397 # file path naming.
398 #
399 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
400 # dashes. Slashes are used as path element separators and are not part of the
401 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
402 # non-slash character. Multiple slashes are coalesced into single slash
403 # character. Each path segment should follow RFC 1035 segment specification.
404 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
405 #
406 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]407}
408
409 x__xgafv: string, V1 error format.
410 Allowed values
411 1 - v1 error format
412 2 - v2 error format
413
414Returns:
415 An object of the form:
416
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]417 { # Describes a single variable within a RuntimeConfig resource.
418 # The name denotes the hierarchical variable name. For example,
419 # `ports/serving_port` is a valid variable name. The variable value is an
420 # opaque string and only leaf variables can have values (that is, variables
421 # that do not have any child variables).
422 "text": "A String", # The textual value of the variable. The length of the value must be less
423 # than 4096 bytes. Empty values are also accepted.
424 # NB: Only one of value and string_value can be set at the same time.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]425 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]426 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
427 # the outcome of the `variables().watch` call and is visible through the
428 # `get` and `list` calls.
429 "value": "A String", # The binary value of the variable. The length of the value must be less
430 # than 4096 bytes. Empty values are also accepted. The value must be
431 # Base64 encoded.
432 # NB: Only one of value and string_value can be set at the same time.
433 "name": "A String", # The name of the variable resource, in the format:
434 #
435 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
436 #
437 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
438 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
439 # file path naming.
440 #
441 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
442 # dashes. Slashes are used as path element separators and are not part of the
443 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
444 # non-slash character. Multiple slashes are coalesced into single slash
445 # character. Each path segment should follow RFC 1035 segment specification.
446 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
447 #
448 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]449 }</pre>
450</div>
451
452<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]453 <code class="details" id="watch">watch(name=None, body, x__xgafv=None)</code>
454 <pre>Watches a specific variable and waits for a change in the variable's value.
455When there is a change, this method returns the new value or times out.
456
457If a variable is deleted while being watched, the `variableState` state is
458set to `DELETED` and the method returns the last known variable `value`.
459
460If you set the deadline for watching to a larger value than internal timeout
461(60 seconds), the current variable value is returned and the `variableState`
462will be `VARIABLE_STATE_UNSPECIFIED`.
463
464To learn more about creating a watcher, read the
465[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)
466documentation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]467
468Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]469 name: string, The name of the variable to watch, in the format:
470
471`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]472 body: object, The request body. (required)
473 The object takes the form of:
474
475{ # Request for the `WatchVariable()` method.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]476 "newerThan": "A String", # If specified, checks the current timestamp of the variable and if the
477 # current timestamp is newer than `newerThan` timestamp, the method returns
478 # immediately.
479 #
480 # If not specified or the variable has an older timestamp, the watcher waits
481 # for a the value to change before returning.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]482 }
483
484 x__xgafv: string, V1 error format.
485 Allowed values
486 1 - v1 error format
487 2 - v2 error format
488
489Returns:
490 An object of the form:
491
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]492 { # Describes a single variable within a RuntimeConfig resource.
493 # The name denotes the hierarchical variable name. For example,
494 # `ports/serving_port` is a valid variable name. The variable value is an
495 # opaque string and only leaf variables can have values (that is, variables
496 # that do not have any child variables).
497 "text": "A String", # The textual value of the variable. The length of the value must be less
498 # than 4096 bytes. Empty values are also accepted.
499 # NB: Only one of value and string_value can be set at the same time.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]500 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]501 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
502 # the outcome of the `variables().watch` call and is visible through the
503 # `get` and `list` calls.
504 "value": "A String", # The binary value of the variable. The length of the value must be less
505 # than 4096 bytes. Empty values are also accepted. The value must be
506 # Base64 encoded.
507 # NB: Only one of value and string_value can be set at the same time.
508 "name": "A String", # 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 reource 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 follow RFC 1035 segment specification.
521 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
522 #
523 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]524 }</pre>
525</div>
526
527</body></html>