Blame - docs/dyn/compute_v1.backendBuckets.html - platform/external/python/google-api-python-client

2017-03-13 12:12:03 -0400

[diff] [blame]

101

Dan O'Meara

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

[diff] [blame]

102

<code><a href="#update">update(project, backendBucket, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

103

<p class="firstline">Updates the specified BackendBucket resource with the data included in the request.</p>

104

<h3>Method Details</h3>

105

Dan O'Meara

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

[diff] [blame]

106

<code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendBucket, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

107

<pre>Adds a key for validating requests with signed URLs for this backend bucket.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

108

109

Args:

110

project: string, Project ID for this request. (required)

Bu Sun Kim

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

[diff] [blame]

111

backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)

Dan O'Meara

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

[diff] [blame]

112

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

113

The object takes the form of:

114

115

{ # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs

Bu Sun Kim

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

[diff] [blame^]

116

"keyName": "A String", # Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

117

"keyValue": "A String", # 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.

Bu Sun Kim

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

[diff] [blame]

118

}

119

120

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

121

122

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

123

124

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

125

126

Returns:

127

An object of the form:

128

Bu Sun Kim

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

[diff] [blame]

129

{ # Represents an Operation resource.

130

#

Dan O'Meara

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

[diff] [blame]

131

# Google Compute Engine has three Operation resources:

132

#

133

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

134

#

Bu Sun Kim

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

[diff] [blame]

135

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

136

#

137

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

138

# - For global operations, use the `globalOperations` resource.

139

# - For regional operations, use the `regionOperations` resource.

140

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

141

#

Dan O'Meara

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

[diff] [blame]

142

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame^]

143

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

144

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

145

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

146

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

147

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

148

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

149

{

Bu Sun Kim

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

[diff] [blame^]

150

"code": "A String", # [Output Only] The error type identifier for this error.

151

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

152

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

153

},

154

],

155

},

Bu Sun Kim

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

[diff] [blame^]

156

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

157

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

158

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

159

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

160

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

161

"name": "A String", # [Output Only] Name of the operation.

162

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

163

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

164

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

165

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

166

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

167

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

168

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

169

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

170

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

171

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

172

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

173

{

174

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

175

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

176

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

177

{

178

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

179

"value": "A String", # [Output Only] A warning data value corresponding to the key.

180

},

181

],

182

"message": "A String", # [Output Only] A human-readable description of the warning code.

183

},

184

],

185

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(project, backendBucket, requestId=None)</code>

191

<pre>Deletes the specified BackendBucket resource.

192

193

Args:

194

project: string, Project ID for this request. (required)

195

backendBucket: string, Name of the BackendBucket resource to delete. (required)

196

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

197

198

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

199

200

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

201

202

Returns:

203

An object of the form:

204

205

{ # Represents an Operation resource.

206

#

Dan O'Meara

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

[diff] [blame]

207

# Google Compute Engine has three Operation resources:

208

#

209

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

210

#

Bu Sun Kim

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

[diff] [blame]

211

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

212

#

213

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

214

# - For global operations, use the `globalOperations` resource.

215

# - For regional operations, use the `regionOperations` resource.

216

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

217

#

Dan O'Meara

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

[diff] [blame]

218

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame^]

219

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

220

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

221

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

222

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

223

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

224

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

225

{

Bu Sun Kim

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

[diff] [blame^]

226

"code": "A String", # [Output Only] The error type identifier for this error.

227

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

228

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

229

},

230

],

231

},

Bu Sun Kim

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

[diff] [blame^]

232

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

233

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

234

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

235

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

236

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

237

"name": "A String", # [Output Only] Name of the operation.

238

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

239

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

240

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

241

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

242

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

243

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

244

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

245

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

246

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

247

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

248

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

249

{

250

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

251

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

252

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

253

{

254

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

255

"value": "A String", # [Output Only] A warning data value corresponding to the key.

256

},

257

],

258

"message": "A String", # [Output Only] A human-readable description of the warning code.

259

},

260

],

261

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None)</code>

267

<pre>Deletes a key for validating requests with signed URLs for this backend bucket.

268

269

Args:

270

project: string, Project ID for this request. (required)

271

backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)

272

keyName: string, The name of the Signed URL Key to delete. (required)

273

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

274

275

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

276

277

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

278

279

Returns:

280

An object of the form:

281

282

{ # Represents an Operation resource.

283

#

Dan O'Meara

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

[diff] [blame]

284

# Google Compute Engine has three Operation resources:

285

#

286

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

287

#

Bu Sun Kim

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

[diff] [blame]

288

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

289

#

290

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

291

# - For global operations, use the `globalOperations` resource.

292

# - For regional operations, use the `regionOperations` resource.

293

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

294

#

Dan O'Meara

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

[diff] [blame]

295

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame^]

296

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

297

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

