File: runtimeconfig_v1beta1.projects.configs.variables.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (610 lines) | stat: -rw-r--r-- 27,982 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<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>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#create">create(parent, body, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a variable within the given configuration. You cannot create</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None, recursive=None)</a></code></p>
<p class="firstline">Deletes a variable or multiple variables.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a single variable.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, returnValues=None, x__xgafv=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Lists variables within given a configuration, matching any provided</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<p class="toc_element">
  <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing variable with a new value.</p>
<p class="toc_element">
  <code><a href="#watch">watch(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">Watches a specific variable and waits for a change in the variable's value.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="create">create(parent, body, requestId=None, x__xgafv=None)</code>
  <pre>Creates a variable within the given configuration. You cannot create
a variable with a name that is a prefix of an existing variable name, or a
name that has an existing variable name as a prefix.

To learn more about creating a variable, read the
[Setting and Getting
Data](/deployment-manager/runtime-configurator/set-and-get-variables)
documentation.

Args:
  parent: string, The path to the RutimeConfig resource that this variable should belong to.
The configuration must exist beforehand; the path must be in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a single variable within a RuntimeConfig resource.
    # The name denotes the hierarchical variable name. For example,
    # `ports/serving_port` is a valid variable name. The variable value is an
    # opaque string and only leaf variables can have values (that is, variables
    # that do not have any child variables).
  "text": "A String", # The string value of the variable. The length of the value must be less
      # than 4096 bytes. Empty values are also accepted. For example,
      # `text: "my text value"`. The string must be valid UTF-8.
  "updateTime": "A String", # Output only. The time of the last variable update.
      # Timestamp will be UTC timestamp.
  "state": "A String", # Output only. The current state of the variable. The variable state
      # indicates the outcome of the `variables().watch` call and is visible
      # through the `get` and `list` calls.
  "value": "A String", # The binary value of the variable. The length of the value must be less
      # than 4096 bytes. Empty values are also accepted. The value must be
      # base64 encoded, and must comply with IETF RFC4648
      # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
      # can be set.
  "name": "A String", # The name of the variable resource, in the format:
      # 
      #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
      # 
      # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
      # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
      # file path naming.
      # 
      # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
      # dashes. Slashes are used as path element separators and are not part of the
      # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
      # non-slash character. Multiple slashes are coalesced into single slash
      # character. Each path segment should match
      # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
      # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
      # 
      # Once you create a variable, you cannot change the variable name.
}

  requestId: string, An optional but recommended unique `request_id`. If the server
receives two `create()` requests  with the same
`request_id`, then the second request will be ignored and the
first resource created and stored in the backend is returned.
Empty `request_id` fields are ignored.

It is responsibility of the client to ensure uniqueness of the
`request_id` strings.

`request_id` strings are limited to 64 characters.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a single variable within a RuntimeConfig resource.
      # The name denotes the hierarchical variable name. For example,
      # `ports/serving_port` is a valid variable name. The variable value is an
      # opaque string and only leaf variables can have values (that is, variables
      # that do not have any child variables).
    "text": "A String", # The string value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. For example,
        # `text: "my text value"`. The string must be valid UTF-8.
    "updateTime": "A String", # Output only. The time of the last variable update.
        # Timestamp will be UTC timestamp.
    "state": "A String", # Output only. The current state of the variable. The variable state
        # indicates the outcome of the `variables().watch` call and is visible
        # through the `get` and `list` calls.
    "value": "A String", # The binary value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. The value must be
        # base64 encoded, and must comply with IETF RFC4648
        # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
        # can be set.
    "name": "A String", # The name of the variable resource, in the format:
        #
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
        #
        # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
        # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
        # file path naming.
        #
        # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
        # dashes. Slashes are used as path element separators and are not part of the
        # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
        # non-slash character. Multiple slashes are coalesced into single slash
        # character. Each path segment should match
        # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
        # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
        #
        # Once you create a variable, you cannot change the variable name.
  }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None, recursive=None)</code>
  <pre>Deletes a variable or multiple variables.

If you specify a variable name, then that variable is deleted. If you
specify a prefix and `recursive` is true, then all variables with that
prefix are deleted. You must set a `recursive` to true if you delete
variables by prefix.

Args:
  name: string, The name of the variable to delete, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  recursive: boolean, Set to `true` to recursively delete multiple variables with the same
prefix.

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets information about a single variable.

