Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.variables.html
blob: de2490b869983a9fb621ee8cf0e3dfa1d1876c52 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="runtimeconfig_v1beta1.html">Google Cloud RuntimeConfig API</a> . <a href="runtimeconfig_v1beta1.projects.html">projects</a> . <a href="runtimeconfig_v1beta1.projects.configs.html">configs</a> . <a href="runtimeconfig_v1beta1.projects.configs.variables.html">variables</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a variable within the given configuration.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, recursive=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes variable or variables.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the variable resource object.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists variables within given RuntimeConfig object, matching optionally</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#update">update(name=None, body, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates an existing variable with a new value.</p>
95<p class="toc_element">
96 <code><a href="#watch">watch(name, body, x__xgafv=None)</a></code></p>
97<p class="firstline">WatchVariable watches for a variable to change and then returns the new</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
101 <pre>Creates a variable within the given configuration.
102Create variable will create all required intermediate path elements.
103It is a FAILED_PRECONDITION error to create a variable with a name that is
104a prefix of an existing variable name, or that has an existing variable
105name as a prefix.
106
107Args:
108 parent: string, The configuration parent, that will own the variable.
109Required, must a valid configuration name within project_id. (required)
110 body: object, The request body. (required)
111 The object takes the form of:
112
113{ # Variable message describes a single variable within a Configuration object.
114 # name denotes the hierarchical variable name, e.g.
115 # ports/serving_port within flags configuration object.
116 # Value is an opaque string and only leaf variables can have values.
117 "updateTime": "A String", # [Output Only] The time of the last variable update.
118 "state": "A String", # [Ouput only] The current state of the variable.
119 # State denotes the outcome of the Watch call and is unset by the Get/List
120 # calls.
121 "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
122 # value must be Base64 encoded.
123 "name": "A String", # Name of the variable resource.
124 # It has format of
125 # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
126 # Where `project_id` must be a valid Google Cloud project ID, `config_id`
127 # must be a valid RuntimeConfig object and `variable_id` follows Unix
128 # file system file path naming.
129 # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
130 # Slashes are used as path element separators and are not part of the
131 # `variable_id` itself, so `variable_id` must contain at least one non-slash
132 # character. Multiple slashes are coalesced into single slash character.
133 # Each path segment should follow RFC 1035 segment specification.
134 # `len(variable_id)` must be less than 256 bytes.
135 # The name is assigned by the client, but will be validated on the server
136 # side to adhere to the format.
137 # Name is immutable and cannot be changed.
138}
139
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
148 { # Variable message describes a single variable within a Configuration object.
149 # name denotes the hierarchical variable name, e.g.
150 # ports/serving_port within flags configuration object.
151 # Value is an opaque string and only leaf variables can have values.
152 "updateTime": "A String", # [Output Only] The time of the last variable update.
153 "state": "A String", # [Ouput only] The current state of the variable.
154 # State denotes the outcome of the Watch call and is unset by the Get/List
155 # calls.
156 "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
157 # value must be Base64 encoded.
158 "name": "A String", # Name of the variable resource.
159 # It has format of
160 # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
161 # Where `project_id` must be a valid Google Cloud project ID, `config_id`
162 # must be a valid RuntimeConfig object and `variable_id` follows Unix
163 # file system file path naming.
164 # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
165 # Slashes are used as path element separators and are not part of the
166 # `variable_id` itself, so `variable_id` must contain at least one non-slash
167 # character. Multiple slashes are coalesced into single slash character.
168 # Each path segment should follow RFC 1035 segment specification.
169 # `len(variable_id)` must be less than 256 bytes.
170 # The name is assigned by the client, but will be validated on the server
171 # side to adhere to the format.
172 # Name is immutable and cannot be changed.
173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="delete">delete(name, recursive=None, x__xgafv=None)</code>
178 <pre>Deletes variable or variables.
179If name denotes a variable, that variable is deleted. If name is a prefix
180and recursive is true, then all variables with that prefix are deleted,
181it's a FAILED_PRECONDITION to delete a prefix without recursive being true.
182
183Args:
184 name: string, The name of the variable to delete. (required)
185 recursive: boolean, If recursive is false and name is a prefix of other variables, then
186the request will fail.
187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192Returns:
193 An object of the form:
194
195 { # A generic empty message that you can re-use to avoid defining duplicated
196 # empty messages in your APIs. A typical example is to use it as the request
197 # or the response type of an API method. For instance:
198 #
199 # service Foo {
200 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
201 # }
202 #
203 # The JSON representation for `Empty` is empty JSON object `{}`.
204 }</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="get">get(name, x__xgafv=None)</code>
209 <pre>Gets the variable resource object.
210
211Args:
212 name: string, What variable to return. (required)
213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218Returns:
219 An object of the form:
220
221 { # Variable message describes a single variable within a Configuration object.
222 # name denotes the hierarchical variable name, e.g.
223 # ports/serving_port within flags configuration object.
224 # Value is an opaque string and only leaf variables can have values.
225 "updateTime": "A String", # [Output Only] The time of the last variable update.
226 "state": "A String", # [Ouput only] The current state of the variable.
227 # State denotes the outcome of the Watch call and is unset by the Get/List
228 # calls.
229 "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
230 # value must be Base64 encoded.
231 "name": "A String", # Name of the variable resource.
232 # It has format of
233 # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
234 # Where `project_id` must be a valid Google Cloud project ID, `config_id`
235 # must be a valid RuntimeConfig object and `variable_id` follows Unix
236 # file system file path naming.
237 # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
238 # Slashes are used as path element separators and are not part of the
239 # `variable_id` itself, so `variable_id` must contain at least one non-slash
240 # character. Multiple slashes are coalesced into single slash character.
241 # Each path segment should follow RFC 1035 segment specification.
242 # `len(variable_id)` must be less than 256 bytes.
243 # The name is assigned by the client, but will be validated on the server
244 # side to adhere to the format.
245 # Name is immutable and cannot be changed.
246 }</pre>
247</div>
248
249<div class="method">
250 <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
251 <pre>Lists variables within given RuntimeConfig object, matching optionally
252provided filter.
253List contains only variable metadata, but not values.
254
255Args:
256 parent: string, Which RuntimeConfig object to list for variables. (required)
257 pageSize: integer, List pagination support.
258The size of the page to return. We may return fewer elements.
259 filter: string, List only variables matching filter prefix exactly.
260e.g. `projects/{project_id}/config/{config_id}/variables/{variable/id}`.
261 pageToken: string, The token for pagination.
262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
266
267Returns:
268 An object of the form:
269
270 { # Response for the `ListVariables()` method.
271 # Order of returned variable objects is arbitrary.
272 "nextPageToken": "A String", # Pagination support.
273 "variables": [ # Matched variables and their values.
274 { # Variable message describes a single variable within a Configuration object.
275 # name denotes the hierarchical variable name, e.g.
276 # ports/serving_port within flags configuration object.
277 # Value is an opaque string and only leaf variables can have values.
278 "updateTime": "A String", # [Output Only] The time of the last variable update.
279 "state": "A String", # [Ouput only] The current state of the variable.
280 # State denotes the outcome of the Watch call and is unset by the Get/List
281 # calls.
282 "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
283 # value must be Base64 encoded.
284 "name": "A String", # Name of the variable resource.
285 # It has format of
286 # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
287 # Where `project_id` must be a valid Google Cloud project ID, `config_id`
288 # must be a valid RuntimeConfig object and `variable_id` follows Unix
289 # file system file path naming.
290 # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
291 # Slashes are used as path element separators and are not part of the
292 # `variable_id` itself, so `variable_id` must contain at least one non-slash
293 # character. Multiple slashes are coalesced into single slash character.
294 # Each path segment should follow RFC 1035 segment specification.
295 # `len(variable_id)` must be less than 256 bytes.
296 # The name is assigned by the client, but will be validated on the server
297 # side to adhere to the format.
298 # Name is immutable and cannot be changed.
299 },
300 ],
301 }</pre>
302</div>
303
304<div class="method">
305 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
306 <pre>Retrieves the next page of results.
307
308Args:
309 previous_request: The request for the previous page. (required)
310 previous_response: The response from the request for the previous page. (required)
311
312Returns:
313 A request object that you can call 'execute()' on to request the next
314 page. Returns None if there are no more items in the collection.
315 </pre>
316</div>
317
318<div class="method">
319 <code class="details" id="update">update(name=None, body, x__xgafv=None)</code>
320 <pre>Updates an existing variable with a new value.
321
322Args:
323 name: string, The name of the variable to update.
324In the format of:
325"projects/{project_id}/configs/{config_id}/variables/{variable_id}" (required)
326 body: object, The request body. (required)
327 The object takes the form of:
328
329{ # Variable message describes a single variable within a Configuration object.
330 # name denotes the hierarchical variable name, e.g.
331 # ports/serving_port within flags configuration object.
332 # Value is an opaque string and only leaf variables can have values.
333 "updateTime": "A String", # [Output Only] The time of the last variable update.
334 "state": "A String", # [Ouput only] The current state of the variable.
335 # State denotes the outcome of the Watch call and is unset by the Get/List
336 # calls.
337 "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
338 # value must be Base64 encoded.
339 "name": "A String", # Name of the variable resource.
340 # It has format of
341 # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
342 # Where `project_id` must be a valid Google Cloud project ID, `config_id`
343 # must be a valid RuntimeConfig object and `variable_id` follows Unix
344 # file system file path naming.
345 # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
346 # Slashes are used as path element separators and are not part of the
347 # `variable_id` itself, so `variable_id` must contain at least one non-slash
348 # character. Multiple slashes are coalesced into single slash character.
349 # Each path segment should follow RFC 1035 segment specification.
350 # `len(variable_id)` must be less than 256 bytes.
351 # The name is assigned by the client, but will be validated on the server
352 # side to adhere to the format.
353 # Name is immutable and cannot be changed.
354}
355
356 x__xgafv: string, V1 error format.
357 Allowed values
358 1 - v1 error format
359 2 - v2 error format
360
361Returns:
362 An object of the form:
363
364 { # Variable message describes a single variable within a Configuration object.
365 # name denotes the hierarchical variable name, e.g.
366 # ports/serving_port within flags configuration object.
367 # Value is an opaque string and only leaf variables can have values.
368 "updateTime": "A String", # [Output Only] The time of the last variable update.
369 "state": "A String", # [Ouput only] The current state of the variable.
370 # State denotes the outcome of the Watch call and is unset by the Get/List
371 # calls.
372 "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
373 # value must be Base64 encoded.
374 "name": "A String", # Name of the variable resource.
375 # It has format of
376 # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
377 # Where `project_id` must be a valid Google Cloud project ID, `config_id`
378 # must be a valid RuntimeConfig object and `variable_id` follows Unix
379 # file system file path naming.
380 # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
381 # Slashes are used as path element separators and are not part of the
382 # `variable_id` itself, so `variable_id` must contain at least one non-slash
383 # character. Multiple slashes are coalesced into single slash character.
384 # Each path segment should follow RFC 1035 segment specification.
385 # `len(variable_id)` must be less than 256 bytes.
386 # The name is assigned by the client, but will be validated on the server
387 # side to adhere to the format.
388 # Name is immutable and cannot be changed.
389 }</pre>
390</div>
391
392<div class="method">
393 <code class="details" id="watch">watch(name, body, x__xgafv=None)</code>
394 <pre>WatchVariable watches for a variable to change and then returns the new
395value or times out.
396If variable is deleted while being watched, VariableState will be DELETED
397and the Value will contain the last known value.
398If the operation deadline is set to a larger value than internal timeout
399existing, current variable value will be returned and Variable state will
400be VARIABLE_STATE_UNSPECIFIED.
401
402Args:
403 name: string, The name of the variable to retrieve. (required)
404 body: object, The request body. (required)
405 The object takes the form of:
406
407{ # Request for the `WatchVariable()` method.
408 "newerThan": "A String", # If backend has a variable that has a newer value than this timestamp, then
409 # request will return immediately with current value.
410 # If not specified or variable has an older timestamp, will wait for the new
411 # value.
412 }
413
414 x__xgafv: string, V1 error format.
415 Allowed values
416 1 - v1 error format
417 2 - v2 error format
418
419Returns:
420 An object of the form:
421
422 { # Variable message describes a single variable within a Configuration object.
423 # name denotes the hierarchical variable name, e.g.
424 # ports/serving_port within flags configuration object.
425 # Value is an opaque string and only leaf variables can have values.
426 "updateTime": "A String", # [Output Only] The time of the last variable update.
427 "state": "A String", # [Ouput only] The current state of the variable.
428 # State denotes the outcome of the Watch call and is unset by the Get/List
429 # calls.
430 "value": "A String", # `len(value)` must be less than 4096 bytes. Empty values are also accepted.
431 # value must be Base64 encoded.
432 "name": "A String", # Name of the variable resource.
433 # It has format of
434 # "projects/{project_id}/configs/{config_id}/variables/{variable_id}",
435 # Where `project_id` must be a valid Google Cloud project ID, `config_id`
436 # must be a valid RuntimeConfig object and `variable_id` follows Unix
437 # file system file path naming.
438 # `variable_id` can contain ASCII letters, numbers, slashes and dashes.
439 # Slashes are used as path element separators and are not part of the
440 # `variable_id` itself, so `variable_id` must contain at least one non-slash
441 # character. Multiple slashes are coalesced into single slash character.
442 # Each path segment should follow RFC 1035 segment specification.
443 # `len(variable_id)` must be less than 256 bytes.
444 # The name is assigned by the client, but will be validated on the server
445 # side to adhere to the format.
446 # Name is immutable and cannot be changed.
447 }</pre>
448</div>
449
450</body></html>