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