Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / runtimeconfig_v1beta1.projects.configs.html
blob: 94154d8d41de8a11fcbb94aff13e914d9ded8203 [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>
94<p class="firstline">CreateConfig creates a new config resource object.</p>
95<p class="toc_element">
96 <code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Deletes the config object.</p>
98<p class="toc_element">
99 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
100<p class="firstline">Gets the config resource object.</p>
101<p class="toc_element">
102 <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
103<p class="firstline">Lists all the config objects within project.</p>
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>
109<p class="firstline">Updates the config resource object.</p>
110<h3>Method Details</h3>
111<div class="method">
112 <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
113 <pre>CreateConfig creates a new config resource object.
114The configuration name must be unique within project.
115
116Args:
117 parent: string, The cloud project to which configuration belongs.
118Required. Must be a valid GCP project. (required)
119 body: object, The request body. (required)
120 The object takes the form of:
121
122{ # RuntimeConfig is the primary resource in the Configuration service.
123 # It consists of metadata and a hierarchy of variables.
124 "description": "A String", # Description of the configuration object.
125 # `len(description)` must be less than 256.
126 "name": "A String", # The resource name of a runtime config.
127 # It has the format of "projects/{project_id}/configs/{config_id}",
128 # where `project_id` is a valid Google cloud project ID, and the
129 # `config_id` must match RFC 1035 segment specification, and
130 # `len(config_id)` must be less than 64 bytes.
131 # The name is assigned by the client, but will be validated on the server
132 # side to adhere to the format.
133 # Name is immutable and cannot be changed.
134 }
135
136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141Returns:
142 An object of the form:
143
144 { # RuntimeConfig is the primary resource in the Configuration service.
145 # It consists of metadata and a hierarchy of variables.
146 "description": "A String", # Description of the configuration object.
147 # `len(description)` must be less than 256.
148 "name": "A String", # The resource name of a runtime config.
149 # It has the format of "projects/{project_id}/configs/{config_id}",
150 # where `project_id` is a valid Google cloud project ID, and the
151 # `config_id` must match RFC 1035 segment specification, and
152 # `len(config_id)` must be less than 64 bytes.
153 # The name is assigned by the client, but will be validated on the server
154 # side to adhere to the format.
155 # Name is immutable and cannot be changed.
156 }</pre>
157</div>
158
159<div class="method">
160 <code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
161 <pre>Deletes the config object.
162
163Args:
164 name: string, The configuration resource object to delete.
165Required. Must be a valid GCP project. (required)
166 x__xgafv: string, V1 error format.
167 Allowed values
168 1 - v1 error format
169 2 - v2 error format
170
171Returns:
172 An object of the form:
173
174 { # A generic empty message that you can re-use to avoid defining duplicated
175 # empty messages in your APIs. A typical example is to use it as the request
176 # or the response type of an API method. For instance:
177 #
178 # service Foo {
179 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
180 # }
181 #
182 # The JSON representation for `Empty` is empty JSON object `{}`.
183 }</pre>
184</div>
185
186<div class="method">
187 <code class="details" id="get">get(name, x__xgafv=None)</code>
188 <pre>Gets the config resource object.
189
190Args:
191 name: string, The name of the RuntimeConfig resource object to retrieve. (required)
192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
196
197Returns:
198 An object of the form:
199
200 { # RuntimeConfig is the primary resource in the Configuration service.
201 # It consists of metadata and a hierarchy of variables.
202 "description": "A String", # Description of the configuration object.
203 # `len(description)` must be less than 256.
204 "name": "A String", # The resource name of a runtime config.
205 # It has the format of "projects/{project_id}/configs/{config_id}",
206 # where `project_id` is a valid Google cloud project ID, and the
207 # `config_id` must match RFC 1035 segment specification, and
208 # `len(config_id)` must be less than 64 bytes.
209 # The name is assigned by the client, but will be validated on the server
210 # side to adhere to the format.
211 # Name is immutable and cannot be changed.
212 }</pre>
213</div>
214
215<div class="method">
216 <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
217 <pre>Lists all the config objects within project.
218
219Args:
220 parent: string, The cloud project, whose configuration resources we want to list.
221Required. Must be a valid GCP project. (required)
222 pageToken: string, The token for pagination.
223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
227 pageSize: integer, List pagination support.
228The size of the page to return. We may return fewer elements.
229
230Returns:
231 An object of the form:
232
233 { # Response for the `ListConfigs()` method.
234 # Order of returned configuration objects is arbitrary.
235 "nextPageToken": "A String", # Pagination support.
236 "configs": [ # Found configurations in the project.
237 { # RuntimeConfig is the primary resource in the Configuration service.
238 # It consists of metadata and a hierarchy of variables.
239 "description": "A String", # Description of the configuration object.
240 # `len(description)` must be less than 256.
241 "name": "A String", # The resource name of a runtime config.
242 # It has the format of "projects/{project_id}/configs/{config_id}",
243 # where `project_id` is a valid Google cloud project ID, and the
244 # `config_id` must match RFC 1035 segment specification, and
245 # `len(config_id)` must be less than 64 bytes.
246 # The name is assigned by the client, but will be validated on the server
247 # side to adhere to the format.
248 # Name is immutable and cannot be changed.
249 },
250 ],
251 }</pre>
252</div>
253
254<div class="method">
255 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
256 <pre>Retrieves the next page of results.
257
258Args:
259 previous_request: The request for the previous page. (required)
260 previous_response: The response from the request for the previous page. (required)
261
262Returns:
263 A request object that you can call 'execute()' on to request the next
264 page. Returns None if there are no more items in the collection.
265 </pre>
266</div>
267
268<div class="method">
269 <code class="details" id="update">update(name=None, body, x__xgafv=None)</code>
270 <pre>Updates the config resource object.
271RuntimeConfig object must already exist.
272
273Args:
274 name: string, The name of the config resource to update.
275Required. Must be a valid config resource. (required)
276 body: object, The request body. (required)
277 The object takes the form of:
278
279{ # RuntimeConfig is the primary resource in the Configuration service.
280 # It consists of metadata and a hierarchy of variables.
281 "description": "A String", # Description of the configuration object.
282 # `len(description)` must be less than 256.
283 "name": "A String", # The resource name of a runtime config.
284 # It has the format of "projects/{project_id}/configs/{config_id}",
285 # where `project_id` is a valid Google cloud project ID, and the
286 # `config_id` must match RFC 1035 segment specification, and
287 # `len(config_id)` must be less than 64 bytes.
288 # The name is assigned by the client, but will be validated on the server
289 # side to adhere to the format.
290 # Name is immutable and cannot be changed.
291 }
292
293 x__xgafv: string, V1 error format.
294 Allowed values
295 1 - v1 error format
296 2 - v2 error format
297
298Returns:
299 An object of the form:
300
301 { # RuntimeConfig is the primary resource in the Configuration service.
302 # It consists of metadata and a hierarchy of variables.
303 "description": "A String", # Description of the configuration object.
304 # `len(description)` must be less than 256.
305 "name": "A String", # The resource name of a runtime config.
306 # It has the format of "projects/{project_id}/configs/{config_id}",
307 # where `project_id` is a valid Google cloud project ID, and the
308 # `config_id` must match RFC 1035 segment specification, and
309 # `len(config_id)` must be less than 64 bytes.
310 # The name is assigned by the client, but will be validated on the server
311 # side to adhere to the format.
312 # Name is immutable and cannot be changed.
313 }</pre>
314</div>
315
316</body></html>