@googleapis/storagebatchoperations 8.2.0 → 9.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +256 -58
- package/build/v1.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +263 -76
package/v1.ts
CHANGED
|
@@ -124,6 +124,19 @@ export namespace storagebatchoperations_v1 {
|
|
|
124
124
|
}
|
|
125
125
|
}
|
|
126
126
|
|
|
127
|
+
/**
|
|
128
|
+
* Represents updates to existing access-control entries on an object.
|
|
129
|
+
*/
|
|
130
|
+
export interface Schema$AccessControlsUpdates {
|
|
131
|
+
/**
|
|
132
|
+
* Optional. Grants to add or update. If a grant for same entity exists, its role is updated.
|
|
133
|
+
*/
|
|
134
|
+
grants?: Schema$ObjectAccessControl[];
|
|
135
|
+
/**
|
|
136
|
+
* Optional. Entities for which all grants should be removed. An entity can't be in both `grants` and `remove_entities`.
|
|
137
|
+
*/
|
|
138
|
+
removeEntities?: string[] | null;
|
|
139
|
+
}
|
|
127
140
|
/**
|
|
128
141
|
* Describes configuration of a single bucket and its objects to be transformed.
|
|
129
142
|
*/
|
|
@@ -146,7 +159,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
146
159
|
*/
|
|
147
160
|
export interface Schema$BucketList {
|
|
148
161
|
/**
|
|
149
|
-
* Required. List of buckets and their objects to be transformed.
|
|
162
|
+
* Required. List of buckets and their objects to be transformed. You can specify only one bucket per job. If multiple buckets are specified, an error occurs.
|
|
150
163
|
*/
|
|
151
164
|
buckets?: Schema$Bucket[];
|
|
152
165
|
}
|
|
@@ -183,13 +196,17 @@ export namespace storagebatchoperations_v1 {
|
|
|
183
196
|
*/
|
|
184
197
|
manifest?: Schema$Manifest;
|
|
185
198
|
/**
|
|
186
|
-
* Identifier. The resource name of the BucketOperation. This is defined by the service. Format: projects/{
|
|
199
|
+
* Identifier. The resource name of the BucketOperation. This is defined by the service. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation\}`.
|
|
187
200
|
*/
|
|
188
201
|
name?: string | null;
|
|
189
202
|
/**
|
|
190
203
|
* Specifies objects matching a prefix set.
|
|
191
204
|
*/
|
|
192
205
|
prefixList?: Schema$PrefixList;
|
|
206
|
+
/**
|
|
207
|
+
* Specifies objects matching the object filters in a project source.
|
|
208
|
+
*/
|
|
209
|
+
projectSource?: Schema$ProjectSource;
|
|
193
210
|
/**
|
|
194
211
|
* 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.
|
|
195
212
|
*/
|
|
@@ -202,6 +219,10 @@ export namespace storagebatchoperations_v1 {
|
|
|
202
219
|
* Rewrite the object and updates metadata like KMS key.
|
|
203
220
|
*/
|
|
204
221
|
rewriteObject?: Schema$RewriteObject;
|
|
222
|
+
/**
|
|
223
|
+
* Updates object ACLs.
|
|
224
|
+
*/
|
|
225
|
+
setObjectAcls?: Schema$SetObjectAcls;
|
|
205
226
|
/**
|
|
206
227
|
* Output only. The time that the BucketOperation was started.
|
|
207
228
|
*/
|
|
@@ -210,13 +231,17 @@ export namespace storagebatchoperations_v1 {
|
|
|
210
231
|
* Output only. State of the BucketOperation.
|
|
211
232
|
*/
|
|
212
233
|
state?: string | null;
|
|
234
|
+
/**
|
|
235
|
+
* Update object custom context.
|
|
236
|
+
*/
|
|
237
|
+
updateObjectCustomContext?: Schema$UpdateObjectCustomContext;
|
|
213
238
|
}
|
|
214
239
|
/**
|
|
215
240
|
* Message for Job to Cancel
|
|
216
241
|
*/
|
|
217
242
|
export interface Schema$CancelJobRequest {
|
|
218
243
|
/**
|
|
219
|
-
* 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`
|
|
244
|
+
* 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` are ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID isn't supported (00000000-0000-0000-0000-000000000000).
|
|
220
245
|
*/
|
|
221
246
|
requestId?: string | null;
|
|
222
247
|
}
|
|
@@ -233,9 +258,21 @@ export namespace storagebatchoperations_v1 {
|
|
|
233
258
|
*/
|
|
234
259
|
export interface Schema$Counters {
|
|
235
260
|
/**
|
|
236
|
-
* Output only.
|
|
261
|
+
* Output only. The number of objects that failed due to user errors or service errors.
|
|
237
262
|
*/
|
|
238
263
|
failedObjectCount?: string | null;
|
|
264
|
+
/**
|
|
265
|
+
* Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation.
|
|
266
|
+
*/
|
|
267
|
+
objectCustomContextsCreated?: string | null;
|
|
268
|
+
/**
|
|
269
|
+
* Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation.
|
|
270
|
+
*/
|
|
271
|
+
objectCustomContextsDeleted?: string | null;
|
|
272
|
+
/**
|
|
273
|
+
* Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation.
|
|
274
|
+
*/
|
|
275
|
+
objectCustomContextsUpdated?: string | null;
|
|
239
276
|
/**
|
|
240
277
|
* Output only. Number of objects completed.
|
|
241
278
|
*/
|
|
@@ -244,17 +281,34 @@ export namespace storagebatchoperations_v1 {
|
|
|
244
281
|
* Output only. Number of bytes found from source. This field is only populated for jobs with a prefix list object configuration.
|
|
245
282
|
*/
|
|
246
283
|
totalBytesFound?: string | null;
|
|
284
|
+
/**
|
|
285
|
+
* Output only. The total number of bytes affected by the transformation. For example, this counts bytes deleted for `DeleteObject` operations and bytes rewritten for `RewriteObject` operations.
|
|
286
|
+
*/
|
|
287
|
+
totalBytesTransformed?: string | null;
|
|
247
288
|
/**
|
|
248
289
|
* Output only. Number of objects listed.
|
|
249
290
|
*/
|
|
250
291
|
totalObjectCount?: string | null;
|
|
251
292
|
}
|
|
293
|
+
/**
|
|
294
|
+
* Describes a collection of updates to apply to custom contexts identified by key.
|
|
295
|
+
*/
|
|
296
|
+
export interface Schema$CustomContextUpdates {
|
|
297
|
+
/**
|
|
298
|
+
* Optional. Custom contexts to clear by key. A key can't be present in both `updates` and `keys_to_clear`.
|
|
299
|
+
*/
|
|
300
|
+
keysToClear?: string[] | null;
|
|
301
|
+
/**
|
|
302
|
+
* Optional. Insert or update the existing custom contexts.
|
|
303
|
+
*/
|
|
304
|
+
updates?: {[key: string]: Schema$ObjectCustomContextPayload} | null;
|
|
305
|
+
}
|
|
252
306
|
/**
|
|
253
307
|
* Describes options to delete an object.
|
|
254
308
|
*/
|
|
255
309
|
export interface Schema$DeleteObject {
|
|
256
310
|
/**
|
|
257
|
-
* 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
|
|
311
|
+
* 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 is made to determine the live object generation.
|
|
258
312
|
*/
|
|
259
313
|
permanentObjectDeletionEnabled?: boolean | null;
|
|
260
314
|
}
|
|
@@ -293,7 +347,28 @@ export namespace storagebatchoperations_v1 {
|
|
|
293
347
|
errorLogEntries?: Schema$ErrorLogEntry[];
|
|
294
348
|
}
|
|
295
349
|
/**
|
|
296
|
-
* The
|
|
350
|
+
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
|
|
351
|
+
*/
|
|
352
|
+
export interface Schema$Expr {
|
|
353
|
+
/**
|
|
354
|
+
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
|
|
355
|
+
*/
|
|
356
|
+
description?: string | null;
|
|
357
|
+
/**
|
|
358
|
+
* Textual representation of an expression in Common Expression Language syntax.
|
|
359
|
+
*/
|
|
360
|
+
expression?: string | null;
|
|
361
|
+
/**
|
|
362
|
+
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
|
|
363
|
+
*/
|
|
364
|
+
location?: string | null;
|
|
365
|
+
/**
|
|
366
|
+
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
|
|
367
|
+
*/
|
|
368
|
+
title?: string | null;
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* The storage batch operations job description.
|
|
297
372
|
*/
|
|
298
373
|
export interface Schema$Job {
|
|
299
374
|
/**
|
|
@@ -317,27 +392,35 @@ export namespace storagebatchoperations_v1 {
|
|
|
317
392
|
*/
|
|
318
393
|
deleteObject?: Schema$DeleteObject;
|
|
319
394
|
/**
|
|
320
|
-
* Optional. A
|
|
395
|
+
* Optional. A user-provided description for the job. Maximum length: 1024 bytes when unicode-encoded.
|
|
321
396
|
*/
|
|
322
397
|
description?: string | null;
|
|
323
398
|
/**
|
|
324
|
-
* Optional. If true, the job
|
|
399
|
+
* Optional. If true, the job runs in dry run mode, returning the total object count and, if the object configuration is a prefix list, the bytes found from source. No transformations are performed.
|
|
325
400
|
*/
|
|
326
401
|
dryRun?: boolean | null;
|
|
327
402
|
/**
|
|
328
403
|
* Output only. Summarizes errors encountered with sample error log entries.
|
|
329
404
|
*/
|
|
330
405
|
errorSummaries?: Schema$ErrorSummary[];
|
|
406
|
+
/**
|
|
407
|
+
* Output only. If true, this job operates on multiple buckets. Multi-bucket jobs are subject to different quota limits than single-bucket jobs.
|
|
408
|
+
*/
|
|
409
|
+
isMultiBucketJob?: boolean | null;
|
|
331
410
|
/**
|
|
332
411
|
* Optional. Logging configuration.
|
|
333
412
|
*/
|
|
334
413
|
loggingConfig?: Schema$LoggingConfig;
|
|
335
414
|
/**
|
|
336
|
-
* Identifier. The resource name of the
|
|
415
|
+
* Identifier. The resource name of the job. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`. For example: `projects/123456/locations/global/jobs/job01`. `job_id` is unique in a given project.
|
|
337
416
|
*/
|
|
338
417
|
name?: string | null;
|
|
339
418
|
/**
|
|
340
|
-
*
|
|
419
|
+
* Specifies a project source and filters to identify objects to be transformed.
|
|
420
|
+
*/
|
|
421
|
+
projectSource?: Schema$ProjectSource;
|
|
422
|
+
/**
|
|
423
|
+
* Updates object metadata. Allows updating fixed-key and custom metadata. For example, `Cache-Control`, `Content-Disposition`, `Content-Encoding`, `Content-Language`, `Content-Type`, `Custom-Time`, and `Retention configuration`.
|
|
341
424
|
*/
|
|
342
425
|
putMetadata?: Schema$PutMetadata;
|
|
343
426
|
/**
|
|
@@ -352,10 +435,18 @@ export namespace storagebatchoperations_v1 {
|
|
|
352
435
|
* Output only. The time that the job was scheduled.
|
|
353
436
|
*/
|
|
354
437
|
scheduleTime?: string | null;
|
|
438
|
+
/**
|
|
439
|
+
* Updates object ACLs.
|
|
440
|
+
*/
|
|
441
|
+
setObjectAcls?: Schema$SetObjectAcls;
|
|
355
442
|
/**
|
|
356
443
|
* Output only. State of the job.
|
|
357
444
|
*/
|
|
358
445
|
state?: string | null;
|
|
446
|
+
/**
|
|
447
|
+
* Update object custom context.
|
|
448
|
+
*/
|
|
449
|
+
updateObjectCustomContext?: Schema$UpdateObjectCustomContext;
|
|
359
450
|
}
|
|
360
451
|
/**
|
|
361
452
|
* Message for response to listing BucketOperations
|
|
@@ -464,20 +555,42 @@ export namespace storagebatchoperations_v1 {
|
|
|
464
555
|
*/
|
|
465
556
|
export interface Schema$Manifest {
|
|
466
557
|
/**
|
|
467
|
-
* Required.
|
|
558
|
+
* Required. Specify the manifest file location. The format of manifest location can be an absolute path to the object in the format of `gs://bucket_name/path/object_name`. For example, `gs://bucket_name/path/object_name.csv`. Alternatively, you can specify an absolute path with a single wildcard character in the file name, for example `gs://bucket_name/path/file_name*.csv`. If the manifest location is specified with a wildcard, objects in all manifest files matching the pattern will be acted upon. The manifest is a CSV file, uploaded to Cloud Storage, that contains one object or a list of objects that you want to process. Each row in the manifest must include the `bucket` and `name` of the object. You can optionally specify the `generation` of the object. If you don't specify the `generation`, the current version of the object is used. You can optionally include a header row with the following format: `bucket,name,generation`. For example, bucket,name,generation bucket_1,object_1,generation_1 bucket_1,object_2,generation_2 bucket_1,object_3,generation_3 Note: The manifest file must specify only objects within the bucket provided to the job. Rows referencing objects in other buckets are ignored.
|
|
468
559
|
*/
|
|
469
560
|
manifestLocation?: string | null;
|
|
470
561
|
}
|
|
562
|
+
/**
|
|
563
|
+
* Represents an access control entry on an object.
|
|
564
|
+
*/
|
|
565
|
+
export interface Schema$ObjectAccessControl {
|
|
566
|
+
/**
|
|
567
|
+
* Required. The entity holding the permission, in one of the following forms: * `allUsers` * `allAuthenticatedUsers`
|
|
568
|
+
*/
|
|
569
|
+
entity?: string | null;
|
|
570
|
+
/**
|
|
571
|
+
* Required. The role to grant. Acceptable values are: * `READER` - gives read access to the object. * `OWNER` - gives owner access to the object.
|
|
572
|
+
*/
|
|
573
|
+
role?: string | null;
|
|
574
|
+
}
|
|
575
|
+
/**
|
|
576
|
+
* Describes the payload of a user-defined object custom context.
|
|
577
|
+
*/
|
|
578
|
+
export interface Schema$ObjectCustomContextPayload {
|
|
579
|
+
/**
|
|
580
|
+
* The value of the object custom context. If set, `value` can't be an empty string because it is a required field in custom context. If unset, `value` is ignored and no changes are made to the `value` field of the custom context payload.
|
|
581
|
+
*/
|
|
582
|
+
value?: string | null;
|
|
583
|
+
}
|
|
471
584
|
/**
|
|
472
585
|
* Describes options for object retention update.
|
|
473
586
|
*/
|
|
474
587
|
export interface Schema$ObjectRetention {
|
|
475
588
|
/**
|
|
476
|
-
* Required. The time
|
|
589
|
+
* Required. The object's retention expiration time, during which, the object is protected from being deleted or overwritten. The time must be specified in RFC 3339 format, for example `YYYY-MM-DD'T'HH:MM:SS'Z'` or `YYYY-MM-DD'T'HH:MM:SS.SS'Z'`. To clear an object's retention, both `retentionMode` and `retainUntilTime` must be left unset (omitted). Setting `retentionMode` to `RETENTION_MODE_UNSPECIFIED` is treated as a no-op. Unlike an unset field, it doesn't modify or clear the retention settings.
|
|
477
590
|
*/
|
|
478
591
|
retainUntilTime?: string | null;
|
|
479
592
|
/**
|
|
480
|
-
* Required. The retention mode
|
|
593
|
+
* Required. The retention mode.
|
|
481
594
|
*/
|
|
482
595
|
retentionMode?: string | null;
|
|
483
596
|
}
|
|
@@ -527,7 +640,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
527
640
|
*/
|
|
528
641
|
job?: Schema$Job;
|
|
529
642
|
/**
|
|
530
|
-
* Output only. The unique operation resource name. Format: projects/{
|
|
643
|
+
* Output only. The unique operation resource name. Format: projects/{project_id\}/locations/global/operations/{operation\}.
|
|
531
644
|
*/
|
|
532
645
|
operation?: string | null;
|
|
533
646
|
/**
|
|
@@ -540,44 +653,77 @@ export namespace storagebatchoperations_v1 {
|
|
|
540
653
|
*/
|
|
541
654
|
export interface Schema$PrefixList {
|
|
542
655
|
/**
|
|
543
|
-
* Optional.
|
|
656
|
+
* Optional. Specify one or more object prefixes. For example: * To match one object, use a single prefix, `prefix1`. * To match multiple objects, use comma-separated prefixes, `prefix1, prefix2`. * To match all objects, use an empty prefix, `''`
|
|
544
657
|
*/
|
|
545
658
|
includedObjectPrefixes?: string[] | null;
|
|
546
659
|
}
|
|
660
|
+
/**
|
|
661
|
+
* Describes the project source where the objects satisfying the filters will be transformed.
|
|
662
|
+
*/
|
|
663
|
+
export interface Schema$ProjectSource {
|
|
664
|
+
/**
|
|
665
|
+
* Optional. Filters expressed in Common Expression Language (CEL) to apply to buckets to identify buckets with objects to be transformed.
|
|
666
|
+
*/
|
|
667
|
+
bucketFilters?: Schema$Expr;
|
|
668
|
+
/**
|
|
669
|
+
* Optional. The unique identifier of a dry run job to use as the baseline for the current job. Specifying this ID ensures the job is executed against the same set of objects validated during the dry run. The value corresponds to the {job_id\} segment of the resource name: `projects/{project_id\}/locations/{location\}/jobs/{job_id\}`.
|
|
670
|
+
*/
|
|
671
|
+
dryRunJobId?: string | null;
|
|
672
|
+
/**
|
|
673
|
+
* Required. The resource identifier of the Storage Insights dataset configuration. Storage batch operations uses the latest snapshot from this dataset as the source to list and filter target objects. Format: `projects/{project_id\}/locations/{location\}/datasetConfigs/{dataset_config\}`.
|
|
674
|
+
*/
|
|
675
|
+
insightsDatasetConfig?: string | null;
|
|
676
|
+
/**
|
|
677
|
+
* Optional. Filters expressed in Common Expression Language (CEL) to apply to objects to identify objects to be transformed.
|
|
678
|
+
*/
|
|
679
|
+
objectFilters?: Schema$Expr;
|
|
680
|
+
/**
|
|
681
|
+
* Required. Project name of the objects to be transformed. e.g. projects/my-project or projects/123456.
|
|
682
|
+
*/
|
|
683
|
+
project?: string | null;
|
|
684
|
+
/**
|
|
685
|
+
* Output only. The snapshot time used by the job to read the Storage Insights dataset for bucket and object discovery. This field is populated by the service and reflects the exact timestamp of the dataset snapshot used.
|
|
686
|
+
*/
|
|
687
|
+
snapshotTime?: string | null;
|
|
688
|
+
/**
|
|
689
|
+
* Optional. Specifies the Cloud Storage locations to include in the job. If provided, only buckets and objects within these locations will be discovered from the Storage Insights dataset as configured in the `insights_dataset_config`. If omitted, the job will discover buckets and objects from all locations configured in the `insights_dataset_config`.
|
|
690
|
+
*/
|
|
691
|
+
targetLocations?: Schema$TargetLocations;
|
|
692
|
+
}
|
|
547
693
|
/**
|
|
548
694
|
* Describes options for object metadata update.
|
|
549
695
|
*/
|
|
550
696
|
export interface Schema$PutMetadata {
|
|
551
697
|
/**
|
|
552
|
-
* Optional. Updates objects Cache-Control fixed metadata. Unset values
|
|
698
|
+
* Optional. Updates the objects `Cache-Control` fixed metadata. Unset values in the request are ignored. To clear the metadata, set an empty value. Additionally, the value for `Custom-Time` can't decrease. For details, see [Cache-Control](https://cloud.google.com/storage/docs/metadata#caching_data).
|
|
553
699
|
*/
|
|
554
700
|
cacheControl?: string | null;
|
|
555
701
|
/**
|
|
556
|
-
* Optional. Updates objects Content-Disposition fixed metadata. Unset values
|
|
702
|
+
* Optional. Updates objects `Content-Disposition` fixed metadata. Unset values in the request are ignored. To clear the metadata, set an empty value. For details, see [Content-Disposition](https://cloud.google.com/storage/docs/metadata#content-disposition).
|
|
557
703
|
*/
|
|
558
704
|
contentDisposition?: string | null;
|
|
559
705
|
/**
|
|
560
|
-
* Optional. Updates objects Content-Encoding fixed metadata. Unset values
|
|
706
|
+
* Optional. Updates the objects `Content-Encoding` fixed metadata. Unset values in the request are ignored. To clear the metadata, set an empty value. For details, see [Content-Encoding](https://cloud.google.com/storage/docs/metadata#content-encoding).
|
|
561
707
|
*/
|
|
562
708
|
contentEncoding?: string | null;
|
|
563
709
|
/**
|
|
564
|
-
* Optional. Updates objects Content-Language fixed metadata.
|
|
710
|
+
* Optional. Updates the objects `Content-Language` fixed metadata. Metadata values must use ISO 639-1 language codes. The maximum length for metadata values is 100 characters. Unset values in the request are ignored. To clear the metadata, set an empty value. For details, see [Content-Language](https://cloud.google.com/storage/docs/metadata#content-language).
|
|
565
711
|
*/
|
|
566
712
|
contentLanguage?: string | null;
|
|
567
713
|
/**
|
|
568
|
-
* Optional. Updates objects Content-Type fixed metadata. Unset values
|
|
714
|
+
* Optional. Updates objects `Content-Type` fixed metadata. Unset values in the request are ignored. To clear the metadata, set an empty value. For details, see [Content-Type](https://cloud.google.com/storage/docs/metadata#content-type).
|
|
569
715
|
*/
|
|
570
716
|
contentType?: string | null;
|
|
571
717
|
/**
|
|
572
|
-
* Optional. Updates
|
|
718
|
+
* Optional. Updates the object's custom metadata. This operation adds or sets individual custom metadata key-value pairs. Keys specified with empty values have their values cleared. Existing custom metadata keys not included in the request remain unchanged. For details, see [Custom metadata](https://cloud.google.com/storage/docs/metadata#custom-metadata).
|
|
573
719
|
*/
|
|
574
720
|
customMetadata?: {[key: string]: string} | null;
|
|
575
721
|
/**
|
|
576
|
-
* Optional. Updates objects Custom-Time fixed metadata. Unset values
|
|
722
|
+
* Optional. Updates the objects `Custom-Time` fixed metadata. Unset values in the request are ignored. To clear the metadata, set an empty value. The time must be specified in RFC 3339 format, for example `YYYY-MM-DD'T'HH:MM:SS'Z'` or `YYYY-MM-DD'T'HH:MM:SS.SS'Z'`. For details, see [Custom-Time](https://cloud.google.com/storage/docs/metadata#custom-time).
|
|
577
723
|
*/
|
|
578
724
|
customTime?: string | null;
|
|
579
725
|
/**
|
|
580
|
-
* Optional. Updates
|
|
726
|
+
* Optional. Updates an object's retention configuration. To clear an object's retention, both `retentionMode` and `retainUntilTime` must be left unset (omitted). Setting `retentionMode` to `RETENTION_MODE_UNSPECIFIED` is treated as a no-op. Unlike an unset field, it doesn't modify or clear the retention settings. An object with `LOCKED` retention mode can't have its retention cleared or its `retainUntilTime` reduced. For more information, see [Object retention](https://cloud.google.com/storage/docs/batch-operations/create-manage-batch-operation-jobs#retain-until-time).
|
|
581
727
|
*/
|
|
582
728
|
objectRetention?: Schema$ObjectRetention;
|
|
583
729
|
}
|
|
@@ -586,11 +732,11 @@ export namespace storagebatchoperations_v1 {
|
|
|
586
732
|
*/
|
|
587
733
|
export interface Schema$PutObjectHold {
|
|
588
734
|
/**
|
|
589
|
-
* Required. Updates object event based holds state. When object event based hold is set, object
|
|
735
|
+
* Required. Updates object event based holds state. When object event based hold is set, object can't be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period.
|
|
590
736
|
*/
|
|
591
737
|
eventBasedHold?: string | null;
|
|
592
738
|
/**
|
|
593
|
-
* Required. Updates object temporary holds state. When object temporary hold is set, object
|
|
739
|
+
* Required. Updates object temporary holds state. When object temporary hold is set, object can't be deleted or replaced.
|
|
594
740
|
*/
|
|
595
741
|
temporaryHold?: string | null;
|
|
596
742
|
}
|
|
@@ -599,9 +745,22 @@ export namespace storagebatchoperations_v1 {
|
|
|
599
745
|
*/
|
|
600
746
|
export interface Schema$RewriteObject {
|
|
601
747
|
/**
|
|
602
|
-
*
|
|
748
|
+
* Optional. Resource name of the Cloud KMS key that is used to encrypt the object. The Cloud KMS key must be located in same location as the object. For details, see https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key Format: `projects/{project_id\}/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.
|
|
603
749
|
*/
|
|
604
750
|
kmsKey?: string | null;
|
|
751
|
+
/**
|
|
752
|
+
* Optional. Rewrites the object to the specified storage class. Setting this field will perform a full byte copy of the object if the storage class is different from the object's current storage class. If Autoclass is enabled on the bucket, storage class changes are ignored by Cloud Storage.
|
|
753
|
+
*/
|
|
754
|
+
storageClass?: string | null;
|
|
755
|
+
}
|
|
756
|
+
/**
|
|
757
|
+
* Describes options for setting object ACLs.
|
|
758
|
+
*/
|
|
759
|
+
export interface Schema$SetObjectAcls {
|
|
760
|
+
/**
|
|
761
|
+
* Required. Add, update, or remove grants from the object's existing ACLs.
|
|
762
|
+
*/
|
|
763
|
+
accessControlsUpdates?: Schema$AccessControlsUpdates;
|
|
605
764
|
}
|
|
606
765
|
/**
|
|
607
766
|
* 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).
|
|
@@ -620,6 +779,32 @@ export namespace storagebatchoperations_v1 {
|
|
|
620
779
|
*/
|
|
621
780
|
message?: string | null;
|
|
622
781
|
}
|
|
782
|
+
/**
|
|
783
|
+
* Describes the Cloud Storage locations to include in a ProjectSource job.
|
|
784
|
+
*/
|
|
785
|
+
export interface Schema$TargetLocations {
|
|
786
|
+
/**
|
|
787
|
+
* Required. REQUIRED. A list of Cloud Storage locations (e.g., `us-central1`) to include in the job. If `snapshot_time` is omitted, the job automatically defaults to the most recent snapshot timestamp that is successfully populated in BOTH the `object_attributes_view` and `bucket_attributes_view` across ALL specified locations. For details on Storage Insights dataset snapshots and views, see: https://docs.cloud.google.com/storage/docs/insights/dataset-tables-and-schemas#schema
|
|
788
|
+
*/
|
|
789
|
+
locations?: string[] | null;
|
|
790
|
+
/**
|
|
791
|
+
* Optional. OPTIONAL. The exact Storage Insights snapshot timestamp to use for the job compatible with the RFC 3339 format (e.g., `2024-01-02T03:04:05Z`). If specified, this exact snapshot must exist in BOTH the `object_attributes_view` and `bucket_attributes_view` for every location listed in `locations`. If the snapshot is missing from either view in any of the locations, the job fails.
|
|
792
|
+
*/
|
|
793
|
+
snapshotTime?: string | null;
|
|
794
|
+
}
|
|
795
|
+
/**
|
|
796
|
+
* Describes options to update object custom contexts.
|
|
797
|
+
*/
|
|
798
|
+
export interface Schema$UpdateObjectCustomContext {
|
|
799
|
+
/**
|
|
800
|
+
* If set, must be set to true and all existing object custom contexts are deleted.
|
|
801
|
+
*/
|
|
802
|
+
clearAll?: boolean | null;
|
|
803
|
+
/**
|
|
804
|
+
* A collection of updates to apply to specific custom contexts. Use this to add, update or delete individual contexts by key.
|
|
805
|
+
*/
|
|
806
|
+
customContextUpdates?: Schema$CustomContextUpdates;
|
|
807
|
+
}
|
|
623
808
|
|
|
624
809
|
export class Resource$Projects {
|
|
625
810
|
context: APIRequestContext;
|
|
@@ -734,8 +919,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
734
919
|
| BodyResponseCallback<Schema$Location>
|
|
735
920
|
| BodyResponseCallback<Readable>,
|
|
736
921
|
callback?:
|
|
737
|
-
|
|
738
|
-
| BodyResponseCallback<Readable>
|
|
922
|
+
BodyResponseCallback<Schema$Location> | BodyResponseCallback<Readable>
|
|
739
923
|
):
|
|
740
924
|
| void
|
|
741
925
|
| Promise<GaxiosResponseWithHTTP2<Schema$Location>>
|
|
@@ -782,7 +966,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
782
966
|
}
|
|
783
967
|
|
|
784
968
|
/**
|
|
785
|
-
* Lists information about the supported locations for this service. This method
|
|
969
|
+
* Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
|
|
786
970
|
* @example
|
|
787
971
|
* ```js
|
|
788
972
|
* // Before running the sample:
|
|
@@ -812,7 +996,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
812
996
|
*
|
|
813
997
|
* // Do the magic
|
|
814
998
|
* const res = await storagebatchoperations.projects.locations.list({
|
|
815
|
-
* // Optional. Do not use this field
|
|
999
|
+
* // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
816
1000
|
* extraLocationTypes: 'placeholder-value',
|
|
817
1001
|
* // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
|
|
818
1002
|
* filter: 'placeholder-value',
|
|
@@ -860,8 +1044,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
860
1044
|
list(
|
|
861
1045
|
params: Params$Resource$Projects$Locations$List,
|
|
862
1046
|
options:
|
|
863
|
-
|
|
|
864
|
-
| BodyResponseCallback<Schema$ListLocationsResponse>,
|
|
1047
|
+
MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>,
|
|
865
1048
|
callback: BodyResponseCallback<Schema$ListLocationsResponse>
|
|
866
1049
|
): void;
|
|
867
1050
|
list(
|
|
@@ -939,7 +1122,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
939
1122
|
}
|
|
940
1123
|
export interface Params$Resource$Projects$Locations$List extends StandardParameters {
|
|
941
1124
|
/**
|
|
942
|
-
* Optional. Do not use this field
|
|
1125
|
+
* Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
943
1126
|
*/
|
|
944
1127
|
extraLocationTypes?: string[];
|
|
945
1128
|
/**
|
|
@@ -1000,7 +1183,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
1000
1183
|
*
|
|
1001
1184
|
* // Do the magic
|
|
1002
1185
|
* const res = await storagebatchoperations.projects.locations.jobs.cancel({
|
|
1003
|
-
* // Required. The `name` of the job to cancel. Format: projects/{project_id\}/locations/global/jobs/{job_id\}
|
|
1186
|
+
* // Required. The `name` of the job to cancel. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
|
|
1004
1187
|
* name: 'projects/my-project/locations/my-location/jobs/my-job',
|
|
1005
1188
|
*
|
|
1006
1189
|
* // Request body metadata
|
|
@@ -1141,11 +1324,11 @@ export namespace storagebatchoperations_v1 {
|
|
|
1141
1324
|
*
|
|
1142
1325
|
* // Do the magic
|
|
1143
1326
|
* const res = await storagebatchoperations.projects.locations.jobs.create({
|
|
1144
|
-
* // Required.
|
|
1327
|
+
* // Required. A unique identifier for the job. `job_id` must be up to 128 characters and must include only characters available in DNS names, as defined by RFC-1123.
|
|
1145
1328
|
* jobId: 'placeholder-value',
|
|
1146
|
-
* // Required.
|
|
1329
|
+
* // Required. The value for parent.
|
|
1147
1330
|
* parent: 'projects/my-project/locations/my-location',
|
|
1148
|
-
* // 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`
|
|
1331
|
+
* // 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` are ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID isn't supported (00000000-0000-0000-0000-000000000000).
|
|
1149
1332
|
* requestId: 'placeholder-value',
|
|
1150
1333
|
*
|
|
1151
1334
|
* // Request body metadata
|
|
@@ -1160,13 +1343,17 @@ export namespace storagebatchoperations_v1 {
|
|
|
1160
1343
|
* // "description": "my_description",
|
|
1161
1344
|
* // "dryRun": false,
|
|
1162
1345
|
* // "errorSummaries": [],
|
|
1346
|
+
* // "isMultiBucketJob": false,
|
|
1163
1347
|
* // "loggingConfig": {},
|
|
1164
1348
|
* // "name": "my_name",
|
|
1349
|
+
* // "projectSource": {},
|
|
1165
1350
|
* // "putMetadata": {},
|
|
1166
1351
|
* // "putObjectHold": {},
|
|
1167
1352
|
* // "rewriteObject": {},
|
|
1168
1353
|
* // "scheduleTime": "my_scheduleTime",
|
|
1169
|
-
* // "
|
|
1354
|
+
* // "setObjectAcls": {},
|
|
1355
|
+
* // "state": "my_state",
|
|
1356
|
+
* // "updateObjectCustomContext": {}
|
|
1170
1357
|
* // }
|
|
1171
1358
|
* },
|
|
1172
1359
|
* });
|
|
@@ -1228,8 +1415,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
1228
1415
|
| BodyResponseCallback<Schema$Operation>
|
|
1229
1416
|
| BodyResponseCallback<Readable>,
|
|
1230
1417
|
callback?:
|
|
1231
|
-
|
|
1232
|
-
| BodyResponseCallback<Readable>
|
|
1418
|
+
BodyResponseCallback<Schema$Operation> | BodyResponseCallback<Readable>
|
|
1233
1419
|
):
|
|
1234
1420
|
| void
|
|
1235
1421
|
| Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
|
|
@@ -1306,11 +1492,11 @@ export namespace storagebatchoperations_v1 {
|
|
|
1306
1492
|
*
|
|
1307
1493
|
* // Do the magic
|
|
1308
1494
|
* const res = await storagebatchoperations.projects.locations.jobs.delete({
|
|
1309
|
-
* // Optional. If set to true, any child bucket operations of the job
|
|
1495
|
+
* // Optional. If set to true, any child bucket operations of the job are deleted. We recommend setting this to `true`. You can't mutate bucket operations directly, so only the `jobs.delete` permission is required to delete a job (and its child bucket operations).
|
|
1310
1496
|
* force: 'placeholder-value',
|
|
1311
|
-
* // Required. The `name` of the job to delete. Format: projects/{project_id\}/locations/global/jobs/{job_id\}
|
|
1497
|
+
* // Required. The `name` of the job to delete. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
|
|
1312
1498
|
* name: 'projects/my-project/locations/my-location/jobs/my-job',
|
|
1313
|
-
* // 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`
|
|
1499
|
+
* // 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` are ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID isn't supported (00000000-0000-0000-0000-000000000000).
|
|
1314
1500
|
* requestId: 'placeholder-value',
|
|
1315
1501
|
* });
|
|
1316
1502
|
* console.log(res.data);
|
|
@@ -1365,8 +1551,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
1365
1551
|
| BodyResponseCallback<Schema$Empty>
|
|
1366
1552
|
| BodyResponseCallback<Readable>,
|
|
1367
1553
|
callback?:
|
|
1368
|
-
|
|
1369
|
-
| BodyResponseCallback<Readable>
|
|
1554
|
+
BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
|
|
1370
1555
|
):
|
|
1371
1556
|
| void
|
|
1372
1557
|
| Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
|
|
@@ -1443,7 +1628,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
1443
1628
|
*
|
|
1444
1629
|
* // Do the magic
|
|
1445
1630
|
* const res = await storagebatchoperations.projects.locations.jobs.get({
|
|
1446
|
-
* // Required. `name` of the job to retrieve. Format: projects/{project_id\}/locations/global/jobs/{job_id\}
|
|
1631
|
+
* // Required. The `name` of the job to retrieve. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
|
|
1447
1632
|
* name: 'projects/my-project/locations/my-location/jobs/my-job',
|
|
1448
1633
|
* });
|
|
1449
1634
|
* console.log(res.data);
|
|
@@ -1458,13 +1643,17 @@ export namespace storagebatchoperations_v1 {
|
|
|
1458
1643
|
* // "description": "my_description",
|
|
1459
1644
|
* // "dryRun": false,
|
|
1460
1645
|
* // "errorSummaries": [],
|
|
1646
|
+
* // "isMultiBucketJob": false,
|
|
1461
1647
|
* // "loggingConfig": {},
|
|
1462
1648
|
* // "name": "my_name",
|
|
1649
|
+
* // "projectSource": {},
|
|
1463
1650
|
* // "putMetadata": {},
|
|
1464
1651
|
* // "putObjectHold": {},
|
|
1465
1652
|
* // "rewriteObject": {},
|
|
1466
1653
|
* // "scheduleTime": "my_scheduleTime",
|
|
1467
|
-
* // "
|
|
1654
|
+
* // "setObjectAcls": {},
|
|
1655
|
+
* // "state": "my_state",
|
|
1656
|
+
* // "updateObjectCustomContext": {}
|
|
1468
1657
|
* // }
|
|
1469
1658
|
* }
|
|
1470
1659
|
*
|
|
@@ -1514,8 +1703,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
1514
1703
|
| BodyResponseCallback<Schema$Job>
|
|
1515
1704
|
| BodyResponseCallback<Readable>,
|
|
1516
1705
|
callback?:
|
|
1517
|
-
|
|
1518
|
-
| BodyResponseCallback<Readable>
|
|
1706
|
+
BodyResponseCallback<Schema$Job> | BodyResponseCallback<Readable>
|
|
1519
1707
|
):
|
|
1520
1708
|
| void
|
|
1521
1709
|
| Promise<GaxiosResponseWithHTTP2<Schema$Job>>
|
|
@@ -1594,9 +1782,9 @@ export namespace storagebatchoperations_v1 {
|
|
|
1594
1782
|
* const res = await storagebatchoperations.projects.locations.jobs.list({
|
|
1595
1783
|
* // Optional. Filters results as defined by https://google.aip.dev/160.
|
|
1596
1784
|
* filter: 'placeholder-value',
|
|
1597
|
-
* // Optional. Field to sort by. Supported fields are name
|
|
1785
|
+
* // Optional. Field to sort by. Supported fields are `name` and `create_time`.
|
|
1598
1786
|
* orderBy: 'placeholder-value',
|
|
1599
|
-
* // Optional. The list page size. default page size is 100.
|
|
1787
|
+
* // Optional. The list page size. The default page size is 100.
|
|
1600
1788
|
* pageSize: 'placeholder-value',
|
|
1601
1789
|
* // Optional. The list page token.
|
|
1602
1790
|
* pageToken: 'placeholder-value',
|
|
@@ -1709,7 +1897,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
1709
1897
|
|
|
1710
1898
|
export interface Params$Resource$Projects$Locations$Jobs$Cancel extends StandardParameters {
|
|
1711
1899
|
/**
|
|
1712
|
-
* Required. The `name` of the job to cancel. Format: projects/{project_id\}/locations/global/jobs/{job_id\}
|
|
1900
|
+
* Required. The `name` of the job to cancel. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
|
|
1713
1901
|
*/
|
|
1714
1902
|
name?: string;
|
|
1715
1903
|
|
|
@@ -1720,15 +1908,15 @@ export namespace storagebatchoperations_v1 {
|
|
|
1720
1908
|
}
|
|
1721
1909
|
export interface Params$Resource$Projects$Locations$Jobs$Create extends StandardParameters {
|
|
1722
1910
|
/**
|
|
1723
|
-
* Required.
|
|
1911
|
+
* Required. A unique identifier for the job. `job_id` must be up to 128 characters and must include only characters available in DNS names, as defined by RFC-1123.
|
|
1724
1912
|
*/
|
|
1725
1913
|
jobId?: string;
|
|
1726
1914
|
/**
|
|
1727
|
-
* Required.
|
|
1915
|
+
* Required. The value for parent.
|
|
1728
1916
|
*/
|
|
1729
1917
|
parent?: string;
|
|
1730
1918
|
/**
|
|
1731
|
-
* 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`
|
|
1919
|
+
* 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` are ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID isn't supported (00000000-0000-0000-0000-000000000000).
|
|
1732
1920
|
*/
|
|
1733
1921
|
requestId?: string;
|
|
1734
1922
|
|
|
@@ -1739,21 +1927,21 @@ export namespace storagebatchoperations_v1 {
|
|
|
1739
1927
|
}
|
|
1740
1928
|
export interface Params$Resource$Projects$Locations$Jobs$Delete extends StandardParameters {
|
|
1741
1929
|
/**
|
|
1742
|
-
* Optional. If set to true, any child bucket operations of the job
|
|
1930
|
+
* Optional. If set to true, any child bucket operations of the job are deleted. We recommend setting this to `true`. You can't mutate bucket operations directly, so only the `jobs.delete` permission is required to delete a job (and its child bucket operations).
|
|
1743
1931
|
*/
|
|
1744
1932
|
force?: boolean;
|
|
1745
1933
|
/**
|
|
1746
|
-
* Required. The `name` of the job to delete. Format: projects/{project_id\}/locations/global/jobs/{job_id\}
|
|
1934
|
+
* Required. The `name` of the job to delete. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
|
|
1747
1935
|
*/
|
|
1748
1936
|
name?: string;
|
|
1749
1937
|
/**
|
|
1750
|
-
* 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`
|
|
1938
|
+
* 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` are ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID isn't supported (00000000-0000-0000-0000-000000000000).
|
|
1751
1939
|
*/
|
|
1752
1940
|
requestId?: string;
|
|
1753
1941
|
}
|
|
1754
1942
|
export interface Params$Resource$Projects$Locations$Jobs$Get extends StandardParameters {
|
|
1755
1943
|
/**
|
|
1756
|
-
* Required. `name` of the job to retrieve. Format: projects/{project_id\}/locations/global/jobs/{job_id\}
|
|
1944
|
+
* Required. The `name` of the job to retrieve. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
|
|
1757
1945
|
*/
|
|
1758
1946
|
name?: string;
|
|
1759
1947
|
}
|
|
@@ -1763,11 +1951,11 @@ export namespace storagebatchoperations_v1 {
|
|
|
1763
1951
|
*/
|
|
1764
1952
|
filter?: string;
|
|
1765
1953
|
/**
|
|
1766
|
-
* Optional. Field to sort by. Supported fields are name
|
|
1954
|
+
* Optional. Field to sort by. Supported fields are `name` and `create_time`.
|
|
1767
1955
|
*/
|
|
1768
1956
|
orderBy?: string;
|
|
1769
1957
|
/**
|
|
1770
|
-
* Optional. The list page size. default page size is 100.
|
|
1958
|
+
* Optional. The list page size. The default page size is 100.
|
|
1771
1959
|
*/
|
|
1772
1960
|
pageSize?: number;
|
|
1773
1961
|
/**
|
|
@@ -1818,7 +2006,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
1818
2006
|
* // Do the magic
|
|
1819
2007
|
* const res =
|
|
1820
2008
|
* await storagebatchoperations.projects.locations.jobs.bucketOperations.get({
|
|
1821
|
-
* // Required. `name` of the bucket operation to retrieve. Format: projects/{project_id\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation_id\}
|
|
2009
|
+
* // Required. The `name` of the bucket operation to retrieve. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation_id\}`.
|
|
1822
2010
|
* name: 'projects/my-project/locations/my-location/jobs/my-job/bucketOperations/my-bucketOperation',
|
|
1823
2011
|
* });
|
|
1824
2012
|
* console.log(res.data);
|
|
@@ -1834,11 +2022,14 @@ export namespace storagebatchoperations_v1 {
|
|
|
1834
2022
|
* // "manifest": {},
|
|
1835
2023
|
* // "name": "my_name",
|
|
1836
2024
|
* // "prefixList": {},
|
|
2025
|
+
* // "projectSource": {},
|
|
1837
2026
|
* // "putMetadata": {},
|
|
1838
2027
|
* // "putObjectHold": {},
|
|
1839
2028
|
* // "rewriteObject": {},
|
|
2029
|
+
* // "setObjectAcls": {},
|
|
1840
2030
|
* // "startTime": "my_startTime",
|
|
1841
|
-
* // "state": "my_state"
|
|
2031
|
+
* // "state": "my_state",
|
|
2032
|
+
* // "updateObjectCustomContext": {}
|
|
1842
2033
|
* // }
|
|
1843
2034
|
* }
|
|
1844
2035
|
*
|
|
@@ -1970,13 +2161,13 @@ export namespace storagebatchoperations_v1 {
|
|
|
1970
2161
|
* await storagebatchoperations.projects.locations.jobs.bucketOperations.list({
|
|
1971
2162
|
* // Optional. Filters results as defined by https://google.aip.dev/160.
|
|
1972
2163
|
* filter: 'placeholder-value',
|
|
1973
|
-
* // Optional. Field to sort by. Supported fields are name
|
|
2164
|
+
* // Optional. Field to sort by. Supported fields are `name` and `create_time`.
|
|
1974
2165
|
* orderBy: 'placeholder-value',
|
|
1975
2166
|
* // Optional. The list page size. Default page size is 100.
|
|
1976
2167
|
* pageSize: 'placeholder-value',
|
|
1977
2168
|
* // Optional. The list page token.
|
|
1978
2169
|
* pageToken: 'placeholder-value',
|
|
1979
|
-
* // Required. Format: projects/{project_id\}/locations/global/jobs/{job_id\}
|
|
2170
|
+
* // Required. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
|
|
1980
2171
|
* parent: 'projects/my-project/locations/my-location/jobs/my-job',
|
|
1981
2172
|
* });
|
|
1982
2173
|
* console.log(res.data);
|
|
@@ -2095,7 +2286,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
2095
2286
|
|
|
2096
2287
|
export interface Params$Resource$Projects$Locations$Jobs$Bucketoperations$Get extends StandardParameters {
|
|
2097
2288
|
/**
|
|
2098
|
-
* Required. `name` of the bucket operation to retrieve. Format: projects/{project_id\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation_id\}
|
|
2289
|
+
* Required. The `name` of the bucket operation to retrieve. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation_id\}`.
|
|
2099
2290
|
*/
|
|
2100
2291
|
name?: string;
|
|
2101
2292
|
}
|
|
@@ -2105,7 +2296,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
2105
2296
|
*/
|
|
2106
2297
|
filter?: string;
|
|
2107
2298
|
/**
|
|
2108
|
-
* Optional. Field to sort by. Supported fields are name
|
|
2299
|
+
* Optional. Field to sort by. Supported fields are `name` and `create_time`.
|
|
2109
2300
|
*/
|
|
2110
2301
|
orderBy?: string;
|
|
2111
2302
|
/**
|
|
@@ -2117,7 +2308,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
2117
2308
|
*/
|
|
2118
2309
|
pageToken?: string;
|
|
2119
2310
|
/**
|
|
2120
|
-
* Required. Format: projects/{project_id\}/locations/global/jobs/{job_id\}
|
|
2311
|
+
* Required. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
|
|
2121
2312
|
*/
|
|
2122
2313
|
parent?: string;
|
|
2123
2314
|
}
|
|
@@ -2222,8 +2413,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
2222
2413
|
| BodyResponseCallback<Schema$Empty>
|
|
2223
2414
|
| BodyResponseCallback<Readable>,
|
|
2224
2415
|
callback?:
|
|
2225
|
-
|
|
2226
|
-
| BodyResponseCallback<Readable>
|
|
2416
|
+
BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
|
|
2227
2417
|
):
|
|
2228
2418
|
| void
|
|
2229
2419
|
| Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
|
|
@@ -2357,8 +2547,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
2357
2547
|
| BodyResponseCallback<Schema$Empty>
|
|
2358
2548
|
| BodyResponseCallback<Readable>,
|
|
2359
2549
|
callback?:
|
|
2360
|
-
|
|
2361
|
-
| BodyResponseCallback<Readable>
|
|
2550
|
+
BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
|
|
2362
2551
|
):
|
|
2363
2552
|
| void
|
|
2364
2553
|
| Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
|
|
@@ -2496,8 +2685,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
2496
2685
|
| BodyResponseCallback<Schema$Operation>
|
|
2497
2686
|
| BodyResponseCallback<Readable>,
|
|
2498
2687
|
callback?:
|
|
2499
|
-
|
|
2500
|
-
| BodyResponseCallback<Readable>
|
|
2688
|
+
BodyResponseCallback<Schema$Operation> | BodyResponseCallback<Readable>
|
|
2501
2689
|
):
|
|
2502
2690
|
| void
|
|
2503
2691
|
| Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
|
|
@@ -2623,8 +2811,7 @@ export namespace storagebatchoperations_v1 {
|
|
|
2623
2811
|
list(
|
|
2624
2812
|
params: Params$Resource$Projects$Locations$Operations$List,
|
|
2625
2813
|
options:
|
|
2626
|
-
|
|
|
2627
|
-
| BodyResponseCallback<Schema$ListOperationsResponse>,
|
|
2814
|
+
MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>,
|
|
2628
2815
|
callback: BodyResponseCallback<Schema$ListOperationsResponse>
|
|
2629
2816
|
): void;
|
|
2630
2817
|
list(
|