Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / servicemanagement_v1.services.rollouts.html
blob: 935668baabb1c32bce6ab6fdb0e0178b66d8eb15 [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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]75<h1><a href="servicemanagement_v1.html">Service Management API</a> . <a href="servicemanagement_v1.services.html">services</a> . <a href="servicemanagement_v1.services.rollouts.html">rollouts</a></h1>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]78 <code><a href="#create">create(serviceName, body, baseRolloutId=None, 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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]84 <code><a href="#list">list(serviceName, pageSize=None, pageToken=None, x__xgafv=None, filter=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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]91 <code class="details" id="create">create(serviceName, body, baseRolloutId=None, 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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]101Only the 100 most recent (in any state) and the last 10 successful (if not
102already part of the set of 100 most recent) rollouts are kept for each
103service. The rest will be deleted eventually.
104
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]105Operation<response: Rollout>
106
107Args:
108 serviceName: string, The name of the service. See the [overview](/service-management/overview)
109for naming requirements. For example: `example.googleapis.com`. (required)
110 body: object, The request body. (required)
111 The object takes the form of:
112
113{ # A rollout resource that defines how service configuration versions are pushed
114 # to control plane systems. Typically, you create a new version of the
115 # service config, and then create a Rollout to push the service config.
116 "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
117 # the system will automatically rollback to the current Rollout
118 # version. Readonly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]119 "trafficPercentStrategy": { # Strategy that specifies how clients of Google Service Controller want to # Google Service Control selects service configurations based on
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]120 # traffic percentage.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]121 # send traffic to use different config versions. This is generally
122 # used by API proxy to split traffic based on your configured precentage for
123 # each config version.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]124 #
125 # One example of how to gradually rollout a new service configuration using
126 # this
127 # strategy:
128 # Day 1
129 #
130 # Rollout {
131 # id: "example.googleapis.com/rollout_20160206"
132 # traffic_percent_strategy {
133 # percentages: {
134 # "example.googleapis.com/20160201": 70.00
135 # "example.googleapis.com/20160206": 30.00
136 # }
137 # }
138 # }
139 #
140 # Day 2
141 #
142 # Rollout {
143 # id: "example.googleapis.com/rollout_20160207"
144 # traffic_percent_strategy: {
145 # percentages: {
146 # "example.googleapis.com/20160206": 100.00
147 # }
148 # }
149 # }
150 "percentages": { # Maps service configuration IDs to their corresponding traffic percentage.
151 # Key is the service configuration ID, Value is the traffic percentage
152 # which must be greater than 0.0 and the sum must equal to 100.0.
153 "a_key": 3.14,
154 },
155 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]156 "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
157 # and '-' are allowed.
158 #
159 # If not specified by client, the server will generate one. The generated id
160 # will have the form of <date><revision number>, where "date" is the create
161 # date in ISO 8601 format. "revision number" is a monotonically increasing
162 # positive number that is reset every day for each service.
163 # An example of the generated rollout_id is '2016-02-16r1'
164 "serviceName": "A String", # The name of the service associated with this Rollout.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]165 "createdBy": "A String", # The user who created the Rollout. Readonly.
166 "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
167 # Readonly.
168 # used by the system generated rollout to delete a service.
169 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]170 "createTime": "A String", # Creation time of the rollout. Readonly.
171 }
172
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]173 baseRolloutId: string, Unimplemented. Do not use this feature until this comment is removed.
174
175The rollout id that rollout to be created based on.
176
177Rollout should be constructed based on current successful rollout, this
178field indicates the current successful rollout id that new rollout based on
179to construct, if current successful rollout changed when server receives
180the request, request will be rejected for safety.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186Returns:
187 An object of the form:
188
189 { # This resource represents a long-running operation that is the result of a
190 # network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]191 "response": { # The normal response of the operation in case of success. If the original
192 # method returns no data on success, such as `Delete`, the response is
193 # `google.protobuf.Empty`. If the original method is standard
194 # `Get`/`Create`/`Update`, the response should be the resource. For other
195 # methods, the response should have the type `XxxResponse`, where `Xxx`
196 # is the original method name. For example, if the original method name
197 # is `TakeSnapshot()`, the inferred response type is
198 # `TakeSnapshotResponse`.
199 "a_key": "", # Properties of the object. Contains field @type with type URL.
200 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]201 "metadata": { # Service-specific metadata associated with the operation. It typically
202 # contains progress information and common metadata such as create time.
203 # Some services might not provide such metadata. Any method that returns a
204 # long-running operation should document the metadata type, if any.
205 "a_key": "", # Properties of the object. Contains field @type with type URL.
206 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]207 "done": True or False, # If the value is `false`, it means the operation is still in progress.
208 # If `true`, the operation is completed, and either `error` or `response` is
209 # available.
210 "name": "A String", # The server-assigned name, which is only unique within the same service that
211 # originally returns it. If you use the default HTTP mapping, the
212 # `name` should be a resource name ending with `operations/{unique_id}`.
213 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
214 # different programming environments, including REST APIs and RPC APIs. It is
215 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
216 # three pieces of data: error code, error message, and error details.
217 #
218 # You can find out more about this error model and how to work with it in the
219 # [API Design Guide](https://cloud.google.com/apis/design/errors).
220 "message": "A String", # A developer-facing error message, which should be in English. Any
221 # user-facing error message should be localized and sent in the
222 # google.rpc.Status.details field, or localized by the client.
223 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
224 "details": [ # A list of messages that carry the error details. There is a common set of
225 # message types for APIs to use.
226 {
227 "a_key": "", # Properties of the object. Contains field @type with type URL.
228 },
229 ],
230 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]231 }</pre>
232</div>
233
234<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]235 <code class="details" id="get">get(serviceName, rolloutId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]236 <pre>Gets a service configuration rollout.
237
238Args:
239 serviceName: string, The name of the service. See the [overview](/service-management/overview)
240for naming requirements. For example: `example.googleapis.com`. (required)
241 rolloutId: string, The id of the rollout resource. (required)
242 x__xgafv: string, V1 error format.
243 Allowed values
244 1 - v1 error format
245 2 - v2 error format
246
247Returns:
248 An object of the form:
249
250 { # A rollout resource that defines how service configuration versions are pushed
251 # to control plane systems. Typically, you create a new version of the
252 # service config, and then create a Rollout to push the service config.
253 "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
254 # the system will automatically rollback to the current Rollout
255 # version. Readonly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]256 "trafficPercentStrategy": { # Strategy that specifies how clients of Google Service Controller want to # Google Service Control selects service configurations based on
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]257 # traffic percentage.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]258 # send traffic to use different config versions. This is generally
259 # used by API proxy to split traffic based on your configured precentage for
260 # each config version.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]261 #
262 # One example of how to gradually rollout a new service configuration using
263 # this
264 # strategy:
265 # Day 1
266 #
267 # Rollout {
268 # id: "example.googleapis.com/rollout_20160206"
269 # traffic_percent_strategy {
270 # percentages: {
271 # "example.googleapis.com/20160201": 70.00
272 # "example.googleapis.com/20160206": 30.00
273 # }
274 # }
275 # }
276 #
277 # Day 2
278 #
279 # Rollout {
280 # id: "example.googleapis.com/rollout_20160207"
281 # traffic_percent_strategy: {
282 # percentages: {
283 # "example.googleapis.com/20160206": 100.00
284 # }
285 # }
286 # }
287 "percentages": { # Maps service configuration IDs to their corresponding traffic percentage.
288 # Key is the service configuration ID, Value is the traffic percentage
289 # which must be greater than 0.0 and the sum must equal to 100.0.
290 "a_key": 3.14,
291 },
292 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]293 "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
294 # and '-' are allowed.
295 #
296 # If not specified by client, the server will generate one. The generated id
297 # will have the form of <date><revision number>, where "date" is the create
298 # date in ISO 8601 format. "revision number" is a monotonically increasing
299 # positive number that is reset every day for each service.
300 # An example of the generated rollout_id is '2016-02-16r1'
301 "serviceName": "A String", # The name of the service associated with this Rollout.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]302 "createdBy": "A String", # The user who created the Rollout. Readonly.
303 "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
304 # Readonly.
305 # used by the system generated rollout to delete a service.
306 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]307 "createTime": "A String", # Creation time of the rollout. Readonly.
308 }</pre>
309</div>
310
311<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]312 <code class="details" id="list">list(serviceName, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]313 <pre>Lists the history of the service configuration rollouts for a managed
314service, from the newest to the oldest.
315
316Args:
317 serviceName: string, The name of the service. See the [overview](/service-management/overview)
318for naming requirements. For example: `example.googleapis.com`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]319 pageSize: integer, The max number of items to include in the response list. Page size is 50
320if not specified. Maximum value is 100.
321 pageToken: string, The token of the page to retrieve.
322 x__xgafv: string, V1 error format.
323 Allowed values
324 1 - v1 error format
325 2 - v2 error format
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]326 filter: string, Use `filter` to return subset of rollouts.
327The following filters are supported:
328 -- To limit the results to only those in
329 [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',
330 use filter='status=SUCCESS'
331 -- To limit the results to those in
332 [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'
333 or 'FAILED', use filter='status=CANCELLED OR status=FAILED'
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]334
335Returns:
336 An object of the form:
337
338 { # Response message for ListServiceRollouts method.
339 "nextPageToken": "A String", # The token of the next page of results.
340 "rollouts": [ # The list of rollout resources.
341 { # A rollout resource that defines how service configuration versions are pushed
342 # to control plane systems. Typically, you create a new version of the
343 # service config, and then create a Rollout to push the service config.
344 "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
345 # the system will automatically rollback to the current Rollout
346 # version. Readonly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]347 "trafficPercentStrategy": { # Strategy that specifies how clients of Google Service Controller want to # Google Service Control selects service configurations based on
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]348 # traffic percentage.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]349 # send traffic to use different config versions. This is generally
350 # used by API proxy to split traffic based on your configured precentage for
351 # each config version.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]352 #
353 # One example of how to gradually rollout a new service configuration using
354 # this
355 # strategy:
356 # Day 1
357 #
358 # Rollout {
359 # id: "example.googleapis.com/rollout_20160206"
360 # traffic_percent_strategy {
361 # percentages: {
362 # "example.googleapis.com/20160201": 70.00
363 # "example.googleapis.com/20160206": 30.00
364 # }
365 # }
366 # }
367 #
368 # Day 2
369 #
370 # Rollout {
371 # id: "example.googleapis.com/rollout_20160207"
372 # traffic_percent_strategy: {
373 # percentages: {
374 # "example.googleapis.com/20160206": 100.00
375 # }
376 # }
377 # }
378 "percentages": { # Maps service configuration IDs to their corresponding traffic percentage.
379 # Key is the service configuration ID, Value is the traffic percentage
380 # which must be greater than 0.0 and the sum must equal to 100.0.
381 "a_key": 3.14,
382 },
383 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]384 "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
385 # and '-' are allowed.
386 #
387 # If not specified by client, the server will generate one. The generated id
388 # will have the form of <date><revision number>, where "date" is the create
389 # date in ISO 8601 format. "revision number" is a monotonically increasing
390 # positive number that is reset every day for each service.
391 # An example of the generated rollout_id is '2016-02-16r1'
392 "serviceName": "A String", # The name of the service associated with this Rollout.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]393 "createdBy": "A String", # The user who created the Rollout. Readonly.
394 "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
395 # Readonly.
396 # used by the system generated rollout to delete a service.
397 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]398 "createTime": "A String", # Creation time of the rollout. Readonly.
399 },
400 ],
401 }</pre>
402</div>
403
404<div class="method">
405 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
406 <pre>Retrieves the next page of results.
407
408Args:
409 previous_request: The request for the previous page. (required)
410 previous_response: The response from the request for the previous page. (required)
411
412Returns:
413 A request object that you can call 'execute()' on to request the next
414 page. Returns None if there are no more items in the collection.
415 </pre>
416</div>
417
418</body></html>