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