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