Args:
  name: string, The name of the variable to return, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a single variable within a RuntimeConfig resource.
      # The name denotes the hierarchical variable name. For example,
      # `ports/serving_port` is a valid variable name. The variable value is an
      # opaque string and only leaf variables can have values (that is, variables
      # that do not have any child variables).
    "text": "A String", # The string value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. For example,
        # `text: "my text value"`. The string must be valid UTF-8.
    "updateTime": "A String", # Output only. The time of the last variable update.
        # Timestamp will be UTC timestamp.
    "state": "A String", # Output only. The current state of the variable. The variable state
        # indicates the outcome of the `variables().watch` call and is visible
        # through the `get` and `list` calls.
    "value": "A String", # The binary value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. The value must be
        # base64 encoded, and must comply with IETF RFC4648
        # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
        # can be set.
    "name": "A String", # The name of the variable resource, in the format:
        #
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
        #
        # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
        # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
        # file path naming.
        #
        # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
        # dashes. Slashes are used as path element separators and are not part of the
        # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
        # non-slash character. Multiple slashes are coalesced into single slash
        # character. Each path segment should match
        # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
        # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
        #
        # Once you create a variable, you cannot change the variable name.
  }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, returnValues=None, x__xgafv=None, pageToken=None, filter=None)</code>
  <pre>Lists variables within given a configuration, matching any provided
filters. This only lists variable names, not the values, unless
`return_values` is true, in which case only variables that user has IAM
permission to GetVariable will be returned.

Args:
  parent: string, The path to the RuntimeConfig resource for which you want to list
variables. The configuration must exist beforehand; the path must be in the
format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  pageSize: integer, Specifies the number of results to return per page. If there are fewer
elements than the specified number, returns all elements.
  returnValues: boolean, The flag indicates whether the user wants to return values of variables.
If true, then only those variables that user has IAM GetVariable permission
will be returned along with their values.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
returned by a previous list request to get the next page of results.
  filter: string, Filters variables by matching the specified filter. For example:

