Blame - docs/dyn/servicemanagement_v1.services.rollouts.html - platform/external/python/google-api-python-client

2016-08-16 12:44:29 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

2020-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 Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

79

<p class="firstline">Creates a new service configuration rollout. Based on rollout, the</p>

80

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

81

<code><a href="#get">get(serviceName, rolloutId, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

82

<p class="firstline">Gets a service configuration rollout.</p>

83

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

84

<code><a href="#list">list(serviceName, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-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

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

91

<code class="details" id="create">create(serviceName, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

92

<pre>Creates a new service configuration rollout. Based on rollout, the

93

Google Service Management will roll out the service configurations to

94

different backend services. For example, the logging configuration will be

95

pushed to Google Cloud Logging.

96

Jon Wayne Parrott

2512a0c

2016-08-29 10:21:22 -0700

[diff] [blame]

97

Please note that any previous pending and running Rollouts and associated

98

Operations will be automatically cancelled so that the latest Rollout will

99

not be blocked by previous Rollouts.

100

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

101

Only the 100 most recent (in any state) and the last 10 successful (if not

102

already part of the set of 100 most recent) rollouts are kept for each

103

service. The rest will be deleted eventually.

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

Operation<response: Rollout>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

106

107

Args:

Dan O'Meara

2020-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 Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

109

for naming requirements. For example: `example.googleapis.com`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

110

body: object, The request body.

Jon Wayne Parrott

2016-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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

116

"serviceName": "A String", # The name of the service associated with this Rollout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

117

"trafficPercentStrategy": { # Strategy that specifies how clients of Google Service Controller want to # Google Service Control selects service configurations based on

118

# traffic percentage.

119

# send traffic to use different config versions. This is generally

120

# used by API proxy to split traffic based on your configured percentage for

121

# each config version.

122

#

123

# One example of how to gradually rollout a new service configuration using

# this

# strategy:

# Day 1

#

# Rollout {

# id: "example.googleapis.com/rollout_20160206"

130

# traffic_percent_strategy {

131

# percentages: {

132

# "example.googleapis.com/20160201": 70.00

133

# "example.googleapis.com/20160206": 30.00

# }

# }

# }

#

# Day 2

#

# Rollout {

# id: "example.googleapis.com/rollout_20160207"

142

# traffic_percent_strategy: {

143

# percentages: {

144

# "example.googleapis.com/20160206": 100.00

# }

# }

# }

"percentages": { # Maps service configuration IDs to their corresponding traffic percentage.

149

# Key is the service configuration ID, Value is the traffic percentage

150

# which must be greater than 0.0 and the sum must equal to 100.0.

151

"a_key": 3.14,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

152

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

153

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

154

"createTime": "A String", # Creation time of the rollout. Readonly.

155

"deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.

156

# Readonly.

157

# used by the system generated rollout to delete a service.

158

},

159

"createdBy": "A String", # This field is deprecated and will be deleted. Please remove usage of

160

# this field.

161

"status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,

162

# the system will automatically rollback to the current Rollout

163

# version. Readonly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

164

"rolloutId": "A String", # Optional. Unique identifier of this Rollout. Must be no longer than 63 characters

165

# and only lower case letters, digits, '.', '_' and '-' are allowed.

166

#

167

# If not specified by client, the server will generate one. The generated id

168

# will have the form of <date><revision number>, where "date" is the create

169

# date in ISO 8601 format. "revision number" is a monotonically increasing

170

# positive number that is reset every day for each service.

171

# An example of the generated rollout_id is '2016-02-16r1'

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

172

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

173

174

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

181

182

{ # This resource represents a long-running operation that is the result of a

183

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

184

"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.

185

# different programming environments, including REST APIs and RPC APIs. It is

186

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

187

# three pieces of data: error code, error message, and error details.

188

#

189

# You can find out more about this error model and how to work with it in the

190

# [API Design Guide](https://cloud.google.com/apis/design/errors).

191

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

192

"message": "A String", # A developer-facing error message, which should be in English. Any

193

# user-facing error message should be localized and sent in the

194

# google.rpc.Status.details field, or localized by the client.

195

"details": [ # A list of messages that carry the error details. There is a common set of

196

# message types for APIs to use.

197

{

198

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"name": "A String", # The server-assigned name, which is only unique within the same service that

203

# originally returns it. If you use the default HTTP mapping, the

204

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

205

"metadata": { # Service-specific metadata associated with the operation. It typically

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

206

# contains progress information and common metadata such as create time.

207

# Some services might not provide such metadata. Any method that returns a

208

# long-running operation should document the metadata type, if any.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

209

"a_key": "", # Properties of the object. Contains field @type with type URL.

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

210

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

211

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

212

# If `true`, the operation is completed, and either `error` or `response` is

213

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

214

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

215

# method returns no data on success, such as `Delete`, the response is

216

# `google.protobuf.Empty`. If the original method is standard

217

# `Get`/`Create`/`Update`, the response should be the resource. For other

218

# methods, the response should have the type `XxxResponse`, where `Xxx`

219

# is the original method name. For example, if the original method name

220

# is `TakeSnapshot()`, the inferred response type is

221

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

222

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

223

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

228

<code class="details" id="get">get(serviceName, rolloutId, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

229

<pre>Gets a service configuration rollout.

230

231

Args:

Dan O'Meara

2020-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 Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

233

for naming requirements. For example: `example.googleapis.com`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

234

rolloutId: string, Required. The id of the rollout resource. (required)

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

235

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

242

243

{ # A rollout resource that defines how service configuration versions are pushed

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

246

"serviceName": "A String", # The name of the service associated with this Rollout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

247

"trafficPercentStrategy": { # Strategy that specifies how clients of Google Service Controller want to # Google Service Control selects service configurations based on

248

# traffic percentage.

249

# send traffic to use different config versions. This is generally

250

# used by API proxy to split traffic based on your configured percentage for

251

# each config version.

252

#

253

# One example of how to gradually rollout a new service configuration using

# this

# strategy:

# Day 1

#

# Rollout {

# id: "example.googleapis.com/rollout_20160206"

260

# traffic_percent_strategy {

261

# percentages: {

262

# "example.googleapis.com/20160201": 70.00

263

# "example.googleapis.com/20160206": 30.00

# }

# }

# }

#

# Day 2

#

# Rollout {

# id: "example.googleapis.com/rollout_20160207"

272

# traffic_percent_strategy: {

273

# percentages: {

274

# "example.googleapis.com/20160206": 100.00

# }

# }

# }

"percentages": { # Maps service configuration IDs to their corresponding traffic percentage.

279

# Key is the service configuration ID, Value is the traffic percentage

280

# which must be greater than 0.0 and the sum must equal to 100.0.

281

"a_key": 3.14,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

282

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

283

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

284

"createTime": "A String", # Creation time of the rollout. Readonly.

285

"deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.

286

# Readonly.

287

# used by the system generated rollout to delete a service.

288

},

289

"createdBy": "A String", # This field is deprecated and will be deleted. Please remove usage of

290

# this field.

291

"status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,

292

# the system will automatically rollback to the current Rollout

293

# version. Readonly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

294

"rolloutId": "A String", # Optional. Unique identifier of this Rollout. Must be no longer than 63 characters

295

# and only lower case letters, digits, '.', '_' and '-' are allowed.

296

#

297

# If not specified by client, the server will generate one. The generated id

298

# will have the form of <date><revision number>, where "date" is the create

299

# date in ISO 8601 format. "revision number" is a monotonically increasing

300

# positive number that is reset every day for each service.

301

# An example of the generated rollout_id is '2016-02-16r1'

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

302

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

306

<code class="details" id="list">list(serviceName, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

307

<pre>Lists the history of the service configuration rollouts for a managed

308

service, from the newest to the oldest.

309

310

Args:

Dan O'Meara

2020-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 Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

312

for naming requirements. For example: `example.googleapis.com`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

313

pageToken: string, The token of the page to retrieve.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

314

filter: string, Required. Use `filter` to return subset of rollouts.

315

The following filters are supported:

316

-- To limit the results to only those in

317

[status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',

318

use filter='status=SUCCESS'

319

-- To limit the results to those in

320

[status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'

321

or 'FAILED', use filter='status=CANCELLED OR status=FAILED'

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

322

pageSize: integer, The max number of items to include in the response list. Page size is 50

323

if not specified. Maximum value is 100.

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

324

x__xgafv: string, V1 error format.

325

Allowed values

326

1 - v1 error format

327

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

328

329

Returns:

330

An object of the form:

331

332

{ # Response message for ListServiceRollouts method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

333

"rollouts": [ # The list of rollout resources.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

334

{ # A rollout resource that defines how service configuration versions are pushed

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

335

# to control plane systems. Typically, you create a new version of the

336

# service config, and then create a Rollout to push the service config.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

337

"serviceName": "A String", # The name of the service associated with this Rollout.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

338

"trafficPercentStrategy": { # Strategy that specifies how clients of Google Service Controller want to # Google Service Control selects service configurations based on

339

# traffic percentage.

340

# send traffic to use different config versions. This is generally

341

# used by API proxy to split traffic based on your configured percentage for

342

# each config version.

343

#

344

# One example of how to gradually rollout a new service configuration using

# this

# strategy:

# Day 1

#

# Rollout {

# id: "example.googleapis.com/rollout_20160206"

351

# traffic_percent_strategy {

352

# percentages: {

353

# "example.googleapis.com/20160201": 70.00

354

# "example.googleapis.com/20160206": 30.00

# }

# }

# }

#

# Day 2

#

# Rollout {

# id: "example.googleapis.com/rollout_20160207"

363

# traffic_percent_strategy: {

364

# percentages: {

365

# "example.googleapis.com/20160206": 100.00

# }

# }

# }

"percentages": { # Maps service configuration IDs to their corresponding traffic percentage.

370

# Key is the service configuration ID, Value is the traffic percentage

371

# which must be greater than 0.0 and the sum must equal to 100.0.

372

"a_key": 3.14,

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

373

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

374

},

Bu Sun Kim