298

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

299

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

300

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

301

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

302

{

Bu Sun Kim

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

[diff] [blame^]

303

"code": "A String", # [Output Only] The error type identifier for this error.

304

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

305

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

306

},

307

],

308

},

Bu Sun Kim

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

[diff] [blame^]

309

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

310

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

311

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

312

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

313

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

314

"name": "A String", # [Output Only] Name of the operation.

315

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

316

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

317

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

318

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

319

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

320

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

321

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

322

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

323

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

324

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

325

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

326

{

327

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

328

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

329

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

330

{

331

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

332

"value": "A String", # [Output Only] A warning data value corresponding to the key.

333

},

334

],

335

"message": "A String", # [Output Only] A human-readable description of the warning code.

336

},

337

],

338

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, backendBucket)</code>

Bu Sun Kim

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

[diff] [blame]

344

<pre>Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

345

346

Args:

347

project: string, Project ID for this request. (required)

348

backendBucket: string, Name of the BackendBucket resource to return. (required)

349

350

Returns:

351

An object of the form:

352

Dan O'Meara

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

[diff] [blame]

353

{ # Represents a Cloud Storage Bucket resource.

Bu Sun Kim

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

[diff] [blame^]

354

#

355

# This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

356

"bucketName": "A String", # Cloud Storage bucket name.

357

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.

358

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

359

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

"A String",

],

},

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

364

"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.

365

"enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.

366

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

367

"kind": "compute#backendBucket", # Type of the resource.

368

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

369

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

370

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

374

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

375

<pre>Creates a BackendBucket resource in the specified project using the data included in the request.

376

377

Args:

378

project: string, Project ID for this request. (required)

Dan O'Meara

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

[diff] [blame]

379

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

380

The object takes the form of:

381

Dan O'Meara

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

[diff] [blame]

382

{ # Represents a Cloud Storage Bucket resource.

Bu Sun Kim

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

[diff] [blame^]

383

#

384

# This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

385

"bucketName": "A String", # Cloud Storage bucket name.

386

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.

387

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

388

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

"A String",

],

},

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

393

"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.

394

"enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.

395

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

396

"kind": "compute#backendBucket", # Type of the resource.

397

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

398

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

399

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

400

Bu Sun Kim

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

[diff] [blame]

401

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

402

403

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

404

405

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

406

407

Returns:

408

An object of the form:

409

Bu Sun Kim

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

[diff] [blame]

410

{ # Represents an Operation resource.

411

#

Dan O'Meara

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

[diff] [blame]

412

# Google Compute Engine has three Operation resources:

413

#

414

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

415

#

Bu Sun Kim

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

[diff] [blame]

416

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

417

#

418

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

419

# - For global operations, use the `globalOperations` resource.

420

# - For regional operations, use the `regionOperations` resource.

421

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

422

#

Dan O'Meara

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

[diff] [blame]

423

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame^]

424

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

425

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

426

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

427

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

428

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

429

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

430

{

Bu Sun Kim

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

[diff] [blame^]

431

"code": "A String", # [Output Only] The error type identifier for this error.

432

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

433

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

434

},

435

],

436

},

Bu Sun Kim

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

[diff] [blame^]

437

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

438

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

439

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

440

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

441

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

442

"name": "A String", # [Output Only] Name of the operation.

443

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

444

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

445

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

446

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

447

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

448

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

449

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

450

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

451

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

452

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

453

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

454

{

455

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

456

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

457

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

458

{

459

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

460

"value": "A String", # [Output Only] A warning data value corresponding to the key.

461

},

462

],

463

"message": "A String", # [Output Only] A human-readable description of the warning code.

464

},

465

],

466

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

471

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

472

<pre>Retrieves the list of BackendBucket resources available to the specified project.

473

474

Args:

475

project: string, Project ID for this request. (required)

Dan O'Meara

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

[diff] [blame]

476

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

477

Dan O'Meara

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

[diff] [blame]

478

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

479

Dan O'Meara

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

[diff] [blame]

480

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

481

Bu Sun Kim

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

[diff] [blame^]

482

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

483

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

484

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

485

486

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

487

488

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

489

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

490

491

Returns:

492

An object of the form:

493

494

