// 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.

// 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

// 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.