@googleapis/storagebatchoperations 8.3.0 → 12.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/build/v1.d.ts CHANGED
@@ -70,6 +70,19 @@ export declare namespace storagebatchoperations_v1 {
70
70
  projects: Resource$Projects;
71
71
  constructor(options: GlobalOptions, google?: GoogleConfigurable);
72
72
  }
73
+ /**
74
+ * Represents updates to existing access-control entries on an object.
75
+ */
76
+ export interface Schema$AccessControlsUpdates {
77
+ /**
78
+ * Optional. Grants to add or update. If a grant for same entity exists, its role is updated.
79
+ */
80
+ grants?: Schema$ObjectAccessControl[];
81
+ /**
82
+ * Optional. Entities for which all grants should be removed. An entity can't be in both `grants` and `remove_entities`.
83
+ */
84
+ removeEntities?: string[] | null;
85
+ }
73
86
  /**
74
87
  * Describes configuration of a single bucket and its objects to be transformed.
75
88
  */
@@ -92,7 +105,7 @@ export declare namespace storagebatchoperations_v1 {
92
105
  */
93
106
  export interface Schema$BucketList {
94
107
  /**
95
- * 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.
108
+ * 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.
96
109
  */
97
110
  buckets?: Schema$Bucket[];
98
111
  }
@@ -129,13 +142,17 @@ export declare namespace storagebatchoperations_v1 {
129
142
  */
130
143
  manifest?: Schema$Manifest;
131
144
  /**
132
- * Identifier. The resource name of the BucketOperation. This is defined by the service. Format: projects/{project\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation\}.
145
+ * 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\}`.
133
146
  */
134
147
  name?: string | null;
135
148
  /**
136
149
  * Specifies objects matching a prefix set.
137
150
  */
138
151
  prefixList?: Schema$PrefixList;
152
+ /**
153
+ * Specifies objects matching the object filters in a project source.
154
+ */
155
+ projectSource?: Schema$ProjectSource;
139
156
  /**
140
157
  * 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.
141
158
  */
@@ -148,6 +165,10 @@ export declare namespace storagebatchoperations_v1 {
148
165
  * Rewrite the object and updates metadata like KMS key.
149
166
  */
150
167
  rewriteObject?: Schema$RewriteObject;
168
+ /**
169
+ * Updates object ACLs.
170
+ */
171
+ setObjectAcls?: Schema$SetObjectAcls;
151
172
  /**
152
173
  * Output only. The time that the BucketOperation was started.
153
174
  */
@@ -166,7 +187,7 @@ export declare namespace storagebatchoperations_v1 {
166
187
  */
167
188
  export interface Schema$CancelJobRequest {
168
189
  /**
169
- * 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).
190
+ * 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).
170
191
  */
171
192
  requestId?: string | null;
172
193
  }
@@ -222,7 +243,7 @@ export declare namespace storagebatchoperations_v1 {
222
243
  */
223
244
  export interface Schema$CustomContextUpdates {
224
245
  /**
225
- * Optional. Custom contexts to clear by key. A key cannot be present in both `updates` and `keys_to_clear`.
246
+ * Optional. Custom contexts to clear by key. A key can't be present in both `updates` and `keys_to_clear`.
226
247
  */
227
248
  keysToClear?: string[] | null;
228
249
  /**
@@ -237,7 +258,7 @@ export declare namespace storagebatchoperations_v1 {
237
258
  */
238
259
  export interface Schema$DeleteObject {
239
260
  /**
240
- * 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.
261
+ * 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.
241
262
  */
242
263
  permanentObjectDeletionEnabled?: boolean | null;
243
264
  }
@@ -277,7 +298,28 @@ export declare namespace storagebatchoperations_v1 {
277
298
  errorLogEntries?: Schema$ErrorLogEntry[];
278
299
  }
279
300
  /**
280
- * The Storage Batch Operations Job description.
301
+ * 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.
302
+ */
303
+ export interface Schema$Expr {
304
+ /**
305
+ * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
306
+ */
307
+ description?: string | null;
308
+ /**
309
+ * Textual representation of an expression in Common Expression Language syntax.
310
+ */
311
+ expression?: string | null;
312
+ /**
313
+ * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
314
+ */
315
+ location?: string | null;
316
+ /**
317
+ * 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.
318
+ */
319
+ title?: string | null;
320
+ }
321
+ /**
322
+ * The storage batch operations job description.
281
323
  */
282
324
  export interface Schema$Job {
283
325
  /**
@@ -301,11 +343,11 @@ export declare namespace storagebatchoperations_v1 {
301
343
  */
302
344
  deleteObject?: Schema$DeleteObject;
303
345
  /**
304
- * Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
346
+ * Optional. A user-provided description for the job. Maximum length: 1024 bytes when unicode-encoded.
305
347
  */
306
348
  description?: string | null;
307
349
  /**
308
- * 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.
350
+ * 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.
309
351
  */
310
352
  dryRun?: boolean | null;
311
353
  /**
@@ -313,7 +355,7 @@ export declare namespace storagebatchoperations_v1 {
313
355
  */
314
356
  errorSummaries?: Schema$ErrorSummary[];
315
357
  /**
316
- * Output only. If true, this Job operates on multiple buckets. Multibucket jobs are subject to different quota limits than single-bucket jobs.
358
+ * Output only. If true, this job operates on multiple buckets. Multi-bucket jobs are subject to different quota limits than single-bucket jobs.
317
359
  */
318
360
  isMultiBucketJob?: boolean | null;
319
361
  /**
@@ -321,11 +363,15 @@ export declare namespace storagebatchoperations_v1 {
321
363
  */
322
364
  loggingConfig?: Schema$LoggingConfig;
323
365
  /**
324
- * 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".
366
+ * 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.
325
367
  */
326
368
  name?: string | null;
327
369
  /**
328
- * 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.
370
+ * Specifies a project source and filters to identify objects to be transformed.
371
+ */
372
+ projectSource?: Schema$ProjectSource;
373
+ /**
374
+ * 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`.
329
375
  */
330
376
  putMetadata?: Schema$PutMetadata;
331
377
  /**
@@ -340,6 +386,10 @@ export declare namespace storagebatchoperations_v1 {
340
386
  * Output only. The time that the job was scheduled.
341
387
  */
342
388
  scheduleTime?: string | null;
389
+ /**
390
+ * Updates object ACLs.
391
+ */
392
+ setObjectAcls?: Schema$SetObjectAcls;
343
393
  /**
344
394
  * Output only. State of the job.
345
395
  */
@@ -460,16 +510,29 @@ export declare namespace storagebatchoperations_v1 {
460
510
  */
461
511
  export interface Schema$Manifest {
462
512
  /**
463
- * 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.
513
+ * 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.
464
514
  */
465
515
  manifestLocation?: string | null;
466
516
  }
467
517
  /**
468
- * Describes the payload of a user defined object custom context.
518
+ * Represents an access control entry on an object.
519
+ */
520
+ export interface Schema$ObjectAccessControl {
521
+ /**
522
+ * Required. The entity holding the permission, in one of the following forms: * `allUsers` * `allAuthenticatedUsers`
523
+ */
524
+ entity?: string | null;
525
+ /**
526
+ * Required. The role to grant. Acceptable values are: * `READER` - gives read access to the object. * `OWNER` - gives owner access to the object.
527
+ */
528
+ role?: string | null;
529
+ }
530
+ /**
531
+ * Describes the payload of a user-defined object custom context.
469
532
  */
470
533
  export interface Schema$ObjectCustomContextPayload {
471
534
  /**
472
- * 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.
535
+ * 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.
473
536
  */
474
537
  value?: string | null;
475
538
  }
@@ -478,11 +541,11 @@ export declare namespace storagebatchoperations_v1 {
478
541
  */
479
542
  export interface Schema$ObjectRetention {
480
543
  /**
481
- * 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'.
544
+ * 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.
482
545
  */
483
546
  retainUntilTime?: string | null;
484
547
  /**
485
- * Required. The retention mode of the object.
548
+ * Required. The retention mode.
486
549
  */
487
550
  retentionMode?: string | null;
488
551
  }
@@ -536,7 +599,7 @@ export declare namespace storagebatchoperations_v1 {
536
599
  */
537
600
  job?: Schema$Job;
538
601
  /**
539
- * Output only. The unique operation resource name. Format: projects/{project\}/locations/global/operations/{operation\}.
602
+ * Output only. The unique operation resource name. Format: projects/{project_id\}/locations/global/operations/{operation\}.
540
603
  */
541
604
  operation?: string | null;
542
605
  /**
@@ -549,46 +612,79 @@ export declare namespace storagebatchoperations_v1 {
549
612
  */
550
613
  export interface Schema$PrefixList {
551
614
  /**
552
- * 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.
615
+ * 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, `''`
553
616
  */
554
617
  includedObjectPrefixes?: string[] | null;
555
618
  }
619
+ /**
620
+ * Describes the project source where the objects satisfying the filters will be transformed.
621
+ */
622
+ export interface Schema$ProjectSource {
623
+ /**
624
+ * Optional. Filters expressed in Common Expression Language (CEL) to apply to buckets to identify buckets with objects to be transformed.
625
+ */
626
+ bucketFilters?: Schema$Expr;
627
+ /**
628
+ * 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\}`.
629
+ */
630
+ dryRunJobId?: string | null;
631
+ /**
632
+ * 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\}`.
633
+ */
634
+ insightsDatasetConfig?: string | null;
635
+ /**
636
+ * Optional. Filters expressed in Common Expression Language (CEL) to apply to objects to identify objects to be transformed.
637
+ */
638
+ objectFilters?: Schema$Expr;
639
+ /**
640
+ * Required. Project name of the objects to be transformed. e.g. projects/my-project or projects/123456.
641
+ */
642
+ project?: string | null;
643
+ /**
644
+ * 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.
645
+ */
646
+ snapshotTime?: string | null;
647
+ /**
648
+ * 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`.
649
+ */
650
+ targetLocations?: Schema$TargetLocations;
651
+ }
556
652
  /**
557
653
  * Describes options for object metadata update.
558
654
  */
559
655
  export interface Schema$PutMetadata {
560
656
  /**
561
- * 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.
657
+ * 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).
562
658
  */
563
659
  cacheControl?: string | null;
564
660
  /**
565
- * 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.
661
+ * 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).
566
662
  */
567
663
  contentDisposition?: string | null;
568
664
  /**
569
- * 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.
665
+ * 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).
570
666
  */
571
667
  contentEncoding?: string | null;
572
668
  /**
573
- * 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.
669
+ * 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).
574
670
  */
575
671
  contentLanguage?: string | null;
576
672
  /**
577
- * 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
673
+ * 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).
578
674
  */
579
675
  contentType?: string | null;
580
676
  /**
581
- * 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
677
+ * 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).
582
678
  */
583
679
  customMetadata?: {
584
680
  [key: string]: string;
585
681
  } | null;
586
682
  /**
587
- * 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.
683
+ * 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).
588
684
  */
589
685
  customTime?: string | null;
590
686
  /**
591
- * 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
687
+ * 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).
592
688
  */
593
689
  objectRetention?: Schema$ObjectRetention;
594
690
  }
@@ -597,11 +693,11 @@ export declare namespace storagebatchoperations_v1 {
597
693
  */
598
694
  export interface Schema$PutObjectHold {
599
695
  /**
600
- * 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.
696
+ * 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.
601
697
  */
602
698
  eventBasedHold?: string | null;
603
699
  /**
604
- * Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.
700
+ * Required. Updates object temporary holds state. When object temporary hold is set, object can't be deleted or replaced.
605
701
  */
606
702
  temporaryHold?: string | null;
607
703
  }
@@ -610,9 +706,22 @@ export declare namespace storagebatchoperations_v1 {
610
706
  */
611
707
  export interface Schema$RewriteObject {
612
708
  /**
613
- * 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.
709
+ * 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.
614
710
  */
615
711
  kmsKey?: string | null;
712
+ /**
713
+ * 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.
714
+ */
715
+ storageClass?: string | null;
716
+ }
717
+ /**
718
+ * Describes options for setting object ACLs.
719
+ */
720
+ export interface Schema$SetObjectAcls {
721
+ /**
722
+ * Required. Add, update, or remove grants from the object's existing ACLs.
723
+ */
724
+ accessControlsUpdates?: Schema$AccessControlsUpdates;
616
725
  }
617
726
  /**
618
727
  * 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).
@@ -633,12 +742,25 @@ export declare namespace storagebatchoperations_v1 {
633
742
  */
634
743
  message?: string | null;
635
744
  }
745
+ /**
746
+ * Describes the Cloud Storage locations to include in a ProjectSource job.
747
+ */
748
+ export interface Schema$TargetLocations {
749
+ /**
750
+ * 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
751
+ */
752
+ locations?: string[] | null;
753
+ /**
754
+ * 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.
755
+ */
756
+ snapshotTime?: string | null;
757
+ }
636
758
  /**
637
759
  * Describes options to update object custom contexts.
638
760
  */
639
761
  export interface Schema$UpdateObjectCustomContext {
640
762
  /**
641
- * If set, must be set to true and all existing object custom contexts will be deleted.
763
+ * If set, must be set to true and all existing object custom contexts are deleted.
642
764
  */
643
765
  clearAll?: boolean | null;
644
766
  /**
@@ -853,7 +975,7 @@ export declare namespace storagebatchoperations_v1 {
853
975
  *
854
976
  * // Do the magic
855
977
  * const res = await storagebatchoperations.projects.locations.jobs.cancel({
856
- * // Required. The `name` of the job to cancel. Format: projects/{project_id\}/locations/global/jobs/{job_id\}.
978
+ * // Required. The `name` of the job to cancel. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
857
979
  * name: 'projects/my-project/locations/my-location/jobs/my-job',
858
980
  *
859
981
  * // Request body metadata
@@ -919,11 +1041,11 @@ export declare namespace storagebatchoperations_v1 {
919
1041
  *
920
1042
  * // Do the magic
921
1043
  * const res = await storagebatchoperations.projects.locations.jobs.create({
922
- * // 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.
1044
+ * // 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.
923
1045
  * jobId: 'placeholder-value',
924
- * // Required. Value for parent.
1046
+ * // Required. The value for parent.
925
1047
  * parent: 'projects/my-project/locations/my-location',
926
- * // 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).
1048
+ * // 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).
927
1049
  * requestId: 'placeholder-value',
928
1050
  *
929
1051
  * // Request body metadata
@@ -941,10 +1063,12 @@ export declare namespace storagebatchoperations_v1 {
941
1063
  * // "isMultiBucketJob": false,
942
1064
  * // "loggingConfig": {},
943
1065
  * // "name": "my_name",
1066
+ * // "projectSource": {},
944
1067
  * // "putMetadata": {},
945
1068
  * // "putObjectHold": {},
946
1069
  * // "rewriteObject": {},
947
1070
  * // "scheduleTime": "my_scheduleTime",
1071
+ * // "setObjectAcls": {},
948
1072
  * // "state": "my_state",
949
1073
  * // "updateObjectCustomContext": {}
950
1074
  * // }
@@ -1011,11 +1135,11 @@ export declare namespace storagebatchoperations_v1 {
1011
1135
  *
1012
1136
  * // Do the magic
1013
1137
  * const res = await storagebatchoperations.projects.locations.jobs.delete({
1014
- * // 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).
1138
+ * // 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).
1015
1139
  * force: 'placeholder-value',
1016
- * // Required. The `name` of the job to delete. Format: projects/{project_id\}/locations/global/jobs/{job_id\} .
1140
+ * // Required. The `name` of the job to delete. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
1017
1141
  * name: 'projects/my-project/locations/my-location/jobs/my-job',
1018
- * // 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).
1142
+ * // 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).
1019
1143
  * requestId: 'placeholder-value',
1020
1144
  * });
1021
1145
  * console.log(res.data);
@@ -1073,7 +1197,7 @@ export declare namespace storagebatchoperations_v1 {
1073
1197
  *
1074
1198
  * // Do the magic
1075
1199
  * const res = await storagebatchoperations.projects.locations.jobs.get({
1076
- * // Required. `name` of the job to retrieve. Format: projects/{project_id\}/locations/global/jobs/{job_id\} .
1200
+ * // Required. The `name` of the job to retrieve. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
1077
1201
  * name: 'projects/my-project/locations/my-location/jobs/my-job',
1078
1202
  * });
1079
1203
  * console.log(res.data);
@@ -1091,10 +1215,12 @@ export declare namespace storagebatchoperations_v1 {
1091
1215
  * // "isMultiBucketJob": false,
1092
1216
  * // "loggingConfig": {},
1093
1217
  * // "name": "my_name",
1218
+ * // "projectSource": {},
1094
1219
  * // "putMetadata": {},
1095
1220
  * // "putObjectHold": {},
1096
1221
  * // "rewriteObject": {},
1097
1222
  * // "scheduleTime": "my_scheduleTime",
1223
+ * // "setObjectAcls": {},
1098
1224
  * // "state": "my_state",
1099
1225
  * // "updateObjectCustomContext": {}
1100
1226
  * // }
@@ -1151,9 +1277,9 @@ export declare namespace storagebatchoperations_v1 {
1151
1277
  * const res = await storagebatchoperations.projects.locations.jobs.list({
1152
1278
  * // Optional. Filters results as defined by https://google.aip.dev/160.
1153
1279
  * filter: 'placeholder-value',
1154
- * // Optional. Field to sort by. Supported fields are name, create_time.
1280
+ * // Optional. Field to sort by. Supported fields are `name` and `create_time`.
1155
1281
  * orderBy: 'placeholder-value',
1156
- * // Optional. The list page size. default page size is 100.
1282
+ * // Optional. The list page size. The default page size is 100.
1157
1283
  * pageSize: 'placeholder-value',
1158
1284
  * // Optional. The list page token.
1159
1285
  * pageToken: 'placeholder-value',
@@ -1191,7 +1317,7 @@ export declare namespace storagebatchoperations_v1 {
1191
1317
  }
1192
1318
  export interface Params$Resource$Projects$Locations$Jobs$Cancel extends StandardParameters {
1193
1319
  /**
1194
- * Required. The `name` of the job to cancel. Format: projects/{project_id\}/locations/global/jobs/{job_id\}.
1320
+ * Required. The `name` of the job to cancel. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
1195
1321
  */
1196
1322
  name?: string;
1197
1323
  /**
@@ -1201,15 +1327,15 @@ export declare namespace storagebatchoperations_v1 {
1201
1327
  }
1202
1328
  export interface Params$Resource$Projects$Locations$Jobs$Create extends StandardParameters {
1203
1329
  /**
1204
- * 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.
1330
+ * 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.
1205
1331
  */
1206
1332
  jobId?: string;
1207
1333
  /**
1208
- * Required. Value for parent.
1334
+ * Required. The value for parent.
1209
1335
  */
1210
1336
  parent?: string;
1211
1337
  /**
1212
- * 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).
1338
+ * 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).
1213
1339
  */
1214
1340
  requestId?: string;
1215
1341
  /**
@@ -1219,21 +1345,21 @@ export declare namespace storagebatchoperations_v1 {
1219
1345
  }
1220
1346
  export interface Params$Resource$Projects$Locations$Jobs$Delete extends StandardParameters {
1221
1347
  /**
1222
- * 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).
1348
+ * 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).
1223
1349
  */
1224
1350
  force?: boolean;
1225
1351
  /**
1226
- * Required. The `name` of the job to delete. Format: projects/{project_id\}/locations/global/jobs/{job_id\} .
1352
+ * Required. The `name` of the job to delete. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
1227
1353
  */
1228
1354
  name?: string;
1229
1355
  /**
1230
- * 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).
1356
+ * 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).
1231
1357
  */
1232
1358
  requestId?: string;
1233
1359
  }
1234
1360
  export interface Params$Resource$Projects$Locations$Jobs$Get extends StandardParameters {
1235
1361
  /**
1236
- * Required. `name` of the job to retrieve. Format: projects/{project_id\}/locations/global/jobs/{job_id\} .
1362
+ * Required. The `name` of the job to retrieve. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
1237
1363
  */
1238
1364
  name?: string;
1239
1365
  }
@@ -1243,11 +1369,11 @@ export declare namespace storagebatchoperations_v1 {
1243
1369
  */
1244
1370
  filter?: string;
1245
1371
  /**
1246
- * Optional. Field to sort by. Supported fields are name, create_time.
1372
+ * Optional. Field to sort by. Supported fields are `name` and `create_time`.
1247
1373
  */
1248
1374
  orderBy?: string;
1249
1375
  /**
1250
- * Optional. The list page size. default page size is 100.
1376
+ * Optional. The list page size. The default page size is 100.
1251
1377
  */
1252
1378
  pageSize?: number;
1253
1379
  /**
@@ -1294,7 +1420,7 @@ export declare namespace storagebatchoperations_v1 {
1294
1420
  * // Do the magic
1295
1421
  * const res =
1296
1422
  * await storagebatchoperations.projects.locations.jobs.bucketOperations.get({
1297
- * // Required. `name` of the bucket operation to retrieve. Format: projects/{project_id\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation_id\}.
1423
+ * // Required. The `name` of the bucket operation to retrieve. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation_id\}`.
1298
1424
  * name: 'projects/my-project/locations/my-location/jobs/my-job/bucketOperations/my-bucketOperation',
1299
1425
  * });
1300
1426
  * console.log(res.data);
@@ -1310,9 +1436,11 @@ export declare namespace storagebatchoperations_v1 {
1310
1436
  * // "manifest": {},
1311
1437
  * // "name": "my_name",
1312
1438
  * // "prefixList": {},
1439
+ * // "projectSource": {},
1313
1440
  * // "putMetadata": {},
1314
1441
  * // "putObjectHold": {},
1315
1442
  * // "rewriteObject": {},
1443
+ * // "setObjectAcls": {},
1316
1444
  * // "startTime": "my_startTime",
1317
1445
  * // "state": "my_state",
1318
1446
  * // "updateObjectCustomContext": {}
@@ -1371,13 +1499,13 @@ export declare namespace storagebatchoperations_v1 {
1371
1499
  * await storagebatchoperations.projects.locations.jobs.bucketOperations.list({
1372
1500
  * // Optional. Filters results as defined by https://google.aip.dev/160.
1373
1501
  * filter: 'placeholder-value',
1374
- * // Optional. Field to sort by. Supported fields are name, create_time.
1502
+ * // Optional. Field to sort by. Supported fields are `name` and `create_time`.
1375
1503
  * orderBy: 'placeholder-value',
1376
1504
  * // Optional. The list page size. Default page size is 100.
1377
1505
  * pageSize: 'placeholder-value',
1378
1506
  * // Optional. The list page token.
1379
1507
  * pageToken: 'placeholder-value',
1380
- * // Required. Format: projects/{project_id\}/locations/global/jobs/{job_id\}.
1508
+ * // Required. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
1381
1509
  * parent: 'projects/my-project/locations/my-location/jobs/my-job',
1382
1510
  * });
1383
1511
  * console.log(res.data);
@@ -1411,7 +1539,7 @@ export declare namespace storagebatchoperations_v1 {
1411
1539
  }
1412
1540
  export interface Params$Resource$Projects$Locations$Jobs$Bucketoperations$Get extends StandardParameters {
1413
1541
  /**
1414
- * Required. `name` of the bucket operation to retrieve. Format: projects/{project_id\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation_id\}.
1542
+ * Required. The `name` of the bucket operation to retrieve. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}/bucketOperations/{bucket_operation_id\}`.
1415
1543
  */
1416
1544
  name?: string;
1417
1545
  }
@@ -1421,7 +1549,7 @@ export declare namespace storagebatchoperations_v1 {
1421
1549
  */
1422
1550
  filter?: string;
1423
1551
  /**
1424
- * Optional. Field to sort by. Supported fields are name, create_time.
1552
+ * Optional. Field to sort by. Supported fields are `name` and `create_time`.
1425
1553
  */
1426
1554
  orderBy?: string;
1427
1555
  /**
@@ -1433,7 +1561,7 @@ export declare namespace storagebatchoperations_v1 {
1433
1561
  */
1434
1562
  pageToken?: string;
1435
1563
  /**
1436
- * Required. Format: projects/{project_id\}/locations/global/jobs/{job_id\}.
1564
+ * Required. Format: `projects/{project_id\}/locations/global/jobs/{job_id\}`.
1437
1565
  */
1438
1566
  parent?: string;
1439
1567
  }