1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="storagebatchoperations_v1.html">Storage Batch Operations API</a> . <a href="storagebatchoperations_v1.projects.html">projects</a> . <a href="storagebatchoperations_v1.projects.locations.html">locations</a> . <a href="storagebatchoperations_v1.projects.locations.jobs.html">jobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels a batch job.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, jobId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a batch job.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a batch job.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a batch job.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Jobs in a given project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
<pre>Cancels a batch job.
Args:
name: string, Required. The `name` of the job to cancel. Format: projects/{project_id}/locations/global/jobs/{job_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Message for Job to Cancel
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to cancel Job.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, jobId=None, requestId=None, x__xgafv=None)</code>
<pre>Creates a batch job.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # The Storage Batch Operations Job description.
"bucketList": { # Describes list of buckets and their objects to be transformed. # Specifies a list of buckets and their objects to be transformed.
"buckets": [ # Required. List of buckets and their objects to be transformed. Currently, only one bucket configuration is supported. If multiple buckets are specified, an error will be returned.
{ # Describes configuration of a single bucket and its objects to be transformed.
"bucket": "A String", # Required. Bucket name for the objects to be transformed.
"manifest": { # Describes list of objects to be transformed. # Specifies objects in a manifest file.
"manifestLocation": "A String", # Required. `manifest_location` must contain the manifest source file that is a CSV file in a Google Cloud Storage bucket. Each row in the file must include the object details i.e. BucketId and Name. Generation may optionally be specified. When it is not specified the live object is acted upon. `manifest_location` should either be 1) An absolute path to the object in the format of `gs://bucket_name/path/file_name.csv`. 2) An absolute path with a single wildcard character in the file name, for example `gs://bucket_name/path/file_name*.csv`. If manifest location is specified with a wildcard, objects in all manifest files matching the pattern will be acted upon.
},
"prefixList": { # Describes prefixes of objects to be transformed. # Specifies objects matching a prefix set.
"includedObjectPrefixes": [ # Optional. Include prefixes of the objects to be transformed. * Supports full object name * Supports prefix of the object name * Wildcards are not supported * Supports empty string for all objects in a bucket.
"A String",
],
},
},
],
},
"completeTime": "A String", # Output only. The time that the job was completed.
"counters": { # Describes details about the progress of the job. # Output only. Information about the progress of the job.
"failedObjectCount": "A String", # Output only. Number of objects failed.
"succeededObjectCount": "A String", # Output only. Number of objects completed.
"totalObjectCount": "A String", # Output only. Number of objects listed.
},
"createTime": "A String", # Output only. The time that the job was created.
"deleteObject": { # Describes options to delete an object. # Delete objects.
"permanentObjectDeletionEnabled": True or False, # Required. Controls deletion behavior when versioning is enabled for the object's bucket. If true both live and noncurrent objects will be permanently deleted. Otherwise live objects in versioned buckets will become noncurrent and objects that were already noncurrent will be skipped. This setting doesn't have any impact on the Soft Delete feature. All objects deleted by this service can be be restored for the duration of the Soft Delete retention duration if enabled. If enabled and the manifest doesn't specify an object's generation, a GetObjectMetadata call (a Class B operation) will be made to determine the live object generation.
},
"description": "A String", # Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
"errorSummaries": [ # Output only. Summarizes errors encountered with sample error log entries.
{ # A summary of errors by error code, plus a count and sample error log entries.
"errorCode": "A String", # Required. The canonical error code.
"errorCount": "A String", # Required. Number of errors encountered per `error_code`.
"errorLogEntries": [ # Required. Sample error logs.
{ # An entry describing an error that has occurred.
"errorDetails": [ # Optional. Output only. At most 5 error log entries are recorded for a given error code for a job.
"A String",
],
"objectUri": "A String", # Required. Output only. Object URL. e.g. gs://my_bucket/object.txt
},
],
},
],
"loggingConfig": { # Specifies the Cloud Logging behavior. # Optional. Logging configuration.
"logActionStates": [ # Required. States in which Action are logged.If empty, no logs are generated.
"A String",
],
"logActions": [ # Required. Specifies the actions to be logged.
"A String",
],
},
"name": "A String", # Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".
"putMetadata": { # Describes options for object metadata update. # Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.
"cacheControl": "A String", # Optional. Updates objects Cache-Control fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Additionally, the value for Custom-Time cannot decrease. Refer to documentation in https://cloud.google.com/storage/docs/metadata#caching_data.
"contentDisposition": "A String", # Optional. Updates objects Content-Disposition fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer https://cloud.google.com/storage/docs/metadata#content-disposition for additional documentation.
"contentEncoding": "A String", # Optional. Updates objects Content-Encoding fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-encoding.
"contentLanguage": "A String", # Optional. Updates objects Content-Language fixed metadata. Refer to ISO 639-1 language codes for typical values of this metadata. Max length 100 characters. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-language.
"contentType": "A String", # Optional. Updates objects Content-Type fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-type
"customMetadata": { # Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata
"a_key": "A String",
},
"customTime": "A String", # Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time.
},
"putObjectHold": { # Describes options to update object hold. # Changes object hold status.
"eventBasedHold": "A String", # Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period.
"temporaryHold": "A String", # Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.
},
"rewriteObject": { # Describes options for object rewrite. # Rewrite the object and updates metadata like KMS key.
"kmsKey": "A String", # Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key". The object will be rewritten and set with the specified KMS key.
},
"scheduleTime": "A String", # Output only. The time that the job was scheduled.
"state": "A String", # Output only. State of the job.
}
jobId: string, Required. The optional `job_id` for this Job . If not specified, an id is generated. `job_id` should be no more than 128 characters and must include only characters available in DNS names, as defined by RFC-1123.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
<pre>Deletes a batch job.
Args:
name: string, Required. The `name` of the job to delete. Format: projects/{project_id}/locations/global/jobs/{job_id} . (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a batch job.
Args:
name: string, Required. `name` of the job to retrieve. Format: projects/{project_id}/locations/global/jobs/{job_id} . (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Storage Batch Operations Job description.
"bucketList": { # Describes list of buckets and their objects to be transformed. # Specifies a list of buckets and their objects to be transformed.
"buckets": [ # Required. List of buckets and their objects to be transformed. Currently, only one bucket configuration is supported. If multiple buckets are specified, an error will be returned.
{ # Describes configuration of a single bucket and its objects to be transformed.
"bucket": "A String", # Required. Bucket name for the objects to be transformed.
"manifest": { # Describes list of objects to be transformed. # Specifies objects in a manifest file.
"manifestLocation": "A String", # Required. `manifest_location` must contain the manifest source file that is a CSV file in a Google Cloud Storage bucket. Each row in the file must include the object details i.e. BucketId and Name. Generation may optionally be specified. When it is not specified the live object is acted upon. `manifest_location` should either be 1) An absolute path to the object in the format of `gs://bucket_name/path/file_name.csv`. 2) An absolute path with a single wildcard character in the file name, for example `gs://bucket_name/path/file_name*.csv`. If manifest location is specified with a wildcard, objects in all manifest files matching the pattern will be acted upon.
},
"prefixList": { # Describes prefixes of objects to be transformed. # Specifies objects matching a prefix set.
"includedObjectPrefixes": [ # Optional. Include prefixes of the objects to be transformed. * Supports full object name * Supports prefix of the object name * Wildcards are not supported * Supports empty string for all objects in a bucket.
"A String",
],
},
},
],
},
"completeTime": "A String", # Output only. The time that the job was completed.
"counters": { # Describes details about the progress of the job. # Output only. Information about the progress of the job.
"failedObjectCount": "A String", # Output only. Number of objects failed.
"succeededObjectCount": "A String", # Output only. Number of objects completed.
"totalObjectCount": "A String", # Output only. Number of objects listed.
},
"createTime": "A String", # Output only. The time that the job was created.
"deleteObject": { # Describes options to delete an object. # Delete objects.
"permanentObjectDeletionEnabled": True or False, # Required. Controls deletion behavior when versioning is enabled for the object's bucket. If true both live and noncurrent objects will be permanently deleted. Otherwise live objects in versioned buckets will become noncurrent and objects that were already noncurrent will be skipped. This setting doesn't have any impact on the Soft Delete feature. All objects deleted by this service can be be restored for the duration of the Soft Delete retention duration if enabled. If enabled and the manifest doesn't specify an object's generation, a GetObjectMetadata call (a Class B operation) will be made to determine the live object generation.
},
"description": "A String", # Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
"errorSummaries": [ # Output only. Summarizes errors encountered with sample error log entries.
{ # A summary of errors by error code, plus a count and sample error log entries.
"errorCode": "A String", # Required. The canonical error code.
"errorCount": "A String", # Required. Number of errors encountered per `error_code`.
"errorLogEntries": [ # Required. Sample error logs.
{ # An entry describing an error that has occurred.
"errorDetails": [ # Optional. Output only. At most 5 error log entries are recorded for a given error code for a job.
"A String",
],
"objectUri": "A String", # Required. Output only. Object URL. e.g. gs://my_bucket/object.txt
},
],
},
],
"loggingConfig": { # Specifies the Cloud Logging behavior. # Optional. Logging configuration.
"logActionStates": [ # Required. States in which Action are logged.If empty, no logs are generated.
"A String",
],
"logActions": [ # Required. Specifies the actions to be logged.
"A String",
],
},
"name": "A String", # Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".
"putMetadata": { # Describes options for object metadata update. # Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.
"cacheControl": "A String", # Optional. Updates objects Cache-Control fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Additionally, the value for Custom-Time cannot decrease. Refer to documentation in https://cloud.google.com/storage/docs/metadata#caching_data.
"contentDisposition": "A String", # Optional. Updates objects Content-Disposition fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer https://cloud.google.com/storage/docs/metadata#content-disposition for additional documentation.
"contentEncoding": "A String", # Optional. Updates objects Content-Encoding fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-encoding.
"contentLanguage": "A String", # Optional. Updates objects Content-Language fixed metadata. Refer to ISO 639-1 language codes for typical values of this metadata. Max length 100 characters. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-language.
"contentType": "A String", # Optional. Updates objects Content-Type fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-type
"customMetadata": { # Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata
"a_key": "A String",
},
"customTime": "A String", # Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time.
},
"putObjectHold": { # Describes options to update object hold. # Changes object hold status.
"eventBasedHold": "A String", # Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period.
"temporaryHold": "A String", # Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.
},
"rewriteObject": { # Describes options for object rewrite. # Rewrite the object and updates metadata like KMS key.
"kmsKey": "A String", # Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key". The object will be rewritten and set with the specified KMS key.
},
"scheduleTime": "A String", # Output only. The time that the job was scheduled.
"state": "A String", # Output only. State of the job.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Jobs in a given project.
Args:
parent: string, Required. Format: projects/{project_id}/locations/global. (required)
filter: string, Optional. Filters results as defined by https://google.aip.dev/160.
orderBy: string, Optional. Field to sort by. Supported fields are name, create_time.
pageSize: integer, Optional. The list page size. default page size is 100.
pageToken: string, Optional. The list page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Jobs
"jobs": [ # A list of storage batch jobs.
{ # The Storage Batch Operations Job description.
"bucketList": { # Describes list of buckets and their objects to be transformed. # Specifies a list of buckets and their objects to be transformed.
"buckets": [ # Required. List of buckets and their objects to be transformed. Currently, only one bucket configuration is supported. If multiple buckets are specified, an error will be returned.
{ # Describes configuration of a single bucket and its objects to be transformed.
"bucket": "A String", # Required. Bucket name for the objects to be transformed.
"manifest": { # Describes list of objects to be transformed. # Specifies objects in a manifest file.
"manifestLocation": "A String", # Required. `manifest_location` must contain the manifest source file that is a CSV file in a Google Cloud Storage bucket. Each row in the file must include the object details i.e. BucketId and Name. Generation may optionally be specified. When it is not specified the live object is acted upon. `manifest_location` should either be 1) An absolute path to the object in the format of `gs://bucket_name/path/file_name.csv`. 2) An absolute path with a single wildcard character in the file name, for example `gs://bucket_name/path/file_name*.csv`. If manifest location is specified with a wildcard, objects in all manifest files matching the pattern will be acted upon.
},
"prefixList": { # Describes prefixes of objects to be transformed. # Specifies objects matching a prefix set.
"includedObjectPrefixes": [ # Optional. Include prefixes of the objects to be transformed. * Supports full object name * Supports prefix of the object name * Wildcards are not supported * Supports empty string for all objects in a bucket.
"A String",
],
},
},
],
},
"completeTime": "A String", # Output only. The time that the job was completed.
"counters": { # Describes details about the progress of the job. # Output only. Information about the progress of the job.
"failedObjectCount": "A String", # Output only. Number of objects failed.
"succeededObjectCount": "A String", # Output only. Number of objects completed.
"totalObjectCount": "A String", # Output only. Number of objects listed.
},
"createTime": "A String", # Output only. The time that the job was created.
"deleteObject": { # Describes options to delete an object. # Delete objects.
"permanentObjectDeletionEnabled": True or False, # Required. Controls deletion behavior when versioning is enabled for the object's bucket. If true both live and noncurrent objects will be permanently deleted. Otherwise live objects in versioned buckets will become noncurrent and objects that were already noncurrent will be skipped. This setting doesn't have any impact on the Soft Delete feature. All objects deleted by this service can be be restored for the duration of the Soft Delete retention duration if enabled. If enabled and the manifest doesn't specify an object's generation, a GetObjectMetadata call (a Class B operation) will be made to determine the live object generation.
},
"description": "A String", # Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
"errorSummaries": [ # Output only. Summarizes errors encountered with sample error log entries.
{ # A summary of errors by error code, plus a count and sample error log entries.
"errorCode": "A String", # Required. The canonical error code.
"errorCount": "A String", # Required. Number of errors encountered per `error_code`.
"errorLogEntries": [ # Required. Sample error logs.
{ # An entry describing an error that has occurred.
"errorDetails": [ # Optional. Output only. At most 5 error log entries are recorded for a given error code for a job.
"A String",
],
"objectUri": "A String", # Required. Output only. Object URL. e.g. gs://my_bucket/object.txt
},
],
},
],
"loggingConfig": { # Specifies the Cloud Logging behavior. # Optional. Logging configuration.
"logActionStates": [ # Required. States in which Action are logged.If empty, no logs are generated.
"A String",
],
"logActions": [ # Required. Specifies the actions to be logged.
"A String",
],
},
"name": "A String", # Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".
"putMetadata": { # Describes options for object metadata update. # Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.
"cacheControl": "A String", # Optional. Updates objects Cache-Control fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Additionally, the value for Custom-Time cannot decrease. Refer to documentation in https://cloud.google.com/storage/docs/metadata#caching_data.
"contentDisposition": "A String", # Optional. Updates objects Content-Disposition fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer https://cloud.google.com/storage/docs/metadata#content-disposition for additional documentation.
"contentEncoding": "A String", # Optional. Updates objects Content-Encoding fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-encoding.
"contentLanguage": "A String", # Optional. Updates objects Content-Language fixed metadata. Refer to ISO 639-1 language codes for typical values of this metadata. Max length 100 characters. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-language.
"contentType": "A String", # Optional. Updates objects Content-Type fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#content-type
"customMetadata": { # Optional. Updates objects custom metadata. Adds or sets individual custom metadata key value pairs on objects. Keys that are set with empty custom metadata values will have its value cleared. Existing custom metadata not specified with this flag is not changed. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-metadata
"a_key": "A String",
},
"customTime": "A String", # Optional. Updates objects Custom-Time fixed metadata. Unset values will be ignored. Set empty values to clear the metadata. Refer to documentation in https://cloud.google.com/storage/docs/metadata#custom-time.
},
"putObjectHold": { # Describes options to update object hold. # Changes object hold status.
"eventBasedHold": "A String", # Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period.
"temporaryHold": "A String", # Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.
},
"rewriteObject": { # Describes options for object rewrite. # Rewrite the object and updates metadata like KMS key.
"kmsKey": "A String", # Required. Resource name of the Cloud KMS key that will be used to encrypt the object. The Cloud KMS key must be located in same location as the object. Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for additional documentation. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key} For example: "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key". The object will be rewritten and set with the specified KMS key.
},
"scheduleTime": "A String", # Output only. The time that the job was scheduled.
"state": "A String", # Output only. State of the job.
},
],
"nextPageToken": "A String", # A token identifying a page of results.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
