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

2017-01-06 09:58:29 -0800

[diff] [blame]

107

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

108

<code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None)</a></code></p>

109

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>

110

111

<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>

112

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

113

Dan O'Meara

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

[diff] [blame]

114

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

115

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

116

<h3>Method Details</h3>

117

Dan O'Meara

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

[diff] [blame]

118

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

119

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

120

121

Args:

122

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

Bu Sun Kim

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

[diff] [blame]

123

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]

124

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

125

The object takes the form of:

126

127

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

128

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

129

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

130

}

Bu Sun Kim

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

[diff] [blame]

131

132

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.

133

134

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.

135

136

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

137

138

Returns:

139

An object of the form:

140

Bu Sun Kim

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

[diff] [blame]

141

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

142

#

143

# Google Compute Engine has three Operation resources:

144

#

145

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

146

#

147

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

148

#

149

# Operations can be global, regional or zonal.

150

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

151

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

152

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

153

#

154

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

155

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

156

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

157

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

158

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

159

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

160

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

Bu Sun Kim

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

[diff] [blame]

161

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

162

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

163

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

164

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

Bu Sun Kim

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

[diff] [blame]

165

},

166

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

167

},

168

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

169

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

170

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

171

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

172

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

173

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

174

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

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

186

{

187

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

188

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

189

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

190

{

191

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

192

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

193

},

194

],

195

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

196

},

197

],

198

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

199

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

203

<code class="details" id="close">close()</code>

204

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

208

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

209

<pre>Deletes the specified BackendBucket resource.

210

211

Args:

212

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

213

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

214

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.

215

216

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.

217

218

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

219

220

Returns:

221

An object of the form:

222

223

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

224

#

225

# Google Compute Engine has three Operation resources:

226

#

227

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

228

#

229

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

230

#

231

# Operations can be global, regional or zonal.

232

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

233

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

234

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

235

#

236

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

237

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

238

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

239

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

240

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

241

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

242

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

Bu Sun Kim

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

[diff] [blame]

243

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

244

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

245

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

246

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

Bu Sun Kim

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

[diff] [blame]

247

},

248

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

249

},

250

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

251

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

252

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

253

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

254

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

255

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

256

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

{

269

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

270

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

271

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

272

{

273

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

274

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

275

},

276

],

277

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

278

},

279

],

280

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

281

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

286

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

287

288

Args:

289

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

290

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

291

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

292

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.

293

294

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.

295

296

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

297

298

Returns:

299

An object of the form:

300

301

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

302

#

303

# Google Compute Engine has three Operation resources:

304

#

305

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

306

#

307

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

308

#

309

# Operations can be global, regional or zonal.

310

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

311

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

312

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

313

#

314

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

315

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

316

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

317

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

318

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

319

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

320

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

Bu Sun Kim

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

[diff] [blame]

321

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

322

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

323

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

324

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

Bu Sun Kim

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

[diff] [blame]

325

},

326

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

327

},

328

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

329

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

330

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

331

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

332

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

333

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

334

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

{

347

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

348

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

349

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

350

{

351

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

352

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

353

},

354

],

355

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

356

},

357

],

358

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

359

}</pre>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

</div>

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

Bu Sun Kim

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

[diff] [blame]

364

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

365

366

Args:

367

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

368

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

369

370

Returns:

371

An object of the form:

372

Dan O'Meara

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

[diff] [blame]

373

{ # Represents a Cloud Storage Bucket resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

374

#

375

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

376

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

377

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

378

"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.

379

{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.

380

"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.

381

},

382

],

383

"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:

384

#

385

# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.

386

#

387

# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.

388

#

389

# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

390

"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

391

"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

392

"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

393

"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.

394

"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.

395

{ # Specify CDN TTLs for response error codes.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

396

"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

397

"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

398

},

399

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

400

"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

401

"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

402

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

403

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

404

"A String",

405

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

406

},

407

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

408

"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.

409

"A String",

410

],

411

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

412

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

413

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

414

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

415

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

416

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

417

}</pre>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

421

<code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None)</code>

422

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

423

