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