@googleapis/storagebatchoperations 8.3.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/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. Currently, only one bucket configuration is supported. If multiple buckets are specified, an error will be returned.
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/{project\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation\}.
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
  */
@@ -220,7 +241,7 @@ export namespace storagebatchoperations_v1 {
220
241
  */
221
242
  export interface Schema$CancelJobRequest {
222
243
  /**
223
- * 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).
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).
224
245
  */
225
246
  requestId?: string | null;
226
247
  }
@@ -274,7 +295,7 @@ export namespace storagebatchoperations_v1 {
274
295
  */
275
296
  export interface Schema$CustomContextUpdates {
276
297
  /**
277
- * Optional. Custom contexts to clear by key. A key cannot be present in both `updates` and `keys_to_clear`.
298
+ * Optional. Custom contexts to clear by key. A key can't be present in both `updates` and `keys_to_clear`.
278
299
  */
279
300
  keysToClear?: string[] | null;
280
301
  /**
@@ -287,7 +308,7 @@ export namespace storagebatchoperations_v1 {
287
308
  */
288
309
  export interface Schema$DeleteObject {
289
310
  /**
290
- * 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.
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.
291
312
  */
292
313
  permanentObjectDeletionEnabled?: boolean | null;
293
314
  }
@@ -326,7 +347,28 @@ export namespace storagebatchoperations_v1 {
326
347
  errorLogEntries?: Schema$ErrorLogEntry[];
327
348
  }
328
349
  /**
329
- * The Storage Batch Operations Job description.
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.
330
372
  */
331
373
  export interface Schema$Job {
332
374
  /**
@@ -350,11 +392,11 @@ export namespace storagebatchoperations_v1 {
350
392
  */
351
393
  deleteObject?: Schema$DeleteObject;
352
394
  /**
353
- * Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
395
+ * Optional. A user-provided description for the job. Maximum length: 1024 bytes when unicode-encoded.
354
396
  */
355
397
  description?: string | null;
356
398
  /**
357
- * Optional. If true, the job will run 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 will be performed.
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.
358
400
  */
359
401
  dryRun?: boolean | null;
360
402
  /**
@@ -362,7 +404,7 @@ export namespace storagebatchoperations_v1 {
362
404
  */
363
405
  errorSummaries?: Schema$ErrorSummary[];
364
406
  /**
365
- * Output only. If true, this Job operates on multiple buckets. Multibucket jobs are subject to different quota limits than single-bucket jobs.
407
+ * Output only. If true, this job operates on multiple buckets. Multi-bucket jobs are subject to different quota limits than single-bucket jobs.
366
408
  */
367
409
  isMultiBucketJob?: boolean | null;
368
410
  /**
@@ -370,11 +412,15 @@ export namespace storagebatchoperations_v1 {
370
412
  */
371
413
  loggingConfig?: Schema$LoggingConfig;
372
414
  /**
373
- * 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".
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.
374
416
  */
375
417
  name?: string | null;
376
418
  /**
377
- * 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.
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`.
378
424
  */
379
425
  putMetadata?: Schema$PutMetadata;
380
426
  /**
@@ -389,6 +435,10 @@ export namespace storagebatchoperations_v1 {
389
435
  * Output only. The time that the job was scheduled.
390
436
  */
391
437
  scheduleTime?: string | null;
438
+ /**
439
+ * Updates object ACLs.
440
+ */
441
+ setObjectAcls?: Schema$SetObjectAcls;
392
442
  /**
393
443
  * Output only. State of the job.
394
444
  */
@@ -505,16 +555,29 @@ export namespace storagebatchoperations_v1 {
505
555
  */
506
556
  export interface Schema$Manifest {
507
557
  /**
508
- * 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.
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.
509
559
  */
510
560
  manifestLocation?: string | null;
511
561
  }
512
562
  /**
513
- * Describes the payload of a user defined object custom context.
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.
514
577
  */
515
578
  export interface Schema$ObjectCustomContextPayload {
516
579
  /**
517
- * The value of the object custom context. If set, `value` must NOT be an empty string since it is a required field in custom context. If unset, `value` will be ignored and no changes will be made to the `value` field of the custom context payload.
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.
518
581
  */
519
582
  value?: string | null;
520
583
  }
@@ -523,11 +586,11 @@ export namespace storagebatchoperations_v1 {
523
586
  */
524
587
  export interface Schema$ObjectRetention {
525
588
  /**
526
- * Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.
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.
527
590
  */
528
591
  retainUntilTime?: string | null;
529
592
  /**
530
- * Required. The retention mode of the object.
593
+ * Required. The retention mode.
531
594
  */
532
595
  retentionMode?: string | null;
533
596
  }
@@ -577,7 +640,7 @@ export namespace storagebatchoperations_v1 {
577
640
  */
578
641
  job?: Schema$Job;
579
642
  /**
580
- * Output only. The unique operation resource name. Format: projects/{project\}/locations/global/operations/{operation\}.
643
+ * Output only. The unique operation resource name. Format: projects/{project_id\}/locations/global/operations/{operation\}.
581
644
  */
582
645
  operation?: string | null;
583
646
  /**
@@ -590,44 +653,77 @@ export namespace storagebatchoperations_v1 {
590
653
  */
591
654
  export interface Schema$PrefixList {
592
655
  /**
593
- * 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.
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, `''`
594
657
  */
595
658
  includedObjectPrefixes?: string[] | null;
596
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
+ }
597
693
  /**
598
694
  * Describes options for object metadata update.
599
695
  */
600
696
  export interface Schema$PutMetadata {
601
697
  /**
602
- * 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.
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).
603
699
  */
604
700
  cacheControl?: string | null;
605
701
  /**
606
- * 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.
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).
607
703
  */
608
704
  contentDisposition?: string | null;
609
705
  /**
610
- * 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.
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).
611
707
  */
612
708
  contentEncoding?: string | null;
613
709
  /**
614
- * 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.
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).
615
711
  */
616
712
  contentLanguage?: string | null;
617
713
  /**
618
- * 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
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).
619
715
  */
620
716
  contentType?: string | null;
621
717
  /**
622
- * 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
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).
623
719
  */
624
720
  customMetadata?: {[key: string]: string} | null;
625
721
  /**
626
- * 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.
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).
627
723
  */
628
724
  customTime?: string | null;
629
725
  /**
630
- * Optional. Updates objects retention lock configuration. Unset values will be ignored. Set empty values to clear the retention for the object with existing `Unlocked` retention mode. Object with existing `Locked` retention mode cannot be cleared or reduce retain_until_time. Refer to documentation in https://cloud.google.com/storage/docs/object-lock
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).
631
727
  */
632
728
  objectRetention?: Schema$ObjectRetention;
633
729
  }
@@ -636,11 +732,11 @@ export namespace storagebatchoperations_v1 {
636
732
  */
637
733
  export interface Schema$PutObjectHold {
638
734
  /**
639
- * 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.
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.
640
736
  */
641
737
  eventBasedHold?: string | null;
642
738
  /**
643
- * Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.
739
+ * Required. Updates object temporary holds state. When object temporary hold is set, object can't be deleted or replaced.
644
740
  */
645
741
  temporaryHold?: string | null;
646
742
  }
@@ -649,9 +745,22 @@ export namespace storagebatchoperations_v1 {
649
745
  */
650
746
  export interface Schema$RewriteObject {
651
747
  /**
652
- * 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.
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.
653
749
  */
654
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;
655
764
  }
656
765
  /**
657
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).
@@ -670,12 +779,25 @@ export namespace storagebatchoperations_v1 {
670
779
  */
671
780
  message?: string | null;
672
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
+ }
673
795
  /**
674
796
  * Describes options to update object custom contexts.
675
797
  */
676
798
  export interface Schema$UpdateObjectCustomContext {
677
799
  /**
678
- * If set, must be set to true and all existing object custom contexts will be deleted.
800
+ * If set, must be set to true and all existing object custom contexts are deleted.
679
801
  */
680
802
  clearAll?: boolean | null;
681
803
  /**
@@ -797,8 +919,7 @@ export namespace storagebatchoperations_v1 {
797
919
  | BodyResponseCallback<Schema$Location>
798
920
  | BodyResponseCallback<Readable>,
799
921
  callback?:
800
- | BodyResponseCallback<Schema$Location>
801
- | BodyResponseCallback<Readable>
922
+ BodyResponseCallback<Schema$Location> | BodyResponseCallback<Readable>
802
923
  ):
803
924
  | void
804
925
  | Promise<GaxiosResponseWithHTTP2<Schema$Location>>
@@ -923,8 +1044,7 @@ export namespace storagebatchoperations_v1 {
923
1044
  list(
924
1045
  params: Params$Resource$Projects$Locations$List,
925
1046
  options:
926
- | MethodOptions
927
- | BodyResponseCallback<Schema$ListLocationsResponse>,
1047
+ MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>,
928
1048
  callback: BodyResponseCallback<Schema$ListLocationsResponse>
929
1049
  ): void;
930
1050
  list(
@@ -1063,7 +1183,7 @@ export namespace storagebatchoperations_v1 {
1063
1183
  *
1064
1184
  * // Do the magic
1065
1185
  * const res = await storagebatchoperations.projects.locations.jobs.cancel({
1066
- * // 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\}`.
1067
1187
  * name: 'projects/my-project/locations/my-location/jobs/my-job',
1068
1188
  *
1069
1189
  * // Request body metadata
@@ -1204,11 +1324,11 @@ export namespace storagebatchoperations_v1 {
1204
1324
  *
1205
1325
  * // Do the magic
1206
1326
  * const res = await storagebatchoperations.projects.locations.jobs.create({
1207
- * // 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.
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.
1208
1328
  * jobId: 'placeholder-value',
1209
- * // Required. Value for parent.
1329
+ * // Required. The value for parent.
1210
1330
  * parent: 'projects/my-project/locations/my-location',
1211
- * // 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).
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).
1212
1332
  * requestId: 'placeholder-value',
1213
1333
  *
1214
1334
  * // Request body metadata
@@ -1226,10 +1346,12 @@ export namespace storagebatchoperations_v1 {
1226
1346
  * // "isMultiBucketJob": false,
1227
1347
  * // "loggingConfig": {},
1228
1348
  * // "name": "my_name",
1349
+ * // "projectSource": {},
1229
1350
  * // "putMetadata": {},
1230
1351
  * // "putObjectHold": {},
1231
1352
  * // "rewriteObject": {},
1232
1353
  * // "scheduleTime": "my_scheduleTime",
1354
+ * // "setObjectAcls": {},
1233
1355
  * // "state": "my_state",
1234
1356
  * // "updateObjectCustomContext": {}
1235
1357
  * // }
@@ -1293,8 +1415,7 @@ export namespace storagebatchoperations_v1 {
1293
1415
  | BodyResponseCallback<Schema$Operation>
1294
1416
  | BodyResponseCallback<Readable>,
1295
1417
  callback?:
1296
- | BodyResponseCallback<Schema$Operation>
1297
- | BodyResponseCallback<Readable>
1418
+ BodyResponseCallback<Schema$Operation> | BodyResponseCallback<Readable>
1298
1419
  ):
1299
1420
  | void
1300
1421
  | Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
@@ -1371,11 +1492,11 @@ export namespace storagebatchoperations_v1 {
1371
1492
  *
1372
1493
  * // Do the magic
1373
1494
  * const res = await storagebatchoperations.projects.locations.jobs.delete({
1374
- * // Optional. If set to true, any child bucket operations of the job will also be deleted. Highly recommended to be set to true by all clients. Users cannot mutate bucket operations directly, so only the jobs.delete permission is required to delete a job (and its child bucket operations).
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).
1375
1496
  * force: 'placeholder-value',
1376
- * // 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\}`.
1377
1498
  * name: 'projects/my-project/locations/my-location/jobs/my-job',
1378
- * // 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).
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).
1379
1500
  * requestId: 'placeholder-value',
1380
1501
  * });
1381
1502
  * console.log(res.data);
@@ -1430,8 +1551,7 @@ export namespace storagebatchoperations_v1 {
1430
1551
  | BodyResponseCallback<Schema$Empty>
1431
1552
  | BodyResponseCallback<Readable>,
1432
1553
  callback?:
1433
- | BodyResponseCallback<Schema$Empty>
1434
- | BodyResponseCallback<Readable>
1554
+ BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
1435
1555
  ):
1436
1556
  | void
1437
1557
  | Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
@@ -1508,7 +1628,7 @@ export namespace storagebatchoperations_v1 {
1508
1628
  *
1509
1629
  * // Do the magic
1510
1630
  * const res = await storagebatchoperations.projects.locations.jobs.get({
1511
- * // 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\}`.
1512
1632
  * name: 'projects/my-project/locations/my-location/jobs/my-job',
1513
1633
  * });
1514
1634
  * console.log(res.data);
@@ -1526,10 +1646,12 @@ export namespace storagebatchoperations_v1 {
1526
1646
  * // "isMultiBucketJob": false,
1527
1647
  * // "loggingConfig": {},
1528
1648
  * // "name": "my_name",
1649
+ * // "projectSource": {},
1529
1650
  * // "putMetadata": {},
1530
1651
  * // "putObjectHold": {},
1531
1652
  * // "rewriteObject": {},
1532
1653
  * // "scheduleTime": "my_scheduleTime",
1654
+ * // "setObjectAcls": {},
1533
1655
  * // "state": "my_state",
1534
1656
  * // "updateObjectCustomContext": {}
1535
1657
  * // }
@@ -1581,8 +1703,7 @@ export namespace storagebatchoperations_v1 {
1581
1703
  | BodyResponseCallback<Schema$Job>
1582
1704
  | BodyResponseCallback<Readable>,
1583
1705
  callback?:
1584
- | BodyResponseCallback<Schema$Job>
1585
- | BodyResponseCallback<Readable>
1706
+ BodyResponseCallback<Schema$Job> | BodyResponseCallback<Readable>
1586
1707
  ):
1587
1708
  | void
1588
1709
  | Promise<GaxiosResponseWithHTTP2<Schema$Job>>
@@ -1661,9 +1782,9 @@ export namespace storagebatchoperations_v1 {
1661
1782
  * const res = await storagebatchoperations.projects.locations.jobs.list({
1662
1783
  * // Optional. Filters results as defined by https://google.aip.dev/160.
1663
1784
  * filter: 'placeholder-value',
1664
- * // Optional. Field to sort by. Supported fields are name, create_time.
1785
+ * // Optional. Field to sort by. Supported fields are `name` and `create_time`.
1665
1786
  * orderBy: 'placeholder-value',
1666
- * // Optional. The list page size. default page size is 100.
1787
+ * // Optional. The list page size. The default page size is 100.
1667
1788
  * pageSize: 'placeholder-value',
1668
1789
  * // Optional. The list page token.
1669
1790
  * pageToken: 'placeholder-value',
@@ -1776,7 +1897,7 @@ export namespace storagebatchoperations_v1 {
1776
1897
 
1777
1898
  export interface Params$Resource$Projects$Locations$Jobs$Cancel extends StandardParameters {
1778
1899
  /**
1779
- * 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\}`.
1780
1901
  */
1781
1902
  name?: string;
1782
1903
 
@@ -1787,15 +1908,15 @@ export namespace storagebatchoperations_v1 {
1787
1908
  }
1788
1909
  export interface Params$Resource$Projects$Locations$Jobs$Create extends StandardParameters {
1789
1910
  /**
1790
- * 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.
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.
1791
1912
  */
1792
1913
  jobId?: string;
1793
1914
  /**
1794
- * Required. Value for parent.
1915
+ * Required. The value for parent.
1795
1916
  */
1796
1917
  parent?: string;
1797
1918
  /**
1798
- * 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).
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).
1799
1920
  */
1800
1921
  requestId?: string;
1801
1922
 
@@ -1806,21 +1927,21 @@ export namespace storagebatchoperations_v1 {
1806
1927
  }
1807
1928
  export interface Params$Resource$Projects$Locations$Jobs$Delete extends StandardParameters {
1808
1929
  /**
1809
- * Optional. If set to true, any child bucket operations of the job will also be deleted. Highly recommended to be set to true by all clients. Users cannot mutate bucket operations directly, so only the jobs.delete permission is required to delete a job (and its child bucket operations).
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).
1810
1931
  */
1811
1932
  force?: boolean;
1812
1933
  /**
1813
- * 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\}`.
1814
1935
  */
1815
1936
  name?: string;
1816
1937
  /**
1817
- * 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).
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).
1818
1939
  */
1819
1940
  requestId?: string;
1820
1941
  }
1821
1942
  export interface Params$Resource$Projects$Locations$Jobs$Get extends StandardParameters {
1822
1943
  /**
1823
- * 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\}`.
1824
1945
  */
1825
1946
  name?: string;
1826
1947
  }
@@ -1830,11 +1951,11 @@ export namespace storagebatchoperations_v1 {
1830
1951
  */
1831
1952
  filter?: string;
1832
1953
  /**
1833
- * Optional. Field to sort by. Supported fields are name, create_time.
1954
+ * Optional. Field to sort by. Supported fields are `name` and `create_time`.
1834
1955
  */
1835
1956
  orderBy?: string;
1836
1957
  /**
1837
- * Optional. The list page size. default page size is 100.
1958
+ * Optional. The list page size. The default page size is 100.
1838
1959
  */
1839
1960
  pageSize?: number;
1840
1961
  /**
@@ -1885,7 +2006,7 @@ export namespace storagebatchoperations_v1 {
1885
2006
  * // Do the magic
1886
2007
  * const res =
1887
2008
  * await storagebatchoperations.projects.locations.jobs.bucketOperations.get({
1888
- * // 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\}`.
1889
2010
  * name: 'projects/my-project/locations/my-location/jobs/my-job/bucketOperations/my-bucketOperation',
1890
2011
  * });
1891
2012
  * console.log(res.data);
@@ -1901,9 +2022,11 @@ export namespace storagebatchoperations_v1 {
1901
2022
  * // "manifest": {},
1902
2023
  * // "name": "my_name",
1903
2024
  * // "prefixList": {},
2025
+ * // "projectSource": {},
1904
2026
  * // "putMetadata": {},
1905
2027
  * // "putObjectHold": {},
1906
2028
  * // "rewriteObject": {},
2029
+ * // "setObjectAcls": {},
1907
2030
  * // "startTime": "my_startTime",
1908
2031
  * // "state": "my_state",
1909
2032
  * // "updateObjectCustomContext": {}
@@ -2038,13 +2161,13 @@ export namespace storagebatchoperations_v1 {
2038
2161
  * await storagebatchoperations.projects.locations.jobs.bucketOperations.list({
2039
2162
  * // Optional. Filters results as defined by https://google.aip.dev/160.
2040
2163
  * filter: 'placeholder-value',
2041
- * // Optional. Field to sort by. Supported fields are name, create_time.
2164
+ * // Optional. Field to sort by. Supported fields are `name` and `create_time`.
2042
2165
  * orderBy: 'placeholder-value',
2043
2166
  * // Optional. The list page size. Default page size is 100.
2044
2167
  * pageSize: 'placeholder-value',
2045
2168
  * // Optional. The list page token.
2046
2169
  * pageToken: 'placeholder-value',
2047
- * // Required. Format: projects/{project_id\}/locations/global/jobs/{job_id\}.
2170
+ * // Required. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
2048
2171
  * parent: 'projects/my-project/locations/my-location/jobs/my-job',
2049
2172
  * });
2050
2173
  * console.log(res.data);
@@ -2163,7 +2286,7 @@ export namespace storagebatchoperations_v1 {
2163
2286
 
2164
2287
  export interface Params$Resource$Projects$Locations$Jobs$Bucketoperations$Get extends StandardParameters {
2165
2288
  /**
2166
- * 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\}`.
2167
2290
  */
2168
2291
  name?: string;
2169
2292
  }
@@ -2173,7 +2296,7 @@ export namespace storagebatchoperations_v1 {
2173
2296
  */
2174
2297
  filter?: string;
2175
2298
  /**
2176
- * Optional. Field to sort by. Supported fields are name, create_time.
2299
+ * Optional. Field to sort by. Supported fields are `name` and `create_time`.
2177
2300
  */
2178
2301
  orderBy?: string;
2179
2302
  /**
@@ -2185,7 +2308,7 @@ export namespace storagebatchoperations_v1 {
2185
2308
  */
2186
2309
  pageToken?: string;
2187
2310
  /**
2188
- * Required. Format: projects/{project_id\}/locations/global/jobs/{job_id\}.
2311
+ * Required. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
2189
2312
  */
2190
2313
  parent?: string;
2191
2314
  }
@@ -2290,8 +2413,7 @@ export namespace storagebatchoperations_v1 {
2290
2413
  | BodyResponseCallback<Schema$Empty>
2291
2414
  | BodyResponseCallback<Readable>,
2292
2415
  callback?:
2293
- | BodyResponseCallback<Schema$Empty>
2294
- | BodyResponseCallback<Readable>
2416
+ BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
2295
2417
  ):
2296
2418
  | void
2297
2419
  | Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
@@ -2425,8 +2547,7 @@ export namespace storagebatchoperations_v1 {
2425
2547
  | BodyResponseCallback<Schema$Empty>
2426
2548
  | BodyResponseCallback<Readable>,
2427
2549
  callback?:
2428
- | BodyResponseCallback<Schema$Empty>
2429
- | BodyResponseCallback<Readable>
2550
+ BodyResponseCallback<Schema$Empty> | BodyResponseCallback<Readable>
2430
2551
  ):
2431
2552
  | void
2432
2553
  | Promise<GaxiosResponseWithHTTP2<Schema$Empty>>
@@ -2564,8 +2685,7 @@ export namespace storagebatchoperations_v1 {
2564
2685
  | BodyResponseCallback<Schema$Operation>
2565
2686
  | BodyResponseCallback<Readable>,
2566
2687
  callback?:
2567
- | BodyResponseCallback<Schema$Operation>
2568
- | BodyResponseCallback<Readable>
2688
+ BodyResponseCallback<Schema$Operation> | BodyResponseCallback<Readable>
2569
2689
  ):
2570
2690
  | void
2571
2691
  | Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
@@ -2691,8 +2811,7 @@ export namespace storagebatchoperations_v1 {
2691
2811
  list(
2692
2812
  params: Params$Resource$Projects$Locations$Operations$List,
2693
2813
  options:
2694
- | MethodOptions
2695
- | BodyResponseCallback<Schema$ListOperationsResponse>,
2814
+ MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>,
2696
2815
  callback: BodyResponseCallback<Schema$ListOperationsResponse>
2697
2816
  ): void;
2698
2817
  list(