424

Args:

425

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

426

resource: string, Name or id of the resource for this request. (required)

427

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

428

429

Returns:

430

An object of the form:

431

432

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

437

#

438

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

447

#

448

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

449

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

450

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

451

#

452

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

453

#

454

# Example Policy with multiple AuditConfigs:

455

#

456

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

457

#

458

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

459

"auditLogConfigs": [ # The configuration for logging of each type of permission.

460

{ # Provides the configuration for logging a type of permissions. Example:

461

#

462

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

463

#

464

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

465

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

466

"A String",

467

],

468

"ignoreChildExemptions": True or False,

469

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

476

},

477

],

478

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

479

{ # Associates `members` with a `role`.

480

"bindingId": "A String",

481

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

482

#

483

# If the condition evaluates to `true`, then this binding applies to the current request.

484

#

485

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

486

#

487

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

488

#

489

# Example (Comparison):

490

#

491

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

492

#

493

# Example (Equality):

494

#

495

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

500

#

501

# Example (Data Manipulation):

502

#

503

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

504

#

505

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

506

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

507

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

508

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

509

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

510

},

511

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

512

#

513

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

514

#

515

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

516

#

517

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

522

#

523

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

524

#

525

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

526

#

527

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

528

#

529

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

534

"A String",

535

],

536

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

537

},

538

],

539

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

540

#

541

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

542

"iamOwned": True or False,

543

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

544

{ # A rule to be applied in a Policy.

545

"action": "A String", # Required

546

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

547

{ # A condition to be met.

548

"iam": "A String", # Trusted attributes supplied by the IAM system.

549

"op": "A String", # An operator to apply the subject with.

550

"svc": "A String", # Trusted attributes discharged by the service.

551

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

552

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

558

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

559

"A String",

560

],

561

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

562

{ # Specifies what kind of log the caller must write

563

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

564

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

565

"permissionType": "A String", # The type of the permission that was checked.

566

},

567

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

568

},

569

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

570

#

571

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

572

#

573

# Field names correspond to IAM request parameters and field values are their respective values.

574

#

575

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

576

#

577

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

578

"customFields": [ # Custom fields.

579

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

580

"name": "A String", # Name is the field name.

581

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

582

},

583

],

584

"field": "A String", # The field value to attribute.

585

"metric": "A String", # The metric to update.

586

},

587

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

588

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

593

"A String",

594

],

595

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

601

#

602

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

603

#

604

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

605

#

606

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

607

#

608

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

609

#

610

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

611

#

612

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

617

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

618

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

619

620

Args:

621

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

Dan O'Meara

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

[diff] [blame]

622

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

623

The object takes the form of:

624

Dan O'Meara

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

[diff] [blame]

625

{ # Represents a Cloud Storage Bucket resource.

Bu Sun Kim

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

[diff] [blame]

626

#

627

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

628

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

629

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

630

"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.

631

{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.

632

"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.

633

},

634

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

635

"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:

636

#

637

# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.

638

#

639

# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.

640

#

641

# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

642

"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

643

"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

644

"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

645

"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

646

"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.

647

{ # Specify CDN TTLs for response error codes.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

648

"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

649

"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

650

},

651

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

652

"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

653

"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

Bu Sun Kim

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

[diff] [blame]

654

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

655

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

"A String",

],

},

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

660

"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.

661

"A String",

662

],

Bu Sun Kim

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

[diff] [blame]

663

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

664

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

665

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

666

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

667

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

668

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

669

}

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

670

Bu Sun Kim

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

[diff] [blame]

671

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.

672

673

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.

674

675

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

676

677

Returns:

678

An object of the form:

679

Bu Sun Kim

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

[diff] [blame]

680

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

681

#

682

# Google Compute Engine has three Operation resources:

683

#

684

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

685

#

686

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

687

#

688

# Operations can be global, regional or zonal.

689

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

690

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

691

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

692

#

693

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

694

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

695

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

696

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

697

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

698

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

699

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

Bu Sun Kim

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

[diff] [blame]

700

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

701

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

702

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

703

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