{ # Contains a list of BackendBucket resources.

Bu Sun Kim

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

[diff] [blame^]

495

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

496

"items": [ # A list of BackendBucket resources.

Dan O'Meara

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

[diff] [blame]

497

{ # Represents a Cloud Storage Bucket resource.

Bu Sun Kim

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

[diff] [blame^]

498

#

499

# This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

500

"bucketName": "A String", # Cloud Storage bucket name.

501

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.

502

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

503

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

504

"A String",

505

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

506

},

Bu Sun Kim

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

[diff] [blame^]

507

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

508

"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.

509

"enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.

510

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

511

"kind": "compute#backendBucket", # Type of the resource.

512

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

513

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

514

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

515

],

Bu Sun Kim

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

[diff] [blame^]

516

"kind": "compute#backendBucketList", # Type of resource.

517

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

518

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

519

"warning": { # [Output Only] Informational warning message.

520

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

521

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

522

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

523

{

Bu Sun Kim

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

[diff] [blame^]

524

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

525

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

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

[diff] [blame]

526

},

527

],

Bu Sun Kim

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

[diff] [blame^]

528

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

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

[diff] [blame]

529

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

535

<pre>Retrieves the next page of results.

536

537

Args:

538

previous_request: The request for the previous page. (required)

539

previous_response: The response from the request for the previous page. (required)

540

541

Returns:

Bu Sun Kim

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

[diff] [blame^]

542

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

543

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

548

<code class="details" id="patch">patch(project, backendBucket, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

549

<pre>Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

550

551

Args:

552

project: string, Project ID for this request. (required)

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

553

backendBucket: string, Name of the BackendBucket resource to patch. (required)

Dan O'Meara

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

[diff] [blame]

554

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

555

The object takes the form of:

556

Dan O'Meara

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

[diff] [blame]

557

{ # Represents a Cloud Storage Bucket resource.

Bu Sun Kim

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

[diff] [blame^]

558

#

559

# This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

560

"bucketName": "A String", # Cloud Storage bucket name.

561

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.

562

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

563

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

"A String",

],

},

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

568

"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.

569

"enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.

570

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

571

"kind": "compute#backendBucket", # Type of the resource.

572

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

573

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

574

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

575

Bu Sun Kim

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

[diff] [blame]

576

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

577

578

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

579

580

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

581

582

Returns:

583

An object of the form:

584

Bu Sun Kim

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

[diff] [blame]

585

{ # Represents an Operation resource.

586

#

Dan O'Meara

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

[diff] [blame]

587

# Google Compute Engine has three Operation resources:

588

#

589

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

590

#

Bu Sun Kim

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

[diff] [blame]

591

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

592

#

593

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

594

# - For global operations, use the `globalOperations` resource.

595

# - For regional operations, use the `regionOperations` resource.

596

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

597

#

Dan O'Meara

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

[diff] [blame]

598

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame^]

599

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

600

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

601

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

602

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

603

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

604

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

605

{

Bu Sun Kim

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

[diff] [blame^]

606

"code": "A String", # [Output Only] The error type identifier for this error.

607

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

608

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

609

},

610

],

611

},

Bu Sun Kim

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

[diff] [blame^]

612

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

613

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

614

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

615

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

616

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

617

"name": "A String", # [Output Only] Name of the operation.

618

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

619

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

620

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

621

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

622

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

623

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

624

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

625

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

626

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

627

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

628

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

629

{

630

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

631

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

632

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

633

{

634

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

635

"value": "A String", # [Output Only] A warning data value corresponding to the key.

636

},

637

],

638

"message": "A String", # [Output Only] A human-readable description of the warning code.

639

},

640

],

641

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

646

<code class="details" id="update">update(project, backendBucket, body=None, requestId=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

647

<pre>Updates the specified BackendBucket resource with the data included in the request.

648

649

Args:

650

project: string, Project ID for this request. (required)

651

backendBucket: string, Name of the BackendBucket resource to update. (required)

Dan O'Meara

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

[diff] [blame]

652

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

653

The object takes the form of:

654

Dan O'Meara

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

[diff] [blame]

655

{ # Represents a Cloud Storage Bucket resource.

Bu Sun Kim

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

[diff] [blame^]

656

#

657

# This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.

658

"bucketName": "A String", # Cloud Storage bucket name.

659

"cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.

660

"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

661

"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.

"A String",

],

},

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

666

"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.

667

"enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.

668

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

669

"kind": "compute#backendBucket", # Type of the resource.

670

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

671

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

672

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

673

Bu Sun Kim

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

[diff] [blame]

674

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

675

676

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

677

678

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

679

680

Returns:

681

An object of the form:

682

Bu Sun Kim

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

[diff] [blame]

683

{ # Represents an Operation resource.

684

#

Dan O'Meara

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

[diff] [blame]

685

# Google Compute Engine has three Operation resources:

686

#

687

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

688

#

Bu Sun Kim

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

[diff] [blame]

689

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

690

#

691

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

692

# - For global operations, use the `globalOperations` resource.

693

# - For regional operations, use the `regionOperations` resource.

694

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

695

#

Dan O'Meara

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

[diff] [blame]

696

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame^]

697

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

698

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

699

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

700

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

701

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

702

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

703

{

Bu Sun Kim

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

[diff] [blame^]

704

"code": "A String", # [Output Only] The error type identifier for this error.

705

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

706

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

707

},

708

],

709

},

Bu Sun Kim