feat: add QUEUED state to Storage Batch Operations API

Google APIs · copybara-github · commit fb371addb34b · 2026-02-12T10:40:46.000-08:00
feat: add bucket operations
feat: add `is_multi_bucket_job` output field added to StorageBatchOperations Job

PiperOrigin-RevId: 869283881
diff --git a/google/cloud/storagebatchoperations/v1/storage_batch_operations.proto b/google/cloud/storagebatchoperations/v1/storage_batch_operations.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -88,6 +88,23 @@ service StorageBatchOperations {
     };
     option (google.api.method_signature) = "name";
   }
+
+  // Lists BucketOperations in a given project and job.
+  rpc ListBucketOperations(ListBucketOperationsRequest)
+      returns (ListBucketOperationsResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=projects/*/locations/*/jobs/*}/bucketOperations"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Gets a BucketOperation.
+  rpc GetBucketOperation(GetBucketOperationRequest) returns (BucketOperation) {
+    option (google.api.http) = {
+      get: "/v1/{name=projects/*/locations/*/jobs/*/bucketOperations/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
 }
 
 // Message for request to list Jobs
@@ -209,11 +226,65 @@ message DeleteJobRequest {
     (google.api.field_info).format = UUID4,
     (google.api.field_behavior) = OPTIONAL
   ];
+
+  // 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).
+  bool force = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Message for response to cancel Job.
 message CancelJobResponse {}
 
+// Message for request to list BucketOperations
+message ListBucketOperationsRequest {
+  // Required. Format: projects/{project_id}/locations/global/jobs/{job_id}.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "storagebatchoperations.googleapis.com/BucketOperation"
+    }
+  ];
+
+  // Optional. Filters results as defined by https://google.aip.dev/160.
+  string filter = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The list page size. Default page size is 100.
+  int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The list page token.
+  string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Field to sort by. Supported fields are name, create_time.
+  string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for response to listing BucketOperations
+message ListBucketOperationsResponse {
+  // A list of storage batch bucket operations.
+  repeated BucketOperation bucket_operations = 1;
+
+  // A token identifying a page of results.
+  string next_page_token = 2;
+
+  // Locations that could not be reached.
+  repeated string unreachable = 3;
+}
+
+// Message for getting a BucketOperation.
+message GetBucketOperationRequest {
+  // Required. `name` of the bucket operation to retrieve.
+  // Format:
+  // projects/{project_id}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation_id}.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "storagebatchoperations.googleapis.com/BucketOperation"
+    }
+  ];
+}
+
 // Represents the metadata of the long-running operation.
 message OperationMetadata {
   // Output only. The unique operation resource name.
diff --git a/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.proto b/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -58,6 +58,9 @@ message Job {
 
     // Terminated due to an unrecoverable failure.
     FAILED = 4;
+
+    // Queued but not yet started.
+    QUEUED = 5;
   }
 
   // Identifier. The resource name of the Job. job_id is unique
@@ -123,6 +126,97 @@ message Job {
   // object count and, if the object configuration is a prefix list, the bytes
   // found from source. No transformations will be performed.
   bool dry_run = 22 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. If true, this Job operates on multiple buckets. Multibucket
+  // jobs are subject to different quota limits than single-bucket jobs.
+  bool is_multi_bucket_job = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// BucketOperation represents a bucket-level breakdown of a Job.
+message BucketOperation {
+  option (google.api.resource) = {
+    type: "storagebatchoperations.googleapis.com/BucketOperation"
+    pattern: "projects/{project}/locations/{location}/jobs/{job}/bucketOperations/{bucket_operation}"
+    plural: "bucketoperations"
+    singular: "bucketOperation"
+  };
+
+  // Describes state of the BucketOperation.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // Created but not yet started.
+    QUEUED = 1;
+
+    // In progress.
+    RUNNING = 2;
+
+    // Completed successfully.
+    SUCCEEDED = 3;
+
+    // Cancelled by the user.
+    CANCELED = 4;
+
+    // Terminated due to an unrecoverable failure.
+    FAILED = 5;
+  }
+
+  // Identifier. The resource name of the BucketOperation. This is defined by
+  // the service. Format:
+  // projects/{project}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation}.
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // The bucket name of the objects to be transformed in the BucketOperation.
+  string bucket_name = 2;
+
+  // Specifies objects to be transformed in the BucketOperation.
+  oneof object_configuration {
+    // Specifies objects matching a prefix set.
+    PrefixList prefix_list = 3;
+
+    // Specifies objects in a manifest file.
+    Manifest manifest = 4;
+  }
+
+  // Action to be performed on the objects.
+  oneof transformation {
+    // Changes object hold status.
+    PutObjectHold put_object_hold = 11;
+
+    // Delete objects.
+    DeleteObject delete_object = 12;
+
+    // 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.
+    PutMetadata put_metadata = 13;
+
+    // Rewrite the object and updates metadata like KMS key.
+    RewriteObject rewrite_object = 14;
+  }
+
+  // Output only. The time that the BucketOperation was created.
+  google.protobuf.Timestamp create_time = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The time that the BucketOperation was started.
+  google.protobuf.Timestamp start_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The time that the BucketOperation was completed.
+  google.protobuf.Timestamp complete_time = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Information about the progress of the bucket operation.
+  Counters counters = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Summarizes errors encountered with sample error log entries.
+  repeated ErrorSummary error_summaries = 9
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. State of the BucketOperation.
+  State state = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // Describes list of buckets and their objects to be transformed.
