Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.variables.html
blob: edc0a7b4498bf2dea97d4c8a3cb5c9855399fcd0 [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
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]75<h1><a href="runtimeconfig_v1beta1.html">Google 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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]78 <code><a href="#create">create(parent, 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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#delete">delete(name, recursive=None, x__xgafv=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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]87 <code><a href="#list">list(parent, pageSize=None, returnValues=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]93 <code><a href="#testIamPermissions">testIamPermissions(resource, body, 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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]96 <code><a href="#update">update(name, body, 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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]99 <code><a href="#watch">watch(name, body, 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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]103 <code class="details" id="create">create(parent, 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,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]127 # `text: "my text value"`. The string must be valid UTF-8.
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
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]153 requestId: string, An optional but recommended unique `request_id`. If the server
154receives two `create()` requests with the same
155`request_id`, then the second request will be ignored and the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]156first resource created and stored in the backend is returned.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]157Empty `request_id` fields are ignored.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]158
159It is responsibility of the client to ensure uniqueness of the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]160`request_id` strings.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]161
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]162`request_id` 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,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]178 # `text: "my text value"`. The string must be valid UTF-8.
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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]206 <code class="details" id="delete">delete(name, recursive=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]241 <code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]263 # `text: "my text value"`. The string must be valid UTF-8.
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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]291 <code class="details" id="list">list(parent, pageSize=None, returnValues=None, filter=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]292 <pre>Lists variables within given a configuration, matching any provided filters.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]293This only lists variable names, not the values, unless `return_values` is
294true, in which case only variables that user has IAM permission to GetVariable
295will be returned.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]296
297Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]298 parent: string, The path to the RuntimeConfig resource for which you want to list variables.
299The configuration must exist beforehand; the path must by in the format:
300
301`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
302 pageSize: integer, Specifies the number of results to return per page. If there are fewer
303elements than the specified number, returns all elements.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]304 returnValues: boolean, The flag indicates whether the user wants to return values of variables.
305If true, then only those variables that user has IAM GetVariable permission
306will be returned along with their values.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]307 filter: string, Filters variables by matching the specified filter. For example:
308
309`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.
310 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
311returned by a previous list request to get the next page of results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]312 x__xgafv: string, V1 error format.
313 Allowed values
314 1 - v1 error format
315 2 - v2 error format
316
317Returns:
318 An object of the form:
319
320 { # Response for the `ListVariables()` method.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]321 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
322 # If the number of results is larger than `pageSize`, use the `nextPageToken`
323 # as a value for the query parameter `pageToken` in the next list request.
324 # Subsequent list requests will have their own `nextPageToken` to continue
325 # paging through the results
326 "variables": [ # A list of variables and their values. The order of returned variable
327 # objects is arbitrary.
328 { # Describes a single variable within a RuntimeConfig resource.
329 # The name denotes the hierarchical variable name. For example,
330 # `ports/serving_port` is a valid variable name. The variable value is an
331 # opaque string and only leaf variables can have values (that is, variables
332 # that do not have any child variables).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]333 "text": "A String", # The string value of the variable. The length of the value must be less
334 # than 4096 bytes. Empty values are also accepted. For example,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]335 # `text: "my text value"`. The string must be valid UTF-8.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]336 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]337 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
338 # the outcome of the `variables().watch` call and is visible through the
339 # `get` and `list` calls.
340 "value": "A String", # The binary value of the variable. The length of the value must be less
341 # than 4096 bytes. Empty values are also accepted. The value must be
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]342 # base64 encoded. Only one of `value` or `text` can be set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]343 "name": "A String", # The name of the variable resource, in the format:
344 #
345 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
346 #
347 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
348 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
349 # file path naming.
350 #
351 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
352 # dashes. Slashes are used as path element separators and are not part of the
353 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
354 # non-slash character. Multiple slashes are coalesced into single slash
355 # character. Each path segment should follow RFC 1035 segment specification.
356 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
357 #
358 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]359 },
360 ],
361 }</pre>
362</div>
363
364<div class="method">
365 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
366 <pre>Retrieves the next page of results.
367
368Args:
369 previous_request: The request for the previous page. (required)
370 previous_response: The response from the request for the previous page. (required)
371
372Returns:
373 A request object that you can call 'execute()' on to request the next
374 page. Returns None if there are no more items in the collection.
375 </pre>
376</div>
377
378<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]379 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]380 <pre>Returns permissions that a caller has on the specified resource.
381If the resource does not exist, this will return an empty set of
382permissions, not a NOT_FOUND error.
383
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]384Note: This operation is designed to be used for building permission-aware
385UIs and command-line tools, not for authorization checking. This operation
386may "fail open" without warning.
387
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]388Args:
389 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]390See the operation documentation for the appropriate value for this field. (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]391 body: object, The request body. (required)
392 The object takes the form of:
393
394{ # Request message for `TestIamPermissions` method.
395 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
396 # wildcards (such as '*' or 'storage.*') are not allowed. For more
397 # information see
398 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
399 "A String",
400 ],
401 }
402
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]403 x__xgafv: string, V1 error format.
404 Allowed values
405 1 - v1 error format
406 2 - v2 error format
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]407
408Returns:
409 An object of the form:
410
411 { # Response message for `TestIamPermissions` method.
412 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
413 # allowed.
414 "A String",
415 ],
416 }</pre>
417</div>
418
419<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]420 <code class="details" id="update">update(name, body, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]421 <pre>Updates an existing variable with a new value.
422
423Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]424 name: string, The name of the variable to update, in the format:
425
426`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]427 body: object, The request body. (required)
428 The object takes the form of:
429
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]430{ # Describes a single variable within a RuntimeConfig resource.
431 # The name denotes the hierarchical variable name. For example,
432 # `ports/serving_port` is a valid variable name. The variable value is an
433 # opaque string and only leaf variables can have values (that is, variables
434 # that do not have any child variables).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]435 "text": "A String", # The string value of the variable. The length of the value must be less
436 # than 4096 bytes. Empty values are also accepted. For example,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]437 # `text: "my text value"`. The string must be valid UTF-8.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]438 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]439 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
440 # the outcome of the `variables().watch` call and is visible through the
441 # `get` and `list` calls.
442 "value": "A String", # The binary value of the variable. The length of the value must be less
443 # than 4096 bytes. Empty values are also accepted. The value must be
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]444 # base64 encoded. Only one of `value` or `text` can be set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]445 "name": "A String", # The name of the variable resource, in the format:
446 #
447 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
448 #
449 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
450 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
451 # file path naming.
452 #
453 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
454 # dashes. Slashes are used as path element separators and are not part of the
455 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
456 # non-slash character. Multiple slashes are coalesced into single slash
457 # character. Each path segment should follow RFC 1035 segment specification.
458 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
459 #
460 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]461}
462
463 x__xgafv: string, V1 error format.
464 Allowed values
465 1 - v1 error format
466 2 - v2 error format
467
468Returns:
469 An object of the form:
470
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]471 { # Describes a single variable within a RuntimeConfig resource.
472 # The name denotes the hierarchical variable name. For example,
473 # `ports/serving_port` is a valid variable name. The variable value is an
474 # opaque string and only leaf variables can have values (that is, variables
475 # that do not have any child variables).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]476 "text": "A String", # The string value of the variable. The length of the value must be less
477 # than 4096 bytes. Empty values are also accepted. For example,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]478 # `text: "my text value"`. The string must be valid UTF-8.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]479 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]480 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
481 # the outcome of the `variables().watch` call and is visible through the
482 # `get` and `list` calls.
483 "value": "A String", # The binary value of the variable. The length of the value must be less
484 # than 4096 bytes. Empty values are also accepted. The value must be
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]485 # base64 encoded. Only one of `value` or `text` can be set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]486 "name": "A String", # The name of the variable resource, in the format:
487 #
488 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
489 #
490 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
491 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
492 # file path naming.
493 #
494 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
495 # dashes. Slashes are used as path element separators and are not part of the
496 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
497 # non-slash character. Multiple slashes are coalesced into single slash
498 # character. Each path segment should follow RFC 1035 segment specification.
499 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
500 #
501 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]502 }</pre>
503</div>
504
505<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]506 <code class="details" id="watch">watch(name, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]507 <pre>Watches a specific variable and waits for a change in the variable's value.
508When there is a change, this method returns the new value or times out.
509
510If a variable is deleted while being watched, the `variableState` state is
511set to `DELETED` and the method returns the last known variable `value`.
512
513If you set the deadline for watching to a larger value than internal timeout
514(60 seconds), the current variable value is returned and the `variableState`
515will be `VARIABLE_STATE_UNSPECIFIED`.
516
517To learn more about creating a watcher, read the
518[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)
519documentation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]520
521Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]522 name: string, The name of the variable to watch, in the format:
523
524`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]525 body: object, The request body. (required)
526 The object takes the form of:
527
528{ # Request for the `WatchVariable()` method.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]529 "newerThan": "A String", # If specified, checks the current timestamp of the variable and if the
530 # current timestamp is newer than `newerThan` timestamp, the method returns
531 # immediately.
532 #
533 # If not specified or the variable has an older timestamp, the watcher waits
534 # for a the value to change before returning.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]535 }
536
537 x__xgafv: string, V1 error format.
538 Allowed values
539 1 - v1 error format
540 2 - v2 error format
541
542Returns:
543 An object of the form:
544
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]545 { # Describes a single variable within a RuntimeConfig resource.
546 # The name denotes the hierarchical variable name. For example,
547 # `ports/serving_port` is a valid variable name. The variable value is an
548 # opaque string and only leaf variables can have values (that is, variables
549 # that do not have any child variables).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]550 "text": "A String", # The string value of the variable. The length of the value must be less
551 # than 4096 bytes. Empty values are also accepted. For example,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]552 # `text: "my text value"`. The string must be valid UTF-8.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]553 "updateTime": "A String", # [Output Only] The time of the last variable update.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]554 "state": "A String", # [Ouput only] The current state of the variable. The variable state indicates
555 # the outcome of the `variables().watch` call and is visible through the
556 # `get` and `list` calls.
557 "value": "A String", # The binary value of the variable. The length of the value must be less
558 # than 4096 bytes. Empty values are also accepted. The value must be
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]559 # base64 encoded. Only one of `value` or `text` can be set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]560 "name": "A String", # The name of the variable resource, in the format:
561 #
562 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]
563 #
564 # The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a
565 # valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system
566 # file path naming.
567 #
568 # The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and
569 # dashes. Slashes are used as path element separators and are not part of the
570 # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one
571 # non-slash character. Multiple slashes are coalesced into single slash
572 # character. Each path segment should follow RFC 1035 segment specification.
573 # The length of a `[VARIABLE_NAME]` must be less than 256 bytes.
574 #
575 # Once you create a variable, you cannot change the variable name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]576 }</pre>
577</div>
578
579</body></html>