Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / servicemanagement_v1.services.rollouts.html
blob: 23a423464eb2bcae865b0259615295e81d1400a7 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(serviceName, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#get">get(serviceName, rolloutId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]85<p class="firstline">Gets a service configuration rollout.</p>
86<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]87 <code><a href="#list">list(serviceName, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code class="details" id="create">create(serviceName, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <pre>Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 serviceName: string, Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]105 The object takes the form of:
106
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107{ # A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]108 &quot;createTime&quot;: &quot;A String&quot;, # Creation time of the rollout. Readonly.
109 &quot;createdBy&quot;: &quot;A String&quot;, # This field is deprecated and will be deleted. Please remove usage of this field.
110 &quot;deleteServiceStrategy&quot;: { # Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service. # The strategy associated with a rollout to delete a `ManagedService`. Readonly.
111 },
112 &quot;rolloutId&quot;: &quot;A String&quot;, # Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, &#x27;.&#x27;, &#x27;_&#x27; and &#x27;-&#x27; are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where &quot;date&quot; is the create date in ISO 8601 format. &quot;revision number&quot; is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is &#x27;2016-02-16r1&#x27;
113 &quot;serviceName&quot;: &quot;A String&quot;, # The name of the service associated with this Rollout.
114 &quot;status&quot;: &quot;A String&quot;, # The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
115 &quot;trafficPercentStrategy&quot;: { # Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: &quot;example.googleapis.com/rollout_20160206&quot; traffic_percent_strategy { percentages: { &quot;example.googleapis.com/20160201&quot;: 70.00 &quot;example.googleapis.com/20160206&quot;: 30.00 } } } Day 2 Rollout { id: &quot;example.googleapis.com/rollout_20160207&quot; traffic_percent_strategy: { percentages: { &quot;example.googleapis.com/20160206&quot;: 100.00 } } } # Google Service Control selects service configurations based on traffic percentage.
116 &quot;percentages&quot;: { # Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.
117 &quot;a_key&quot;: 3.14,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]118 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]119 },
120}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]121
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]130 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]131 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
132 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
133 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
134 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
135 {
136 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
137 },
138 ],
139 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
140 },
141 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
142 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
143 },
144 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
145 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
146 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
147 },
148}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]149</div>
150
151<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]152 <code class="details" id="get">get(serviceName, rolloutId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]153 <pre>Gets a service configuration rollout.
154
155Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]156 serviceName: string, Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]157 rolloutId: string, Required. The id of the rollout resource. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163Returns:
164 An object of the form:
165
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]166 { # A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]167 &quot;createTime&quot;: &quot;A String&quot;, # Creation time of the rollout. Readonly.
168 &quot;createdBy&quot;: &quot;A String&quot;, # This field is deprecated and will be deleted. Please remove usage of this field.
169 &quot;deleteServiceStrategy&quot;: { # Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service. # The strategy associated with a rollout to delete a `ManagedService`. Readonly.
170 },
171 &quot;rolloutId&quot;: &quot;A String&quot;, # Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, &#x27;.&#x27;, &#x27;_&#x27; and &#x27;-&#x27; are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where &quot;date&quot; is the create date in ISO 8601 format. &quot;revision number&quot; is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is &#x27;2016-02-16r1&#x27;
172 &quot;serviceName&quot;: &quot;A String&quot;, # The name of the service associated with this Rollout.
173 &quot;status&quot;: &quot;A String&quot;, # The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
174 &quot;trafficPercentStrategy&quot;: { # Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: &quot;example.googleapis.com/rollout_20160206&quot; traffic_percent_strategy { percentages: { &quot;example.googleapis.com/20160201&quot;: 70.00 &quot;example.googleapis.com/20160206&quot;: 30.00 } } } Day 2 Rollout { id: &quot;example.googleapis.com/rollout_20160207&quot; traffic_percent_strategy: { percentages: { &quot;example.googleapis.com/20160206&quot;: 100.00 } } } # Google Service Control selects service configurations based on traffic percentage.
175 &quot;percentages&quot;: { # Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.
176 &quot;a_key&quot;: 3.14,
177 },
178 },
179}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]180</div>
181
182<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]183 <code class="details" id="list">list(serviceName, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]184 <pre>Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]185
186Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]187 serviceName: string, Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]188 filter: string, Required. Use `filter` to return subset of rollouts. The following filters are supported: -- To limit the results to only those in [status](google.api.servicemanagement.v1.RolloutStatus) &#x27;SUCCESS&#x27;, use filter=&#x27;status=SUCCESS&#x27; -- To limit the results to those in [status](google.api.servicemanagement.v1.RolloutStatus) &#x27;CANCELLED&#x27; or &#x27;FAILED&#x27;, use filter=&#x27;status=CANCELLED OR status=FAILED&#x27;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]189 pageSize: integer, The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]190 pageToken: string, The token of the page to retrieve.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]195
196Returns:
197 An object of the form:
198
199 { # Response message for ListServiceRollouts method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]200 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token of the next page of results.
201 &quot;rollouts&quot;: [ # The list of rollout resources.
202 { # A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config.
203 &quot;createTime&quot;: &quot;A String&quot;, # Creation time of the rollout. Readonly.
204 &quot;createdBy&quot;: &quot;A String&quot;, # This field is deprecated and will be deleted. Please remove usage of this field.
205 &quot;deleteServiceStrategy&quot;: { # Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service. # The strategy associated with a rollout to delete a `ManagedService`. Readonly.
206 },
207 &quot;rolloutId&quot;: &quot;A String&quot;, # Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, &#x27;.&#x27;, &#x27;_&#x27; and &#x27;-&#x27; are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where &quot;date&quot; is the create date in ISO 8601 format. &quot;revision number&quot; is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is &#x27;2016-02-16r1&#x27;
208 &quot;serviceName&quot;: &quot;A String&quot;, # The name of the service associated with this Rollout.
209 &quot;status&quot;: &quot;A String&quot;, # The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
210 &quot;trafficPercentStrategy&quot;: { # Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: &quot;example.googleapis.com/rollout_20160206&quot; traffic_percent_strategy { percentages: { &quot;example.googleapis.com/20160201&quot;: 70.00 &quot;example.googleapis.com/20160206&quot;: 30.00 } } } Day 2 Rollout { id: &quot;example.googleapis.com/rollout_20160207&quot; traffic_percent_strategy: { percentages: { &quot;example.googleapis.com/20160206&quot;: 100.00 } } } # Google Service Control selects service configurations based on traffic percentage.
211 &quot;percentages&quot;: { # Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.
212 &quot;a_key&quot;: 3.14,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]213 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]214 },
215 },
216 ],
217}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]218</div>
219
220<div class="method">
221 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
222 <pre>Retrieves the next page of results.
223
224Args:
225 previous_request: The request for the previous page. (required)
226 previous_response: The response from the request for the previous page. (required)
227
228Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]230 page. Returns None if there are no more items in the collection.
231 </pre>
232</div>
233
234</body></html>