`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.

Returns:
  An object of the form:

    { # Response for the `ListVariables()` method.
    "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
        # If the number of results is larger than `pageSize`, use the `nextPageToken`
        # as a value for the query parameter `pageToken` in the next list request.
        # Subsequent list requests will have their own `nextPageToken` to continue
        # paging through the results
    "variables": [ # A list of variables and their values. The order of returned variable
        # objects is arbitrary.
      { # Describes a single variable within a RuntimeConfig resource.
          # The name denotes the hierarchical variable name. For example,
          # `ports/serving_port` is a valid variable name. The variable value is an
          # opaque string and only leaf variables can have values (that is, variables
          # that do not have any child variables).
        "text": "A String", # The string value of the variable. The length of the value must be less
            # than 4096 bytes. Empty values are also accepted. For example,
            # `text: "my text value"`. The string must be valid UTF-8.
        "updateTime": "A String", # Output only. The time of the last variable update.
            # Timestamp will be UTC timestamp.
        "state": "A String", # Output only. The current state of the variable. The variable state
            # indicates the outcome of the `variables().watch` call and is visible
            # through the `get` and `list` calls.
        "value": "A String", # The binary value of the variable. The length of the value must be less
            # than 4096 bytes. Empty values are also accepted. The value must be
            # base64 encoded, and must comply with IETF RFC4648
            # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
            # can be set.
        "name": "A String", # The name of the variable resource, in the format:
            #
            #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
            #
            # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
            # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
            # file path naming.
            #
            # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
            # dashes. Slashes are used as path element separators and are not part of the
            # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
            # non-slash character. Multiple slashes are coalesced into single slash
            # character. Each path segment should match
            # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
            # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
            #
            # Once you create a variable, you cannot change the variable name.
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
  <pre>Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware
UIs and command-line tools, not for authorization checking. This operation
may "fail open" without warning.

Args:
  resource: string, REQUIRED: The resource for which the policy detail is being requested.
See the operation documentation for the appropriate value for this field. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for `TestIamPermissions` method.
    "permissions": [ # The set of permissions to check for the `resource`. Permissions with
        # wildcards (such as '*' or 'storage.*') are not allowed. For more
        # information see
        # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
      "A String",
    ],
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for `TestIamPermissions` method.
    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
        # allowed.
      "A String",
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="update">update(name, body, x__xgafv=None)</code>
  <pre>Updates an existing variable with a new value.

Args:
  name: string, The name of the variable to update, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Describes a single variable within a RuntimeConfig resource.
    # The name denotes the hierarchical variable name. For example,
    # `ports/serving_port` is a valid variable name. The variable value is an
    # opaque string and only leaf variables can have values (that is, variables
    # that do not have any child variables).
  "text": "A String", # The string value of the variable. The length of the value must be less
      # than 4096 bytes. Empty values are also accepted. For example,
      # `text: "my text value"`. The string must be valid UTF-8.
  "updateTime": "A String", # Output only. The time of the last variable update.
      # Timestamp will be UTC timestamp.
  "state": "A String", # Output only. The current state of the variable. The variable state
      # indicates the outcome of the `variables().watch` call and is visible
      # through the `get` and `list` calls.
  "value": "A String", # The binary value of the variable. The length of the value must be less
      # than 4096 bytes. Empty values are also accepted. The value must be
      # base64 encoded, and must comply with IETF RFC4648
      # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
      # can be set.
  "name": "A String", # The name of the variable resource, in the format:
      # 
      #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
      # 
      # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
      # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
      # file path naming.
      # 
      # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
      # dashes. Slashes are used as path element separators and are not part of the
      # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
      # non-slash character. Multiple slashes are coalesced into single slash
      # character. Each path segment should match
      # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
      # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
      # 
      # Once you create a variable, you cannot change the variable name.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a single variable within a RuntimeConfig resource.
      # The name denotes the hierarchical variable name. For example,
      # `ports/serving_port` is a valid variable name. The variable value is an
      # opaque string and only leaf variables can have values (that is, variables
      # that do not have any child variables).
    "text": "A String", # The string value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. For example,
        # `text: "my text value"`. The string must be valid UTF-8.
    "updateTime": "A String", # Output only. The time of the last variable update.
        # Timestamp will be UTC timestamp.
    "state": "A String", # Output only. The current state of the variable. The variable state
        # indicates the outcome of the `variables().watch` call and is visible
        # through the `get` and `list` calls.
    "value": "A String", # The binary value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. The value must be
        # base64 encoded, and must comply with IETF RFC4648
        # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
        # can be set.
    "name": "A String", # The name of the variable resource, in the format:
        #
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
        #
        # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
        # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
        # file path naming.
        #
        # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
        # dashes. Slashes are used as path element separators and are not part of the
        # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
        # non-slash character. Multiple slashes are coalesced into single slash
        # character. Each path segment should match
        # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
        # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
        #
        # Once you create a variable, you cannot change the variable name.
  }</pre>
</div>

<div class="method">
    <code class="details" id="watch">watch(name, body, x__xgafv=None)</code>
  <pre>Watches a specific variable and waits for a change in the variable's value.
When there is a change, this method returns the new value or times out.

If a variable is deleted while being watched, the `variableState` state is
set to `DELETED` and the method returns the last known variable `value`.

If you set the deadline for watching to a larger value than internal
timeout (60 seconds), the current variable value is returned and the
`variableState` will be `VARIABLE_STATE_UNSPECIFIED`.

To learn more about creating a watcher, read the
[Watching a Variable for
Changes](/deployment-manager/runtime-configurator/watching-a-variable)
documentation.

Args:
  name: string, The name of the variable to watch, in the format:

`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request for the `WatchVariable()` method.
    "newerThan": "A String", # If specified, checks the current timestamp of the variable and if the
        # current timestamp is newer than `newerThan` timestamp, the method returns
        # immediately.
        # 
        # If not specified or the variable has an older timestamp, the watcher waits
        # for a the value to change before returning.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a single variable within a RuntimeConfig resource.
      # The name denotes the hierarchical variable name. For example,
      # `ports/serving_port` is a valid variable name. The variable value is an
      # opaque string and only leaf variables can have values (that is, variables
      # that do not have any child variables).
    "text": "A String", # The string value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. For example,
        # `text: "my text value"`. The string must be valid UTF-8.
    "updateTime": "A String", # Output only. The time of the last variable update.
        # Timestamp will be UTC timestamp.
    "state": "A String", # Output only. The current state of the variable. The variable state
        # indicates the outcome of the `variables().watch` call and is visible
        # through the `get` and `list` calls.
    "value": "A String", # The binary value of the variable. The length of the value must be less
        # than 4096 bytes. Empty values are also accepted. The value must be
        # base64 encoded, and must comply with IETF RFC4648
        # (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text`
        # can be set.
    "name": "A String", # The name of the variable resource, in the format:
        #
        #     projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
        #
        # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
        # valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system
        # file path naming.
        #
        # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
        # dashes. Slashes are used as path element separators and are not part of the
        # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
        # non-slash character. Multiple slashes are coalesced into single slash
        # character. Each path segment should match
        # [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.
        # The length of a `[VARIABLE_NAME]` must be less than 256 characters.
        #
        # Once you create a variable, you cannot change the variable name.
  }</pre>
</div>

</body></html>