Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2f245374da9c895dbd8bb0423e98707d51b53414 / . / docs / dyn / servicemanagement_v1.services.rollouts.html
blob: a95912d13b6719c796a8edf6a2e602720d4a880d [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -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="servicemanagement_v1.html">Google Service Management API</a> . <a href="servicemanagement_v1.services.html">services</a> . <a href="servicemanagement_v1.services.rollouts.html">rollouts</a></h1>
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(serviceName, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]79<p class="firstline">Creates a new service configuration rollout. Based on rollout, the</p>
80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]81 <code><a href="#get">get(serviceName, rolloutId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]82<p class="firstline">Gets a service configuration rollout.</p>
83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]84 <code><a href="#list">list(serviceName, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]85<p class="firstline">Lists the history of the service configuration rollouts for a managed</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]91 <code class="details" id="create">create(serviceName, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]92 <pre>Creates a new service configuration rollout. Based on rollout, the
93Google Service Management will roll out the service configurations to
94different backend services. For example, the logging configuration will be
95pushed to Google Cloud Logging.
96
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]97Please note that any previous pending and running Rollouts and associated
98Operations will be automatically cancelled so that the latest Rollout will
99not be blocked by previous Rollouts.
100
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]101Operation<response: Rollout>
102
103Args:
104 serviceName: string, The name of the service. See the [overview](/service-management/overview)
105for naming requirements. For example: `example.googleapis.com`. (required)
106 body: object, The request body. (required)
107 The object takes the form of:
108
109{ # A rollout resource that defines how service configuration versions are pushed
110 # to control plane systems. Typically, you create a new version of the
111 # service config, and then create a Rollout to push the service config.
112 "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
113 # the system will automatically rollback to the current Rollout
114 # version. Readonly.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]115 "trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on
116 # traffic percentage.
117 # different
118 # versions of service configurations based on traffic percentage.
119 #
120 # One example of how to gradually rollout a new service configuration using
121 # this
122 # strategy:
123 # Day 1
124 #
125 # Rollout {
126 # id: "example.googleapis.com/rollout_20160206"
127 # traffic_percent_strategy {
128 # percentages: {
129 # "example.googleapis.com/20160201": 70.00
130 # "example.googleapis.com/20160206": 30.00
131 # }
132 # }
133 # }
134 #
135 # Day 2
136 #
137 # Rollout {
138 # id: "example.googleapis.com/rollout_20160207"
139 # traffic_percent_strategy: {
140 # percentages: {
141 # "example.googleapis.com/20160206": 100.00
142 # }
143 # }
144 # }
145 "percentages": { # Maps service configuration IDs to their corresponding traffic percentage.
146 # Key is the service configuration ID, Value is the traffic percentage
147 # which must be greater than 0.0 and the sum must equal to 100.0.
148 "a_key": 3.14,
149 },
150 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]151 "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
152 # and '-' are allowed.
153 #
154 # If not specified by client, the server will generate one. The generated id
155 # will have the form of <date><revision number>, where "date" is the create
156 # date in ISO 8601 format. "revision number" is a monotonically increasing
157 # positive number that is reset every day for each service.
158 # An example of the generated rollout_id is '2016-02-16r1'
159 "serviceName": "A String", # The name of the service associated with this Rollout.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]160 "createdBy": "A String", # The user who created the Rollout. Readonly.
161 "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
162 # Readonly.
163 # used by the system generated rollout to delete a service.
164 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]165 "createTime": "A String", # Creation time of the rollout. Readonly.
166 }
167
168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173Returns:
174 An object of the form:
175
176 { # This resource represents a long-running operation that is the result of a
177 # network API call.
178 "metadata": { # Service-specific metadata associated with the operation. It typically
179 # contains progress information and common metadata such as create time.
180 # Some services might not provide such metadata. Any method that returns a
181 # long-running operation should document the metadata type, if any.
182 "a_key": "", # Properties of the object. Contains field @type with type URL.
183 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]184 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]185 # programming environments, including REST APIs and RPC APIs. It is used by
186 # [gRPC](https://github.com/grpc). The error model is designed to be:
187 #
188 # - Simple to use and understand for most users
189 # - Flexible enough to meet unexpected needs
190 #
191 # # Overview
192 #
193 # The `Status` message contains three pieces of data: error code, error message,
194 # and error details. The error code should be an enum value of
195 # google.rpc.Code, but it may accept additional error codes if needed. The
196 # error message should be a developer-facing English message that helps
197 # developers *understand* and *resolve* the error. If a localized user-facing
198 # error message is needed, put the localized message in the error details or
199 # localize it in the client. The optional error details may contain arbitrary
200 # information about the error. There is a predefined set of error detail types
201 # in the package `google.rpc` which can be used for common error conditions.
202 #
203 # # Language mapping
204 #
205 # The `Status` message is the logical representation of the error model, but it
206 # is not necessarily the actual wire format. When the `Status` message is
207 # exposed in different client libraries and different wire protocols, it can be
208 # mapped differently. For example, it will likely be mapped to some exceptions
209 # in Java, but more likely mapped to some error codes in C.
210 #
211 # # Other uses
212 #
213 # The error model and the `Status` message can be used in a variety of
214 # environments, either with or without APIs, to provide a
215 # consistent developer experience across different environments.
216 #
217 # Example uses of this error model include:
218 #
219 # - Partial errors. If a service needs to return partial errors to the client,
220 # it may embed the `Status` in the normal response to indicate the partial
221 # errors.
222 #
223 # - Workflow errors. A typical workflow has multiple steps. Each step may
224 # have a `Status` message for error reporting purpose.
225 #
226 # - Batch operations. If a client uses batch request and batch response, the
227 # `Status` message should be used directly inside batch response, one for
228 # each error sub-response.
229 #
230 # - Asynchronous operations. If an API call embeds asynchronous operation
231 # results in its response, the status of those operations should be
232 # represented directly using the `Status` message.
233 #
234 # - Logging. If some API errors are stored in logs, the message `Status` could
235 # be used directly after any stripping needed for security/privacy reasons.
236 "message": "A String", # A developer-facing error message, which should be in English. Any
237 # user-facing error message should be localized and sent in the
238 # google.rpc.Status.details field, or localized by the client.
239 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
240 "details": [ # A list of messages that carry the error details. There will be a
241 # common set of message types for APIs to use.
242 {
243 "a_key": "", # Properties of the object. Contains field @type with type URL.
244 },
245 ],
246 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]247 "done": True or False, # If the value is `false`, it means the operation is still in progress.
248 # If true, the operation is completed, and either `error` or `response` is
249 # available.
250 "response": { # The normal response of the operation in case of success. If the original
251 # method returns no data on success, such as `Delete`, the response is
252 # `google.protobuf.Empty`. If the original method is standard
253 # `Get`/`Create`/`Update`, the response should be the resource. For other
254 # methods, the response should have the type `XxxResponse`, where `Xxx`
255 # is the original method name. For example, if the original method name
256 # is `TakeSnapshot()`, the inferred response type is
257 # `TakeSnapshotResponse`.
258 "a_key": "", # Properties of the object. Contains field @type with type URL.
259 },
260 "name": "A String", # The server-assigned name, which is only unique within the same service that
261 # originally returns it. If you use the default HTTP mapping, the
262 # `name` should have the format of `operations/some/unique/name`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]263 }</pre>
264</div>
265
266<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]267 <code class="details" id="get">get(serviceName, rolloutId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]268 <pre>Gets a service configuration rollout.
269
270Args:
271 serviceName: string, The name of the service. See the [overview](/service-management/overview)
272for naming requirements. For example: `example.googleapis.com`. (required)
273 rolloutId: string, The id of the rollout resource. (required)
274 x__xgafv: string, V1 error format.
275 Allowed values
276 1 - v1 error format
277 2 - v2 error format
278
279Returns:
280 An object of the form:
281
282 { # A rollout resource that defines how service configuration versions are pushed
283 # to control plane systems. Typically, you create a new version of the
284 # service config, and then create a Rollout to push the service config.
285 "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
286 # the system will automatically rollback to the current Rollout
287 # version. Readonly.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]288 "trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on
289 # traffic percentage.
290 # different
291 # versions of service configurations based on traffic percentage.
292 #
293 # One example of how to gradually rollout a new service configuration using
294 # this
295 # strategy:
296 # Day 1
297 #
298 # Rollout {
299 # id: "example.googleapis.com/rollout_20160206"
300 # traffic_percent_strategy {
301 # percentages: {
302 # "example.googleapis.com/20160201": 70.00
303 # "example.googleapis.com/20160206": 30.00
304 # }
305 # }
306 # }
307 #
308 # Day 2
309 #
310 # Rollout {
311 # id: "example.googleapis.com/rollout_20160207"
312 # traffic_percent_strategy: {
313 # percentages: {
314 # "example.googleapis.com/20160206": 100.00
315 # }
316 # }
317 # }
318 "percentages": { # Maps service configuration IDs to their corresponding traffic percentage.
319 # Key is the service configuration ID, Value is the traffic percentage
320 # which must be greater than 0.0 and the sum must equal to 100.0.
321 "a_key": 3.14,
322 },
323 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]324 "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
325 # and '-' are allowed.
326 #
327 # If not specified by client, the server will generate one. The generated id
328 # will have the form of <date><revision number>, where "date" is the create
329 # date in ISO 8601 format. "revision number" is a monotonically increasing
330 # positive number that is reset every day for each service.
331 # An example of the generated rollout_id is '2016-02-16r1'
332 "serviceName": "A String", # The name of the service associated with this Rollout.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]333 "createdBy": "A String", # The user who created the Rollout. Readonly.
334 "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
335 # Readonly.
336 # used by the system generated rollout to delete a service.
337 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]338 "createTime": "A String", # Creation time of the rollout. Readonly.
339 }</pre>
340</div>
341
342<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]343 <code class="details" id="list">list(serviceName, pageSize=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]344 <pre>Lists the history of the service configuration rollouts for a managed
345service, from the newest to the oldest.
346
347Args:
348 serviceName: string, The name of the service. See the [overview](/service-management/overview)
349for naming requirements. For example: `example.googleapis.com`. (required)
350 pageSize: integer, The max number of items to include in the response list.
351 pageToken: string, The token of the page to retrieve.
352 x__xgafv: string, V1 error format.
353 Allowed values
354 1 - v1 error format
355 2 - v2 error format
356
357Returns:
358 An object of the form:
359
360 { # Response message for ListServiceRollouts method.
361 "nextPageToken": "A String", # The token of the next page of results.
362 "rollouts": [ # The list of rollout resources.
363 { # A rollout resource that defines how service configuration versions are pushed
364 # to control plane systems. Typically, you create a new version of the
365 # service config, and then create a Rollout to push the service config.
366 "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
367 # the system will automatically rollback to the current Rollout
368 # version. Readonly.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]369 "trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on
370 # traffic percentage.
371 # different
372 # versions of service configurations based on traffic percentage.
373 #
374 # One example of how to gradually rollout a new service configuration using
375 # this
376 # strategy:
377 # Day 1
378 #
379 # Rollout {
380 # id: "example.googleapis.com/rollout_20160206"
381 # traffic_percent_strategy {
382 # percentages: {
383 # "example.googleapis.com/20160201": 70.00
384 # "example.googleapis.com/20160206": 30.00
385 # }
386 # }
387 # }
388 #
389 # Day 2
390 #
391 # Rollout {
392 # id: "example.googleapis.com/rollout_20160207"
393 # traffic_percent_strategy: {
394 # percentages: {
395 # "example.googleapis.com/20160206": 100.00
396 # }
397 # }
398 # }
399 "percentages": { # Maps service configuration IDs to their corresponding traffic percentage.
400 # Key is the service configuration ID, Value is the traffic percentage
401 # which must be greater than 0.0 and the sum must equal to 100.0.
402 "a_key": 3.14,
403 },
404 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]405 "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
406 # and '-' are allowed.
407 #
408 # If not specified by client, the server will generate one. The generated id
409 # will have the form of <date><revision number>, where "date" is the create
410 # date in ISO 8601 format. "revision number" is a monotonically increasing
411 # positive number that is reset every day for each service.
412 # An example of the generated rollout_id is '2016-02-16r1'
413 "serviceName": "A String", # The name of the service associated with this Rollout.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]414 "createdBy": "A String", # The user who created the Rollout. Readonly.
415 "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
416 # Readonly.
417 # used by the system generated rollout to delete a service.
418 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]419 "createTime": "A String", # Creation time of the rollout. Readonly.
420 },
421 ],
422 }</pre>
423</div>
424
425<div class="method">
426 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
427 <pre>Retrieves the next page of results.
428
429Args:
430 previous_request: The request for the previous page. (required)
431 previous_response: The response from the request for the previous page. (required)
432
433Returns:
434 A request object that you can call 'execute()' on to request the next
435 page. Returns None if there are no more items in the collection.
436 </pre>
437</div>
438
439</body></html>