Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ea3a5e1b5572e5438ba86ec0074f60029bd94855 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.html
blob: b25b8e3bfe5b2aa344a87cc7e8d12345cc7cdbaa [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="runtimeconfig_v1beta1.projects.configs.operations.html">operations()</a></code>
79</p>
80<p class="firstline">Returns the operations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="runtimeconfig_v1beta1.projects.configs.variables.html">variables()</a></code>
84</p>
85<p class="firstline">Returns the variables Resource.</p>
86
87<p class="toc_element">
88 <code><a href="runtimeconfig_v1beta1.projects.configs.waiters.html">waiters()</a></code>
89</p>
90<p class="firstline">Returns the waiters Resource.</p>
91
92<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]93 <code><a href="#create">create(parent=None, body, requestId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]94<p class="firstline">Creates a new RuntimeConfig resource. The configuration name must be</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95<p class="toc_element">
96 <code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]97<p class="firstline">Deletes a RuntimeConfig resource.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]98<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]99 <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Gets information about a RuntimeConfig resource.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]101<p class="toc_element">
102 <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]103<p class="firstline">Lists all the RuntimeConfig resources within project.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#update">update(name=None, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]109<p class="firstline">Updates a RuntimeConfig resource. The configuration must exist beforehand.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]110<h3>Method Details</h3>
111<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]112 <code class="details" id="create">create(parent=None, body, requestId=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]113 <pre>Creates a new RuntimeConfig resource. The configuration name must be
114unique within project.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]115
116Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]117 parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
118for this request, in the format `projects/[PROJECT_ID]`. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]119 body: object, The request body. (required)
120 The object takes the form of:
121
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]122{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
123 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
124 # variables.
125 "description": "A String", # An optional description of the RuntimeConfig object.
126 # The length of the description must be less than 256 bytes.
127 "name": "A String", # The resource name of a runtime config. The name must have the format:
128 #
129 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
130 #
131 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
132 # arbitrary name that matches RFC 1035 segment specification. The length of
133 # `[CONFIG_NAME]` must be less than 64 bytes.
134 #
135 # You pick the RuntimeConfig resource name, but the server will validate that
136 # the name adheres to this format. After you create the resource, you cannot
137 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]138 }
139
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]140 requestId: string, An optional unique request_id. If server receives two Create requests with
141the same request_id then second request will be ignored and the resource
142stored in the backend will be returned. Empty request_id fields are
143ignored.
144It is responsibility of the client to ensure uniqueness of the request_id
145strings.
146The strings are limited to 64 characters.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]147 x__xgafv: string, V1 error format.
148 Allowed values
149 1 - v1 error format
150 2 - v2 error format
151
152Returns:
153 An object of the form:
154
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]155 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
156 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
157 # variables.
158 "description": "A String", # An optional description of the RuntimeConfig object.
159 # The length of the description must be less than 256 bytes.
160 "name": "A String", # The resource name of a runtime config. The name must have the format:
161 #
162 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
163 #
164 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
165 # arbitrary name that matches RFC 1035 segment specification. The length of
166 # `[CONFIG_NAME]` must be less than 64 bytes.
167 #
168 # You pick the RuntimeConfig resource name, but the server will validate that
169 # the name adheres to this format. After you create the resource, you cannot
170 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]176 <pre>Deletes a RuntimeConfig resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]177
178Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]179 name: string, The RuntimeConfig resource to delete, in the format:
180
181`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]182 x__xgafv: string, V1 error format.
183 Allowed values
184 1 - v1 error format
185 2 - v2 error format
186
187Returns:
188 An object of the form:
189
190 { # A generic empty message that you can re-use to avoid defining duplicated
191 # empty messages in your APIs. A typical example is to use it as the request
192 # or the response type of an API method. For instance:
193 #
194 # service Foo {
195 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
196 # }
197 #
198 # The JSON representation for `Empty` is empty JSON object `{}`.
199 }</pre>
200</div>
201
202<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]203 <code class="details" id="get">get(name=None, x__xgafv=None)</code>
204 <pre>Gets information about a RuntimeConfig resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]205
206Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]207 name: string, The name of the RuntimeConfig resource to retrieve, in the format:
208
209`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]210 x__xgafv: string, V1 error format.
211 Allowed values
212 1 - v1 error format
213 2 - v2 error format
214
215Returns:
216 An object of the form:
217
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]218 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
219 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
220 # variables.
221 "description": "A String", # An optional description of the RuntimeConfig object.
222 # The length of the description must be less than 256 bytes.
223 "name": "A String", # The resource name of a runtime config. The name must have the format:
224 #
225 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
226 #
227 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
228 # arbitrary name that matches RFC 1035 segment specification. The length of
229 # `[CONFIG_NAME]` must be less than 64 bytes.
230 #
231 # You pick the RuntimeConfig resource name, but the server will validate that
232 # the name adheres to this format. After you create the resource, you cannot
233 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]239 <pre>Lists all the RuntimeConfig resources within project.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]240
241Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]242 parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
243for this request, in the format `projects/[PROJECT_ID]`. (required)
244 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
245returned by a previous list request to get the next page of results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]246 x__xgafv: string, V1 error format.
247 Allowed values
248 1 - v1 error format
249 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]250 pageSize: integer, Specifies the number of results to return per page. If there are fewer
251elements than the specified number, returns all elements.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]252
253Returns:
254 An object of the form:
255
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]256 { # `ListConfigs()` returns the following response. The order of returned
257 # objects is arbitrary; that is, it is not ordered in any particular way.
258 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
259 # If the number of results is larger than `pageSize`, use the `nextPageToken`
260 # as a value for the query parameter `pageToken` in the next list request.
261 # Subsequent list requests will have their own `nextPageToken` to continue
262 # paging through the results
263 "configs": [ # A list of the configurations in the project. The order of returned
264 # objects is arbitrary; that is, it is not ordered in any particular way.
265 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
266 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
267 # variables.
268 "description": "A String", # An optional description of the RuntimeConfig object.
269 # The length of the description must be less than 256 bytes.
270 "name": "A String", # The resource name of a runtime config. The name must have the format:
271 #
272 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
273 #
274 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
275 # arbitrary name that matches RFC 1035 segment specification. The length of
276 # `[CONFIG_NAME]` must be less than 64 bytes.
277 #
278 # You pick the RuntimeConfig resource name, but the server will validate that
279 # the name adheres to this format. After you create the resource, you cannot
280 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]281 },
282 ],
283 }</pre>
284</div>
285
286<div class="method">
287 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
288 <pre>Retrieves the next page of results.
289
290Args:
291 previous_request: The request for the previous page. (required)
292 previous_response: The response from the request for the previous page. (required)
293
294Returns:
295 A request object that you can call 'execute()' on to request the next
296 page. Returns None if there are no more items in the collection.
297 </pre>
298</div>
299
300<div class="method">
301 <code class="details" id="update">update(name=None, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]302 <pre>Updates a RuntimeConfig resource. The configuration must exist beforehand.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]303
304Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]305 name: string, The name of the RuntimeConfig resource to update, in the format:
306
307`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]308 body: object, The request body. (required)
309 The object takes the form of:
310
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]311{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
312 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
313 # variables.
314 "description": "A String", # An optional description of the RuntimeConfig object.
315 # The length of the description must be less than 256 bytes.
316 "name": "A String", # The resource name of a runtime config. The name must have the format:
317 #
318 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
319 #
320 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
321 # arbitrary name that matches RFC 1035 segment specification. The length of
322 # `[CONFIG_NAME]` must be less than 64 bytes.
323 #
324 # You pick the RuntimeConfig resource name, but the server will validate that
325 # the name adheres to this format. After you create the resource, you cannot
326 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]327 }
328
329 x__xgafv: string, V1 error format.
330 Allowed values
331 1 - v1 error format
332 2 - v2 error format
333
334Returns:
335 An object of the form:
336
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]337 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
338 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
339 # variables.
340 "description": "A String", # An optional description of the RuntimeConfig object.
341 # The length of the description must be less than 256 bytes.
342 "name": "A String", # The resource name of a runtime config. The name must have the format:
343 #
344 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
345 #
346 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
347 # arbitrary name that matches RFC 1035 segment specification. The length of
348 # `[CONFIG_NAME]` must be less than 64 bytes.
349 #
350 # You pick the RuntimeConfig resource name, but the server will validate that
351 # the name adheres to this format. After you create the resource, you cannot
352 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]353 }</pre>
354</div>
355
356</body></html>