Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a61611c1420576640db612f39a13ea3dcace1dc7 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.html
blob: da4b6effc1c136edf80eee58b5e79cadc4b3a9e2 [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">
93 <code><a href="#create">create(parent=None, body, 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">
112 <code class="details" id="create">create(parent=None, body, 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
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
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]148 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
149 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
150 # variables.
151 "description": "A String", # An optional description of the RuntimeConfig object.
152 # The length of the description must be less than 256 bytes.
153 "name": "A String", # The resource name of a runtime config. The name must have the format:
154 #
155 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
156 #
157 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
158 # arbitrary name that matches RFC 1035 segment specification. The length of
159 # `[CONFIG_NAME]` must be less than 64 bytes.
160 #
161 # You pick the RuntimeConfig resource name, but the server will validate that
162 # the name adheres to this format. After you create the resource, you cannot
163 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]169 <pre>Deletes a RuntimeConfig resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]170
171Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]172 name: string, The RuntimeConfig resource to delete, in the format:
173
174`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180Returns:
181 An object of the form:
182
183 { # A generic empty message that you can re-use to avoid defining duplicated
184 # empty messages in your APIs. A typical example is to use it as the request
185 # or the response type of an API method. For instance:
186 #
187 # service Foo {
188 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
189 # }
190 #
191 # The JSON representation for `Empty` is empty JSON object `{}`.
192 }</pre>
193</div>
194
195<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]196 <code class="details" id="get">get(name=None, x__xgafv=None)</code>
197 <pre>Gets information about a RuntimeConfig resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]198
199Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]200 name: string, The name of the RuntimeConfig resource to retrieve, in the format:
201
202`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]203 x__xgafv: string, V1 error format.
204 Allowed values
205 1 - v1 error format
206 2 - v2 error format
207
208Returns:
209 An object of the form:
210
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]211 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
212 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
213 # variables.
214 "description": "A String", # An optional description of the RuntimeConfig object.
215 # The length of the description must be less than 256 bytes.
216 "name": "A String", # The resource name of a runtime config. The name must have the format:
217 #
218 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
219 #
220 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
221 # arbitrary name that matches RFC 1035 segment specification. The length of
222 # `[CONFIG_NAME]` must be less than 64 bytes.
223 #
224 # You pick the RuntimeConfig resource name, but the server will validate that
225 # the name adheres to this format. After you create the resource, you cannot
226 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]227 }</pre>
228</div>
229
230<div class="method">
231 <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]232 <pre>Lists all the RuntimeConfig resources within project.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]233
234Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]235 parent: string, The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)
236for this request, in the format `projects/[PROJECT_ID]`. (required)
237 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
238returned by a previous list request to get the next page of results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]243 pageSize: integer, Specifies the number of results to return per page. If there are fewer
244elements than the specified number, returns all elements.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]245
246Returns:
247 An object of the form:
248
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]249 { # `ListConfigs()` returns the following response. The order of returned
250 # objects is arbitrary; that is, it is not ordered in any particular way.
251 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
252 # If the number of results is larger than `pageSize`, use the `nextPageToken`
253 # as a value for the query parameter `pageToken` in the next list request.
254 # Subsequent list requests will have their own `nextPageToken` to continue
255 # paging through the results
256 "configs": [ # A list of the configurations in the project. The order of returned
257 # objects is arbitrary; that is, it is not ordered in any particular way.
258 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
259 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
260 # variables.
261 "description": "A String", # An optional description of the RuntimeConfig object.
262 # The length of the description must be less than 256 bytes.
263 "name": "A String", # The resource name of a runtime config. The name must have the format:
264 #
265 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
266 #
267 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
268 # arbitrary name that matches RFC 1035 segment specification. The length of
269 # `[CONFIG_NAME]` must be less than 64 bytes.
270 #
271 # You pick the RuntimeConfig resource name, but the server will validate that
272 # the name adheres to this format. After you create the resource, you cannot
273 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]274 },
275 ],
276 }</pre>
277</div>
278
279<div class="method">
280 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
281 <pre>Retrieves the next page of results.
282
283Args:
284 previous_request: The request for the previous page. (required)
285 previous_response: The response from the request for the previous page. (required)
286
287Returns:
288 A request object that you can call 'execute()' on to request the next
289 page. Returns None if there are no more items in the collection.
290 </pre>
291</div>
292
293<div class="method">
294 <code class="details" id="update">update(name=None, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]295 <pre>Updates a RuntimeConfig resource. The configuration must exist beforehand.
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 name: string, The name of the RuntimeConfig resource to update, in the format:
299
300`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]301 body: object, The request body. (required)
302 The object takes the form of:
303
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]304{ # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
305 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
306 # variables.
307 "description": "A String", # An optional description of the RuntimeConfig object.
308 # The length of the description must be less than 256 bytes.
309 "name": "A String", # The resource name of a runtime config. The name must have the format:
310 #
311 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
312 #
313 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
314 # arbitrary name that matches RFC 1035 segment specification. The length of
315 # `[CONFIG_NAME]` must be less than 64 bytes.
316 #
317 # You pick the RuntimeConfig resource name, but the server will validate that
318 # the name adheres to this format. After you create the resource, you cannot
319 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]320 }
321
322 x__xgafv: string, V1 error format.
323 Allowed values
324 1 - v1 error format
325 2 - v2 error format
326
327Returns:
328 An object of the form:
329
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]330 { # A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig
331 # service. A RuntimeConfig resource consists of metadata and a hierarchy of
332 # variables.
333 "description": "A String", # An optional description of the RuntimeConfig object.
334 # The length of the description must be less than 256 bytes.
335 "name": "A String", # The resource name of a runtime config. The name must have the format:
336 #
337 # projects/[PROJECT_ID]/configs/[CONFIG_NAME]
338 #
339 # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an
340 # arbitrary name that matches RFC 1035 segment specification. The length of
341 # `[CONFIG_NAME]` must be less than 64 bytes.
342 #
343 # You pick the RuntimeConfig resource name, but the server will validate that
344 # the name adheres to this format. After you create the resource, you cannot
345 # change the resource's name.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]346 }</pre>
347</div>
348
349</body></html>