Bu Sun Kim

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

[diff] [blame]

704

},

705

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

706

},

707

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

708

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

709

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

710

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

711

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

712

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

713

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

714

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

715

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

716

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

717

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

718

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

719

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

720

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

721

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

722

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

723

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

724

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

725

{

726

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

727

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

728

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

729

{

730

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

731

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

732

},

733

],

734

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

735

},

736

],

737

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

738

}</pre>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

742

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

743

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

744

745

Args:

746

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

Dan O'Meara

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

[diff] [blame]

747

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

748

Dan O'Meara

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

[diff] [blame]

749

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

750

Dan O'Meara

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

[diff] [blame]

751

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.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

752

Bu Sun Kim

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

[diff] [blame]

753

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

754

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

755

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

756

757

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.

758

759

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

760

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

761

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

762

763

Returns:

764

An object of the form:

765

766

{ # Contains a list of BackendBucket resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

767

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

768

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

769

{ # Represents a Cloud Storage Bucket resource.

770

#

771

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

772

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

773

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

774

"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.

775

{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.

776

"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.

777

},

778

],

779

"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:

780

#

781

# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.

782

#

783

# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.

784

#

785

# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

786

"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

787

"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

788

"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

789

"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.

790

"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.

791

{ # Specify CDN TTLs for response error codes.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

792

"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

793

"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

794

},

795

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

796

"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

797

"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

798

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

799

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

800

"A String",

801

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

802

},

803

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

804

"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.

805

"A String",

806

],

807

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

808

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

809

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

810

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

811

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

812

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

813

},

814

],

815

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

816

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

817

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

818

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

819

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

820

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

821

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

822

{

823

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

824

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

Bu Sun Kim

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

[diff] [blame]

825

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

826

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

827

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

828

},

829

}</pre>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

</div>

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

834

<pre>Retrieves the next page of results.

835

836

Args:

837

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

838

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

839

840

Returns:

Bu Sun Kim

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

[diff] [blame]

841

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

842

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]

847

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

848

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

849

850

Args:

851

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

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

852

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

Dan O'Meara

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

[diff] [blame]

853

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

854

The object takes the form of:

855

Dan O'Meara

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

[diff] [blame]

856

{ # Represents a Cloud Storage Bucket resource.

Bu Sun Kim

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

[diff] [blame]

857

#

858

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

859

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

860

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

861

"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.

862

{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.

863

"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.

864

},

865

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

866

"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:

867

#

868

# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.

869

#

870

# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.

871

#

872

# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

873

"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

874

"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

875

"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

876

"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

877

"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.

878

{ # Specify CDN TTLs for response error codes.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

879

"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

880

"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

881

},

882

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

883

"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

884

"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

Bu Sun Kim

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

[diff] [blame]

885

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

886

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

"A String",

],

},

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

891

"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.

892

"A String",

893

],

Bu Sun Kim

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

[diff] [blame]

894

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

895

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

896

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

897

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

898

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

899

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

900

}

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

901

Bu Sun Kim

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

[diff] [blame]

902

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.

903

904

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.

905

906

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

907

908

Returns:

909

An object of the form:

910

Bu Sun Kim

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

[diff] [blame]

911

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

912

#

913

# Google Compute Engine has three Operation resources:

914

#

915

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

916

#

917

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

918

#

919

# Operations can be global, regional or zonal.

920

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

921

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

922

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

923

#

924

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

925

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

926

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

927

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

928

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

929

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

930

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

Bu Sun Kim

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

[diff] [blame]

931

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

932

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

933

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

934

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

Bu Sun Kim

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

[diff] [blame]

935

},

936

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

937

},

938

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

939

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

940

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

941

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

942

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

943

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

944

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

{

957

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

958

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

959

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

960

{

961

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

962

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

963

},

964

],

965

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

966

},

967

],

968

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

969

}</pre>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

973

<code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code>

974

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

975

976

Args:

977

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

978

resource: string, Name or id of the resource for this request. (required)

979

body: object, The request body.

980

The object takes the form of:

981

982

