diff --git a/api_names_out.yaml b/api_names_out.yaml index ed141701b23..29e7edb8453 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -377064,6 +377064,22 @@ "/storagebatchoperations:v1/BucketList": bucket_list "/storagebatchoperations:v1/BucketList/buckets": buckets "/storagebatchoperations:v1/BucketList/buckets/bucket": bucket +"/storagebatchoperations:v1/BucketOperation": bucket_operation +"/storagebatchoperations:v1/BucketOperation/bucketName": bucket_name +"/storagebatchoperations:v1/BucketOperation/completeTime": complete_time +"/storagebatchoperations:v1/BucketOperation/counters": counters +"/storagebatchoperations:v1/BucketOperation/createTime": create_time +"/storagebatchoperations:v1/BucketOperation/deleteObject": delete_object +"/storagebatchoperations:v1/BucketOperation/errorSummaries": error_summaries +"/storagebatchoperations:v1/BucketOperation/errorSummaries/error_summary": error_summary +"/storagebatchoperations:v1/BucketOperation/manifest": manifest +"/storagebatchoperations:v1/BucketOperation/name": name +"/storagebatchoperations:v1/BucketOperation/prefixList": prefix_list +"/storagebatchoperations:v1/BucketOperation/putMetadata": put_metadata +"/storagebatchoperations:v1/BucketOperation/putObjectHold": put_object_hold +"/storagebatchoperations:v1/BucketOperation/rewriteObject": rewrite_object +"/storagebatchoperations:v1/BucketOperation/startTime": start_time +"/storagebatchoperations:v1/BucketOperation/state": state "/storagebatchoperations:v1/CancelJobRequest": cancel_job_request "/storagebatchoperations:v1/CancelJobRequest/requestId": request_id "/storagebatchoperations:v1/CancelJobResponse": cancel_job_response @@ -377102,6 +377118,12 @@ "/storagebatchoperations:v1/Job/rewriteObject": rewrite_object "/storagebatchoperations:v1/Job/scheduleTime": schedule_time "/storagebatchoperations:v1/Job/state": state +"/storagebatchoperations:v1/ListBucketOperationsResponse": list_bucket_operations_response +"/storagebatchoperations:v1/ListBucketOperationsResponse/bucketOperations": bucket_operations +"/storagebatchoperations:v1/ListBucketOperationsResponse/bucketOperations/bucket_operation": bucket_operation +"/storagebatchoperations:v1/ListBucketOperationsResponse/nextPageToken": next_page_token +"/storagebatchoperations:v1/ListBucketOperationsResponse/unreachable": unreachable +"/storagebatchoperations:v1/ListBucketOperationsResponse/unreachable/unreachable": unreachable "/storagebatchoperations:v1/ListJobsResponse": list_jobs_response "/storagebatchoperations:v1/ListJobsResponse/jobs": jobs "/storagebatchoperations:v1/ListJobsResponse/jobs/job": job @@ -377180,6 +377202,14 @@ "/storagebatchoperations:v1/quotaUser": quota_user "/storagebatchoperations:v1/storagebatchoperations.projects.locations.get": get_project_location "/storagebatchoperations:v1/storagebatchoperations.projects.locations.get/name": name +"/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.bucketOperations.get": get_project_location_job_bucket_operation +"/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.bucketOperations.get/name": name +"/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.bucketOperations.list": list_project_location_job_bucket_operations +"/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.bucketOperations.list/filter": filter +"/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.bucketOperations.list/orderBy": order_by +"/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.bucketOperations.list/pageSize": page_size +"/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.bucketOperations.list/pageToken": page_token +"/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.bucketOperations.list/parent": parent "/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.cancel": cancel_job "/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.cancel/name": name "/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.create": create_project_location_job @@ -377187,6 +377217,7 @@ "/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.create/parent": parent "/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.create/requestId": request_id "/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.delete": delete_project_location_job +"/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.delete/force": force "/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.delete/name": name "/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.delete/requestId": request_id "/storagebatchoperations:v1/storagebatchoperations.projects.locations.jobs.get": get_project_location_job diff --git a/generated/google-apis-storagebatchoperations_v1/CHANGELOG.md b/generated/google-apis-storagebatchoperations_v1/CHANGELOG.md index 74cc7cea6cc..1299ab153a5 100644 --- a/generated/google-apis-storagebatchoperations_v1/CHANGELOG.md +++ b/generated/google-apis-storagebatchoperations_v1/CHANGELOG.md @@ -1,5 +1,9 @@ # Release history for google-apis-storagebatchoperations_v1 +### v0.11.0 (2026-01-25) + +* Regenerated from discovery document revision 20260119 + ### v0.10.0 (2025-12-14) * Regenerated from discovery document revision 20251203 diff --git a/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/classes.rb b/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/classes.rb index e5942fde8e4..8bcb5bbaf98 100644 --- a/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/classes.rb +++ b/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/classes.rb @@ -74,6 +74,105 @@ def update!(**args) end end + # BucketOperation represents a bucket-level breakdown of a Job. + class BucketOperation + include Google::Apis::Core::Hashable + + # The bucket name of the objects to be transformed in the BucketOperation. + # Corresponds to the JSON property `bucketName` + # @return [String] + attr_accessor :bucket_name + + # Output only. The time that the BucketOperation was completed. + # Corresponds to the JSON property `completeTime` + # @return [String] + attr_accessor :complete_time + + # Describes details about the progress of the job. + # Corresponds to the JSON property `counters` + # @return [Google::Apis::StoragebatchoperationsV1::Counters] + attr_accessor :counters + + # Output only. The time that the BucketOperation was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Describes options to delete an object. + # Corresponds to the JSON property `deleteObject` + # @return [Google::Apis::StoragebatchoperationsV1::DeleteObject] + attr_accessor :delete_object + + # Output only. Summarizes errors encountered with sample error log entries. + # Corresponds to the JSON property `errorSummaries` + # @return [Array] + attr_accessor :error_summaries + + # Describes list of objects to be transformed. + # Corresponds to the JSON property `manifest` + # @return [Google::Apis::StoragebatchoperationsV1::Manifest] + attr_accessor :manifest + + # Identifier. The resource name of the BucketOperation. This is defined by the + # service. Format: projects/`project`/locations/global/jobs/`job_id`/ + # bucketOperations/`bucket_operation`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Describes prefixes of objects to be transformed. + # Corresponds to the JSON property `prefixList` + # @return [Google::Apis::StoragebatchoperationsV1::PrefixList] + attr_accessor :prefix_list + + # Describes options for object metadata update. + # Corresponds to the JSON property `putMetadata` + # @return [Google::Apis::StoragebatchoperationsV1::PutMetadata] + attr_accessor :put_metadata + + # Describes options to update object hold. + # Corresponds to the JSON property `putObjectHold` + # @return [Google::Apis::StoragebatchoperationsV1::PutObjectHold] + attr_accessor :put_object_hold + + # Describes options for object rewrite. + # Corresponds to the JSON property `rewriteObject` + # @return [Google::Apis::StoragebatchoperationsV1::RewriteObject] + attr_accessor :rewrite_object + + # Output only. The time that the BucketOperation was started. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Output only. State of the BucketOperation. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bucket_name = args[:bucket_name] if args.key?(:bucket_name) + @complete_time = args[:complete_time] if args.key?(:complete_time) + @counters = args[:counters] if args.key?(:counters) + @create_time = args[:create_time] if args.key?(:create_time) + @delete_object = args[:delete_object] if args.key?(:delete_object) + @error_summaries = args[:error_summaries] if args.key?(:error_summaries) + @manifest = args[:manifest] if args.key?(:manifest) + @name = args[:name] if args.key?(:name) + @prefix_list = args[:prefix_list] if args.key?(:prefix_list) + @put_metadata = args[:put_metadata] if args.key?(:put_metadata) + @put_object_hold = args[:put_object_hold] if args.key?(:put_object_hold) + @rewrite_object = args[:rewrite_object] if args.key?(:rewrite_object) + @start_time = args[:start_time] if args.key?(:start_time) + @state = args[:state] if args.key?(:state) + end + end + # Message for Job to Cancel class CancelJobRequest include Google::Apis::Core::Hashable @@ -372,6 +471,37 @@ def update!(**args) end end + # Message for response to listing BucketOperations + class ListBucketOperationsResponse + include Google::Apis::Core::Hashable + + # A list of storage batch bucket operations. + # Corresponds to the JSON property `bucketOperations` + # @return [Array] + attr_accessor :bucket_operations + + # A token identifying a page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bucket_operations = args[:bucket_operations] if args.key?(:bucket_operations) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable = args[:unreachable] if args.key?(:unreachable) + end + end + # Message for response to listing Jobs class ListJobsResponse include Google::Apis::Core::Hashable diff --git a/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/gem_version.rb b/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/gem_version.rb index 6f35e25f41d..20152978c33 100644 --- a/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/gem_version.rb +++ b/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/gem_version.rb @@ -16,13 +16,13 @@ module Google module Apis module StoragebatchoperationsV1 # Version of the google-apis-storagebatchoperations_v1 gem - GEM_VERSION = "0.10.0" + GEM_VERSION = "0.11.0" # Version of the code generator used to generate this client GENERATOR_VERSION = "0.18.0" # Revision of the discovery document this client was generated from - REVISION = "20251203" + REVISION = "20260119" end end end diff --git a/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/representations.rb b/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/representations.rb index b2d48f5fe4a..3601b200eff 100644 --- a/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/representations.rb +++ b/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/representations.rb @@ -34,6 +34,12 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class BucketOperation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CancelJobRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,6 +94,12 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ListBucketOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListJobsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -191,6 +203,34 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class BucketOperation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bucket_name, as: 'bucketName' + property :complete_time, as: 'completeTime' + property :counters, as: 'counters', class: Google::Apis::StoragebatchoperationsV1::Counters, decorator: Google::Apis::StoragebatchoperationsV1::Counters::Representation + + property :create_time, as: 'createTime' + property :delete_object, as: 'deleteObject', class: Google::Apis::StoragebatchoperationsV1::DeleteObject, decorator: Google::Apis::StoragebatchoperationsV1::DeleteObject::Representation + + collection :error_summaries, as: 'errorSummaries', class: Google::Apis::StoragebatchoperationsV1::ErrorSummary, decorator: Google::Apis::StoragebatchoperationsV1::ErrorSummary::Representation + + property :manifest, as: 'manifest', class: Google::Apis::StoragebatchoperationsV1::Manifest, decorator: Google::Apis::StoragebatchoperationsV1::Manifest::Representation + + property :name, as: 'name' + property :prefix_list, as: 'prefixList', class: Google::Apis::StoragebatchoperationsV1::PrefixList, decorator: Google::Apis::StoragebatchoperationsV1::PrefixList::Representation + + property :put_metadata, as: 'putMetadata', class: Google::Apis::StoragebatchoperationsV1::PutMetadata, decorator: Google::Apis::StoragebatchoperationsV1::PutMetadata::Representation + + property :put_object_hold, as: 'putObjectHold', class: Google::Apis::StoragebatchoperationsV1::PutObjectHold, decorator: Google::Apis::StoragebatchoperationsV1::PutObjectHold::Representation + + property :rewrite_object, as: 'rewriteObject', class: Google::Apis::StoragebatchoperationsV1::RewriteObject, decorator: Google::Apis::StoragebatchoperationsV1::RewriteObject::Representation + + property :start_time, as: 'startTime' + property :state, as: 'state' + end + end + class CancelJobRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -280,6 +320,16 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class ListBucketOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :bucket_operations, as: 'bucketOperations', class: Google::Apis::StoragebatchoperationsV1::BucketOperation, decorator: Google::Apis::StoragebatchoperationsV1::BucketOperation::Representation + + property :next_page_token, as: 'nextPageToken' + collection :unreachable, as: 'unreachable' + end + end + class ListJobsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/service.rb b/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/service.rb index 828edc76364..5a1fd9ebf35 100644 --- a/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/service.rb +++ b/generated/google-apis-storagebatchoperations_v1/lib/google/apis/storagebatchoperations_v1/service.rb @@ -211,6 +211,11 @@ def create_project_location_job(parent, job_object = nil, job_id: nil, request_i # @param [String] name # Required. The `name` of the job to delete. Format: projects/`project_id`/ # locations/global/jobs/`job_id` . + # @param [Boolean] force + # 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). # @param [String] request_id # Optional. An optional request ID to identify requests. Specify a unique # request ID in case you need to retry your request. Requests with same ` @@ -234,11 +239,12 @@ def create_project_location_job(parent, job_object = nil, job_id: nil, request_i # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_location_job(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) + def delete_project_location_job(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::StoragebatchoperationsV1::Empty::Representation command.response_class = Google::Apis::StoragebatchoperationsV1::Empty command.params['name'] = name unless name.nil? + command.query['force'] = force unless force.nil? command.query['requestId'] = request_id unless request_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -318,6 +324,80 @@ def list_project_location_jobs(parent, filter: nil, order_by: nil, page_size: ni execute_or_queue_command(command, &block) end + # Gets a BucketOperation. + # @param [String] name + # Required. `name` of the bucket operation to retrieve. Format: projects/` + # project_id`/locations/global/jobs/`job_id`/bucketOperations/` + # bucket_operation_id`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::StoragebatchoperationsV1::BucketOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::StoragebatchoperationsV1::BucketOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_job_bucket_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::StoragebatchoperationsV1::BucketOperation::Representation + command.response_class = Google::Apis::StoragebatchoperationsV1::BucketOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists BucketOperations in a given project and job. + # @param [String] parent + # Required. Format: projects/`project_id`/locations/global/jobs/`job_id`. + # @param [String] filter + # Optional. Filters results as defined by https://google.aip.dev/160. + # @param [String] order_by + # Optional. Field to sort by. Supported fields are name, create_time. + # @param [Fixnum] page_size + # Optional. The list page size. Default page size is 100. + # @param [String] page_token + # Optional. The list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::StoragebatchoperationsV1::ListBucketOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::StoragebatchoperationsV1::ListBucketOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_job_bucket_operations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/bucketOperations', options) + command.response_representation = Google::Apis::StoragebatchoperationsV1::ListBucketOperationsResponse::Representation + command.response_class = Google::Apis::StoragebatchoperationsV1::ListBucketOperationsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Starts asynchronous cancellation on a long-running operation. The server makes # a best effort to cancel the operation, but success is not guaranteed. If the # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.