Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / compute_beta.backendBuckets.html
blob: 17be672c2b379cff0897a2ec255aa78ce4fef406 [file] [log] [blame]
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.backendBuckets.html">backendBuckets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]78 <code><a href="#addSignedUrlKey">addSignedUrlKey(project, backendBucket, body, requestId=None)</a></code></p>
79<p class="firstline">Adds a key for validating requests with signed URLs for this backend bucket.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(project, backendBucket, requestId=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]82<p class="firstline">Deletes the specified BackendBucket resource.</p>
83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]84 <code><a href="#deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None)</a></code></p>
85<p class="firstline">Deletes a key for validating requests with signed URLs for this backend bucket.</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]87 <code><a href="#get">get(project, backendBucket)</a></code></p>
88<p class="firstline">Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.</p>
89<p class="toc_element">
90 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]91<p class="firstline">Creates a BackendBucket resource in the specified project using the data included in the request.</p>
92<p class="toc_element">
93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of BackendBucket resources available to the specified project.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]99 <code><a href="#patch">patch(project, backendBucket, body, requestId=None)</a></code></p>
100<p class="firstline">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.</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]101<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]102 <code><a href="#update">update(project, backendBucket, body, requestId=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]103<p class="firstline">Updates the specified BackendBucket resource with the data included in the request.</p>
104<h3>Method Details</h3>
105<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]106 <code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendBucket, body, requestId=None)</code>
107 <pre>Adds a key for validating requests with signed URLs for this backend bucket.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]108
109Args:
110 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]111 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)
112 body: object, The request body. (required)
113 The object takes the form of:
114
115{ # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs
116 "keyName": "A String", # Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
117 "keyValue": "A String", # 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.
118 }
119
120 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
121
122For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
123
124The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]125
126Returns:
127 An object of the form:
128
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]129 { # Represents an Operation resource.
130 #
131 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
132 #
133 # Operations can be global, regional or zonal.
134 # - For global operations, use the globalOperations resource.
135 # - For regional operations, use the regionOperations resource.
136 # - For zonal operations, use the zonalOperations resource.
137 #
138 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]139 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]140 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]141 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]142 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]143 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]144 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
145 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
146 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
147 "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.
148 "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.
149 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
150 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
151 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
152 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
153 {
154 "message": "A String", # [Output Only] A human-readable description of the warning code.
155 "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.
156 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
157 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
158 {
159 "value": "A String", # [Output Only] A warning data value corresponding to the key.
160 "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).
161 },
162 ],
163 },
164 ],
165 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
166 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
167 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
168 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]169 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
170 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
171 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
172 {
173 "message": "A String", # [Output Only] An optional, human-readable error message.
174 "code": "A String", # [Output Only] The error type identifier for this error.
175 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
176 },
177 ],
178 },
179 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
180 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
181 "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.
182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="delete">delete(project, backendBucket, requestId=None)</code>
187 <pre>Deletes the specified BackendBucket resource.
188
189Args:
190 project: string, Project ID for this request. (required)
191 backendBucket: string, Name of the BackendBucket resource to delete. (required)
192 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.
193
194For 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.
195
196The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
197
198Returns:
199 An object of the form:
200
201 { # Represents an Operation resource.
202 #
203 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
204 #
205 # Operations can be global, regional or zonal.
206 # - For global operations, use the globalOperations resource.
207 # - For regional operations, use the regionOperations resource.
208 # - For zonal operations, use the zonalOperations resource.
209 #
210 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
211 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
212 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
213 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
214 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
215 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
216 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
217 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
218 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
219 "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.
220 "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.
221 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
222 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
223 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
224 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
225 {
226 "message": "A String", # [Output Only] A human-readable description of the warning code.
227 "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.
228 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
229 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
230 {
231 "value": "A String", # [Output Only] A warning data value corresponding to the key.
232 "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).
233 },
234 ],
235 },
236 ],
237 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
238 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
239 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
240 "name": "A String", # [Output Only] Name of the resource.
241 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
242 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
243 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
244 {
245 "message": "A String", # [Output Only] An optional, human-readable error message.
246 "code": "A String", # [Output Only] The error type identifier for this error.
247 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
248 },
249 ],
250 },
251 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
252 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
253 "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.
254 }</pre>
255</div>
256
257<div class="method">
258 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None)</code>
259 <pre>Deletes a key for validating requests with signed URLs for this backend bucket.
260
261Args:
262 project: string, Project ID for this request. (required)
263 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)
264 keyName: string, The name of the Signed URL Key to delete. (required)
265 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.
266
267For 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.
268
269The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
270
271Returns:
272 An object of the form:
273
274 { # Represents an Operation resource.
275 #
276 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
277 #
278 # Operations can be global, regional or zonal.
279 # - For global operations, use the globalOperations resource.
280 # - For regional operations, use the regionOperations resource.
281 # - For zonal operations, use the zonalOperations resource.
282 #
283 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
284 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
285 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
286 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
287 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
288 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
289 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
290 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
291 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
292 "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.
293 "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.
294 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
295 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
296 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
297 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
298 {
299 "message": "A String", # [Output Only] A human-readable description of the warning code.
300 "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.
301 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
302 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
303 {
304 "value": "A String", # [Output Only] A warning data value corresponding to the key.
305 "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).
306 },
307 ],
308 },
309 ],
310 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
311 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
312 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
313 "name": "A String", # [Output Only] Name of the resource.
314 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]315 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
316 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
317 {
318 "message": "A String", # [Output Only] An optional, human-readable error message.
319 "code": "A String", # [Output Only] The error type identifier for this error.
320 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
321 },
322 ],
323 },
324 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
325 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
326 "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.
327 }</pre>
328</div>
329
330<div class="method">
331 <code class="details" id="get">get(project, backendBucket)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]332 <pre>Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]333
334Args:
335 project: string, Project ID for this request. (required)
336 backendBucket: string, Name of the BackendBucket resource to return. (required)
337
338Returns:
339 An object of the form:
340
341 { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
342 "kind": "compute#backendBucket", # Type of the resource.
343 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]344 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
345 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
346 "A String",
347 ],
348 "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.
349 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]350 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
351 "bucketName": "A String", # Cloud Storage bucket name.
352 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
353 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
354 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]355 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]356 }</pre>
357</div>
358
359<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]360 <code class="details" id="insert">insert(project, body, requestId=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]361 <pre>Creates a BackendBucket resource in the specified project using the data included in the request.
362
363Args:
364 project: string, Project ID for this request. (required)
365 body: object, The request body. (required)
366 The object takes the form of:
367
368{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
369 "kind": "compute#backendBucket", # Type of the resource.
370 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]371 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
372 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
373 "A String",
374 ],
375 "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.
376 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]377 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
378 "bucketName": "A String", # Cloud Storage bucket name.
379 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
380 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
381 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]382 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]383 }
384
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]385 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.
386
387For 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.
388
389The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]390
391Returns:
392 An object of the form:
393
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]394 { # Represents an Operation resource.
395 #
396 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
397 #
398 # Operations can be global, regional or zonal.
399 # - For global operations, use the globalOperations resource.
400 # - For regional operations, use the regionOperations resource.
401 # - For zonal operations, use the zonalOperations resource.
402 #
403 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]404 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]405 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]406 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]407 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]408 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]409 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
410 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
411 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
412 "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.
413 "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.
414 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
415 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
416 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
417 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
418 {
419 "message": "A String", # [Output Only] A human-readable description of the warning code.
420 "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.
421 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
422 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
423 {
424 "value": "A String", # [Output Only] A warning data value corresponding to the key.
425 "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).
426 },
427 ],
428 },
429 ],
430 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
431 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
432 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
433 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]434 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]435 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
436 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
437 {
438 "message": "A String", # [Output Only] An optional, human-readable error message.
439 "code": "A String", # [Output Only] The error type identifier for this error.
440 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
441 },
442 ],
443 },
444 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
445 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
446 "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.
447 }</pre>
448</div>
449
450<div class="method">
451 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
452 <pre>Retrieves the list of BackendBucket resources available to the specified project.
453
454Args:
455 project: string, Project ID for this request. (required)
456 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
457
458You 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.
459
460Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]461 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)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]462 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]463 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 Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]464
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]465For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]466
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]467You 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 Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]468
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]469To 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).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]470
471Returns:
472 An object of the form:
473
474 { # Contains a list of BackendBucket resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]475 "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.
476 "kind": "compute#backendBucketList", # Type of resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]477 "items": [ # A list of BackendBucket resources.
478 { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
479 "kind": "compute#backendBucket", # Type of the resource.
480 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]481 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
482 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
483 "A String",
484 ],
485 "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.
486 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]487 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
488 "bucketName": "A String", # Cloud Storage bucket name.
489 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
490 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
491 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]492 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]493 },
494 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]495 "warning": { # [Output Only] Informational warning message.
496 "message": "A String", # [Output Only] A human-readable description of the warning code.
497 "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.
498 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
499 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
500 {
501 "value": "A String", # [Output Only] A warning data value corresponding to the key.
502 "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).
503 },
504 ],
505 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]506 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
507 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
508 }</pre>
509</div>
510
511<div class="method">
512 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
513 <pre>Retrieves the next page of results.
514
515Args:
516 previous_request: The request for the previous page. (required)
517 previous_response: The response from the request for the previous page. (required)
518
519Returns:
520 A request object that you can call 'execute()' on to request the next
521 page. Returns None if there are no more items in the collection.
522 </pre>
523</div>
524
525<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]526 <code class="details" id="patch">patch(project, backendBucket, body, requestId=None)</code>
527 <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 Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]528
529Args:
530 project: string, Project ID for this request. (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]531 backendBucket: string, Name of the BackendBucket resource to patch. (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]532 body: object, The request body. (required)
533 The object takes the form of:
534
535{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
536 "kind": "compute#backendBucket", # Type of the resource.
537 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]538 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
539 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
540 "A String",
541 ],
542 "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.
543 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]544 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
545 "bucketName": "A String", # Cloud Storage bucket name.
546 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
547 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
548 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]549 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]550 }
551
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]552 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.
553
554For 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.
555
556The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]557
558Returns:
559 An object of the form:
560
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]561 { # Represents an Operation resource.
562 #
563 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
564 #
565 # Operations can be global, regional or zonal.
566 # - For global operations, use the globalOperations resource.
567 # - For regional operations, use the regionOperations resource.
568 # - For zonal operations, use the zonalOperations resource.
569 #
570 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]571 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]572 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]573 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]574 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]575 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]576 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
577 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
578 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
579 "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.
580 "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.
581 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
582 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
583 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
584 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
585 {
586 "message": "A String", # [Output Only] A human-readable description of the warning code.
587 "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.
588 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
589 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
590 {
591 "value": "A String", # [Output Only] A warning data value corresponding to the key.
592 "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).
593 },
594 ],
595 },
596 ],
597 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
598 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
599 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
600 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]601 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]602 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
603 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
604 {
605 "message": "A String", # [Output Only] An optional, human-readable error message.
606 "code": "A String", # [Output Only] The error type identifier for this error.
607 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
608 },
609 ],
610 },
611 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
612 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
613 "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.
614 }</pre>
615</div>
616
617<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]618 <code class="details" id="update">update(project, backendBucket, body, requestId=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]619 <pre>Updates the specified BackendBucket resource with the data included in the request.
620
621Args:
622 project: string, Project ID for this request. (required)
623 backendBucket: string, Name of the BackendBucket resource to update. (required)
624 body: object, The request body. (required)
625 The object takes the form of:
626
627{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
628 "kind": "compute#backendBucket", # Type of the resource.
629 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]630 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
631 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
632 "A String",
633 ],
634 "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.
635 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]636 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
637 "bucketName": "A String", # Cloud Storage bucket name.
638 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
639 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
640 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]641 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]642 }
643
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]644 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.
645
646For 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.
647
648The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]649
650Returns:
651 An object of the form:
652
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]653 { # Represents an Operation resource.
654 #
655 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
656 #
657 # Operations can be global, regional or zonal.
658 # - For global operations, use the globalOperations resource.
659 # - For regional operations, use the regionOperations resource.
660 # - For zonal operations, use the zonalOperations resource.
661 #
662 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]663 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]664 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]665 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]666 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]667 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]668 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
669 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
670 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
671 "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.
672 "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.
673 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
674 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
675 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
676 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
677 {
678 "message": "A String", # [Output Only] A human-readable description of the warning code.
679 "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.
680 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
681 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
682 {
683 "value": "A String", # [Output Only] A warning data value corresponding to the key.
684 "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).
685 },
686 ],
687 },
688 ],
689 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
690 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
691 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
692 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]693 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]694 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
695 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
696 {
697 "message": "A String", # [Output Only] An optional, human-readable error message.
698 "code": "A String", # [Output Only] The error type identifier for this error.
699 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
700 },
701 ],
702 },
703 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
704 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
705 "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.
706 }</pre>
707</div>
708
709</body></html>