{

983

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

984

{ # Associates `members` with a `role`.

985

"bindingId": "A String",

986

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

987

#

988

# If the condition evaluates to `true`, then this binding applies to the current request.

989

#

990

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

991

#

992

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

993

#

994

# Example (Comparison):

995

#

996

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

997

#

998

# Example (Equality):

999

#

1000

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1005

#

1006

# Example (Data Manipulation):

1007

#

1008

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1009

#

1010

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1011

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1012

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1013

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1014

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1015

},

1016

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1017

#

1018

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1019

#

1020

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1021

#

1022

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1027

#

1028

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1029

#

1030

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

1031

#

1032

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

1033

#

1034

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

1039

"A String",

1040

],

1041

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1042

},

1043

],

1044

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

1045

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

1050

#

1051

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

1060

#

1061

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

1062

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1063

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

1064

#

1065

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

1066

#

1067

# Example Policy with multiple AuditConfigs:

1068

#

1069

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

1070

#

1071

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

1072

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1073

{ # Provides the configuration for logging a type of permissions. Example:

1074

#

1075

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

1076

#

1077

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1078

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1079

"A String",

1080

],

1081

"ignoreChildExemptions": True or False,

1082

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

1089

},

1090

],

1091

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

1092

{ # Associates `members` with a `role`.

1093

"bindingId": "A String",

1094

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

1095

#

1096

# If the condition evaluates to `true`, then this binding applies to the current request.

1097

#

1098

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

1099

#

1100

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1101

#

1102

# Example (Comparison):

1103

#

1104

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1105

#

1106

# Example (Equality):

1107

#

1108

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1113

#

1114

# Example (Data Manipulation):

1115

#

1116

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1117

#

1118

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1119

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1120

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1121

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1122

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1123

},

1124

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1125

#

1126

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1127

#

1128

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1129

#

1130

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1135

#

1136

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1137

#

1138

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

1139

#

1140

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

1141

#

1142

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

1147

"A String",

1148

],

1149

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1150

},

1151

],

1152

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

1153

#

1154

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1155

"iamOwned": True or False,

1156

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

1157

{ # A rule to be applied in a Policy.

1158

"action": "A String", # Required

1159

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1160

{ # A condition to be met.

1161

"iam": "A String", # Trusted attributes supplied by the IAM system.

1162

"op": "A String", # An operator to apply the subject with.

1163

"svc": "A String", # Trusted attributes discharged by the service.

1164

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1165

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1171

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

1172

"A String",

1173

],

1174

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1175

{ # Specifies what kind of log the caller must write

1176

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1177

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1178

"permissionType": "A String", # The type of the permission that was checked.

1179

},

1180

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1181

},

1182

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1183

#

1184

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

1185

#

1186

# Field names correspond to IAM request parameters and field values are their respective values.

1187

#

1188

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

1189

#

1190

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1191

"customFields": [ # Custom fields.

1192

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1193

"name": "A String", # Name is the field name.

1194

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

1195

},

1196

],

1197

"field": "A String", # The field value to attribute.

1198

"metric": "A String", # The metric to update.

1199

},

1200

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1201

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1206

"A String",

1207

],

1208

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

1214

#

1215

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1216

#

1217

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1218

#

1219

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

1220

#

1221

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1222

#

1223

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1224

#

1225

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

},

}

Returns:

An object of the form:

1232

1233

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

1238

#

1239

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

1248

#

1249

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

1250

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1251

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

1252

#

1253

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

1254

#

1255

# Example Policy with multiple AuditConfigs:

1256

#

1257

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

1258

#

1259

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

1260

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1261

{ # Provides the configuration for logging a type of permissions. Example:

1262

#

1263

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

1264

#

1265

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1266

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1267

"A String",

1268

],

1269

"ignoreChildExemptions": True or False,

1270

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

1277

},

1278

],

1279

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

1280

