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