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-07-22 17:02:09 -0700

[diff] [blame^]

84

<code><a href="#list">list(serviceName, pageSize=None, filter=None, pageToken=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-07-22 17:02:09 -0700

[diff] [blame^]

117

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

118

# this field.

119

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

120

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

121

#

122

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

123

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

124

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

125

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

126

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

127

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

128

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

129

# the system will automatically rollback to the current Rollout

130

# version. Readonly.

131

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

132

# Readonly.

133

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

134

},

Bu Sun Kim

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

[diff] [blame]

135

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

136

# traffic percentage.

137

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

138

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

139

# each config version.

140

#

141

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

# this

# strategy:

# Day 1

#

# Rollout {

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

148

# traffic_percent_strategy {

149

# percentages: {

150

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

151

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

# }

# }

# }

#

# Day 2

#

# Rollout {

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

160

# traffic_percent_strategy: {

161

# percentages: {

162

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

# }

# }

# }

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

167

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

168

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

169

"a_key": 3.14,

Jon Wayne Parrott

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

[diff] [blame]

170

},

Bu Sun Kim

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

[diff] [blame]

171

},

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

Bu Sun Kim

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

[diff] [blame]

191

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

192

# message types for APIs to use.

193

{

194

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

195

},

196

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

197

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

198

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

199

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

200

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

Bu Sun Kim

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

[diff] [blame]

201

},

Bu Sun Kim

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

[diff] [blame]

202

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

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

203

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

204

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

205

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

Bu Sun Kim

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

[diff] [blame]

206

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

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

207

},

Bu Sun Kim

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

[diff] [blame]

208

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

209

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

210

# available.

Bu Sun Kim

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

[diff] [blame]

211

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

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

Bu Sun Kim

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

[diff] [blame]

219

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

Dan O'Meara

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

[diff] [blame]

220

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

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 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-07-22 17:02:09 -0700

[diff] [blame^]

247

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

248

# this field.

249

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

250

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

251

#

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

# the system will automatically rollback to the current Rollout

260

# version. Readonly.

261

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

262

# Readonly.

263

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

264

},

Bu Sun Kim

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

[diff] [blame]

265

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

266

# traffic percentage.

267

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

268

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

269

# each config version.

270

#

271

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

# this

# strategy:

# Day 1

#

# Rollout {

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

278

# traffic_percent_strategy {

279

# percentages: {

280

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

281

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

# }

# }

# }

#

# Day 2

#

# Rollout {

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

290

# traffic_percent_strategy: {

291

# percentages: {

292

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

# }

# }

# }

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

297

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

298

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

299

"a_key": 3.14,

Jon Wayne Parrott

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

[diff] [blame]

300

},

Bu Sun Kim

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

[diff] [blame]

301

},

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-07-22 17:02:09 -0700

[diff] [blame^]

306

<code class="details" id="list">list(serviceName, pageSize=None, filter=None, pageToken=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-07-22 17:02:09 -0700

[diff] [blame^]

313

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

314

if not specified. Maximum value is 100.

Bu Sun Kim

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

[diff] [blame]

315

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

316

The following filters are supported:

317

-- To limit the results to only those in

318

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

319

use filter='status=SUCCESS'

320

-- To limit the results to those in

321

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

322

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

323

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

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-07-22 17:02:09 -0700

[diff] [blame^]

333

"nextPageToken": "A String", # The token of the next page of results.

Bu Sun Kim

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

[diff] [blame]

334

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

Jon Wayne Parrott

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

[diff] [blame]

335

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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

338

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

339

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

340

# this field.

341

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

342

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

343

#

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

# the system will automatically rollback to the current Rollout

352

# version. Readonly.

353

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

354

# Readonly.

355

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

356

},

Bu Sun Kim