{ # Associates `members` with a `role`.

1281

"bindingId": "A String",

1282

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

1283

#

1284

# If the condition evaluates to `true`, then this binding applies to the current request.

1285

#

1286

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

1287

#

1288

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1289

#

1290

# Example (Comparison):

1291

#

1292

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1293

#

1294

# Example (Equality):

1295

#

1296

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1301

#

1302

# Example (Data Manipulation):

1303

#

1304

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1305

#

1306

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1307

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1308

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1309

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1310

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1311

},

1312

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1313

#

1314

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1315

#

1316

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1317

#

1318

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1323

#

1324

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1325

#

1326

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

1327

#

1328

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

1329

#

1330

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

1335

"A String",

1336

],

1337

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1338

},

1339

],

1340

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

1341

#

1342

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1343

"iamOwned": True or False,

1344

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

1345

{ # A rule to be applied in a Policy.

1346

"action": "A String", # Required

1347

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1348

{ # A condition to be met.

1349

"iam": "A String", # Trusted attributes supplied by the IAM system.

1350

"op": "A String", # An operator to apply the subject with.

1351

"svc": "A String", # Trusted attributes discharged by the service.

1352

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1353

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1359

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

1360

"A String",

1361

],

1362

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1363

{ # Specifies what kind of log the caller must write

1364

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1365

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1366

"permissionType": "A String", # The type of the permission that was checked.

1367

},

1368

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1369

},

1370

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1371

#

1372

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

1373

#

1374

# Field names correspond to IAM request parameters and field values are their respective values.

1375

#

1376

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

1377

#

1378

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1379

"customFields": [ # Custom fields.

1380

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1381

"name": "A String", # Name is the field name.

1382

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

1383

},

1384

],

1385

"field": "A String", # The field value to attribute.

1386

"metric": "A String", # The metric to update.

1387

},

1388

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1389

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1394

"A String",

1395

],

1396

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

1402

#

1403

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1404

#

1405

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1406

#

1407

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

1408

#

1409

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1410

#

1411

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1412

#

1413

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

1419

<pre>Returns permissions that a caller has on the specified resource.

1420

1421

Args:

1422

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

1423

resource: string, Name or id of the resource for this request. (required)

1424

body: object, The request body.

1425

The object takes the form of:

1426

1427

{

1428

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

"A String",

],

}

Returns:

An object of the form:

1436

1437

{

1438

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

"A String",

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1445

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1446

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

1447

1448

Args:

1449

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

1450

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

Dan O'Meara

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

[diff] [blame]

1451

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1452

The object takes the form of:

1453

Dan O'Meara

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

[diff] [blame]

1454

{ # Represents a Cloud Storage Bucket resource.

Bu Sun Kim

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

[diff] [blame]

1455

#

1456

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

1457

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

1458

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1459

"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.

1460

{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.

1461

"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.

1462

},

1463

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1464

"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:

1465

#

1466

# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.

1467

#

1468

# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.

1469

#

1470

# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1471

"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1472

"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

1473

"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1474

"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1475

"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.

1476

{ # Specify CDN TTLs for response error codes.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

1477

"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1478

"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1479

},

1480

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1481

"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1482

"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

Bu Sun Kim

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

[diff] [blame]

1483

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

1484

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

"A String",

],

},

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1489

"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.

1490

"A String",

1491

],

Bu Sun Kim

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

[diff] [blame]

1492

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

1493

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

1494

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

1495

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

1496

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

1497

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

1498

}

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1499

Bu Sun Kim

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

[diff] [blame]

1500

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.

1501

1502

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.

1503

1504

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1505

1506

Returns:

1507

An object of the form:

1508

Bu Sun Kim

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

[diff] [blame]

1509

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1510

#

1511

# Google Compute Engine has three Operation resources:

1512

#

1513

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

1514

#

1515

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

1516

#

1517

# Operations can be global, regional or zonal.

1518

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

1519

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

1520

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

1521

#

1522

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

1523

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

1524

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

1525

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

1526

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

1527

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

1528

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

Bu Sun Kim

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

[diff] [blame]

1529

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1530

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

1531

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

1532

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

Bu Sun Kim

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

[diff] [blame]

1533

},

1534

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1535

},

1536

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

1537

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

1538

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

1539

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

1540

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

1541

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1542

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot