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, 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, 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, pageSize=None, filter=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, 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 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 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. 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 }, 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. 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 }, 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 "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. 179 # programming environments, including REST APIs and RPC APIs. It is used by 180 # [gRPC](https://github.com/grpc). The error model is designed to be: 181 # 182 # - Simple to use and understand for most users 183 # - Flexible enough to meet unexpected needs 184 # 185 # # Overview 186 # 187 # The `Status` message contains three pieces of data: error code, error message, 188 # and error details. The error code should be an enum value of 189 # google.rpc.Code, but it may accept additional error codes if needed. The 190 # error message should be a developer-facing English message that helps 191 # developers *understand* and *resolve* the error. If a localized user-facing 192 # error message is needed, put the localized message in the error details or 193 # localize it in the client. The optional error details may contain arbitrary 194 # information about the error. There is a predefined set of error detail types 195 # in the package `google.rpc` that can be used for common error conditions. 196 # 197 # # Language mapping 198 # 199 # The `Status` message is the logical representation of the error model, but it 200 # is not necessarily the actual wire format. When the `Status` message is 201 # exposed in different client libraries and different wire protocols, it can be 202 # mapped differently. For example, it will likely be mapped to some exceptions 203 # in Java, but more likely mapped to some error codes in C. 204 # 205 # # Other uses 206 # 207 # The error model and the `Status` message can be used in a variety of 208 # environments, either with or without APIs, to provide a 209 # consistent developer experience across different environments. 210 # 211 # Example uses of this error model include: 212 # 213 # - Partial errors. If a service needs to return partial errors to the client, 214 # it may embed the `Status` in the normal response to indicate the partial 215 # errors. 216 # 217 # - Workflow errors. A typical workflow has multiple steps. Each step may 218 # have a `Status` message for error reporting. 219 # 220 # - Batch operations. If a client uses batch request and batch response, the 221 # `Status` message should be used directly inside batch response, one for 222 # each error sub-response. 223 # 224 # - Asynchronous operations. If an API call embeds asynchronous operation 225 # results in its response, the status of those operations should be 226 # represented directly using the `Status` message. 227 # 228 # - Logging. If some API errors are stored in logs, the message `Status` could 229 # be used directly after any stripping needed for security/privacy reasons. 230 "message": "A String", # A developer-facing error message, which should be in English. Any 231 # user-facing error message should be localized and sent in the 232 # google.rpc.Status.details field, or localized by the client. 233 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 234 "details": [ # A list of messages that carry the error details. There will be a 235 # common set of message types for APIs to use. 236 { 237 "a_key": "", # Properties of the object. Contains field @type with type URL. 238 }, 239 ], 240 }, 241 "done": True or False, # If the value is `false`, it means the operation is still in progress. 242 # If true, the operation is completed, and either `error` or `response` is 243 # available. 244 "response": { # The normal response of the operation in case of success. If the original 245 # method returns no data on success, such as `Delete`, the response is 246 # `google.protobuf.Empty`. If the original method is standard 247 # `Get`/`Create`/`Update`, the response should be the resource. For other 248 # methods, the response should have the type `XxxResponse`, where `Xxx` 249 # is the original method name. For example, if the original method name 250 # is `TakeSnapshot()`, the inferred response type is 251 # `TakeSnapshotResponse`. 252 "a_key": "", # Properties of the object. Contains field @type with type URL. 253 }, 254 "name": "A String", # The server-assigned name, which is only unique within the same service that 255 # originally returns it. If you use the default HTTP mapping, the 256 # `name` should have the format of `operations/some/unique/name`. 257 "metadata": { # Service-specific metadata associated with the operation. It typically 258 # contains progress information and common metadata such as create time. 259 # Some services might not provide such metadata. Any method that returns a 260 # long-running operation should document the metadata type, if any. 261 "a_key": "", # Properties of the object. Contains field @type with type URL. 262 }, 263 }</pre> 264</div> 265 266<div class="method"> 267 <code class="details" id="get">get(serviceName, rolloutId, x__xgafv=None)</code> 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. 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 }, 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. 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 }, 338 "createTime": "A String", # Creation time of the rollout. Readonly. 339 }</pre> 340</div> 341 342<div class="method"> 343 <code class="details" id="list">list(serviceName, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code> 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 filter: string, Use `filter` to return subset of rollouts. 352The following filters are supported: 353 -- To limit the results to only those in 354 [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', 355 use filter='status=SUCCESS' 356 -- To limit the results to those in 357 [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' 358 or 'FAILED', use filter='status=CANCELLED OR status=FAILED' 359 pageToken: string, The token of the page to retrieve. 360 x__xgafv: string, V1 error format. 361 Allowed values 362 1 - v1 error format 363 2 - v2 error format 364 365Returns: 366 An object of the form: 367 368 { # Response message for ListServiceRollouts method. 369 "nextPageToken": "A String", # The token of the next page of results. 370 "rollouts": [ # The list of rollout resources. 371 { # A rollout resource that defines how service configuration versions are pushed 372 # to control plane systems. Typically, you create a new version of the 373 # service config, and then create a Rollout to push the service config. 374 "status": "A String", # The status of this rollout. Readonly. In case of a failed rollout, 375 # the system will automatically rollback to the current Rollout 376 # version. Readonly. 377 "trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on 378 # traffic percentage. 379 # different 380 # versions of service configurations based on traffic percentage. 381 # 382 # One example of how to gradually rollout a new service configuration using 383 # this 384 # strategy: 385 # Day 1 386 # 387 # Rollout { 388 # id: "example.googleapis.com/rollout_20160206" 389 # traffic_percent_strategy { 390 # percentages: { 391 # "example.googleapis.com/20160201": 70.00 392 # "example.googleapis.com/20160206": 30.00 393 # } 394 # } 395 # } 396 # 397 # Day 2 398 # 399 # Rollout { 400 # id: "example.googleapis.com/rollout_20160207" 401 # traffic_percent_strategy: { 402 # percentages: { 403 # "example.googleapis.com/20160206": 100.00 404 # } 405 # } 406 # } 407 "percentages": { # Maps service configuration IDs to their corresponding traffic percentage. 408 # Key is the service configuration ID, Value is the traffic percentage 409 # which must be greater than 0.0 and the sum must equal to 100.0. 410 "a_key": 3.14, 411 }, 412 }, 413 "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits 414 # and '-' are allowed. 415 # 416 # If not specified by client, the server will generate one. The generated id 417 # will have the form of <date><revision number>, where "date" is the create 418 # date in ISO 8601 format. "revision number" is a monotonically increasing 419 # positive number that is reset every day for each service. 420 # An example of the generated rollout_id is '2016-02-16r1' 421 "serviceName": "A String", # The name of the service associated with this Rollout. 422 "createdBy": "A String", # The user who created the Rollout. Readonly. 423 "deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`. 424 # Readonly. 425 # used by the system generated rollout to delete a service. 426 }, 427 "createTime": "A String", # Creation time of the rollout. Readonly. 428 }, 429 ], 430 }</pre> 431</div> 432 433<div class="method"> 434 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 435 <pre>Retrieves the next page of results. 436 437Args: 438 previous_request: The request for the previous page. (required) 439 previous_response: The response from the request for the previous page. (required) 440 441Returns: 442 A request object that you can call 'execute()' on to request the next 443 page. Returns None if there are no more items in the collection. 444 </pre> 445</div> 446 447</body></html>