google-cloud-common 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 339e76c425a313d37895f5f6c1f36462a4c0f71bb0789612bcccddfad20c9d4d
-  data.tar.gz: 42a04815b4bf8373d3faf953c53af998de7d2b7e144f7db1e3ff8be208219872
+  metadata.gz: 5cb3e03094d8e9e61a90bacfa42f29a008daa3ff8e13fb1342e277e3b9f5201e
+  data.tar.gz: 99a04d140cbea9a4e38275fe12d0e16a0f219f554a1e9792e192860bbf31fb79
 SHA512:
-  metadata.gz: 2523d1a63522e84510c1ba01d87d3e35e91a056d7251b639b0c70a00d46b50fc55956f26f4c528f3783043d76387c0bc4eaac60b12c974f87833c5ba32c5e702
-  data.tar.gz: 7d62ae53be6239e956508599880225c2c91e5504ef57966a6af08c2af4cbfc292bb07cec03e1c293cff8dbaa5f03df727776df8721c9675db66afb9091b63aab
+  metadata.gz: 1a672ad75431d57c26143a8d777b609a4b2e014791ef0b3be4e533f19dc43979354bd89b1b0fb0e6c379dc9d20b391d77ec2bafaab32639fa3b995350e3c24d3
+  data.tar.gz: eb83b2e4c98a490457305113cd7f39c78c34dd629f593fdfc0373142bb596fe5a7b488c94c6e27925986511ed51a9582338dfd8bc186455c33202ac56c303224

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 1.2.0 (2023-08-07)
+
+#### Features
+
+* Updated generated protobuf output to use binary descriptors for better future compatibility ([#171](https://github.com/googleapis/common-protos-ruby/issues/171)) 
+
 ### 1.1.0 (2022-08-17)
 
 #### Features

data/lib/google/cloud/common/operation_metadata_pb.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/common/operation_metadata.proto
 
@@ -6,18 +7,32 @@ require 'google/protobuf'
 require 'google/api/field_behavior_pb'
 require 'google/protobuf/timestamp_pb'
 
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("google/cloud/common/operation_metadata.proto", :syntax => :proto3) do
-    add_message "google.cloud.common.OperationMetadata" do
-      optional :create_time, :message, 1, "google.protobuf.Timestamp"
-      optional :end_time, :message, 2, "google.protobuf.Timestamp"
-      optional :target, :string, 3
-      optional :verb, :string, 4
-      optional :status_detail, :string, 5
-      optional :cancel_requested, :bool, 6
-      optional :api_version, :string, 7
+
+descriptor_data = "\n,google/cloud/common/operation_metadata.proto\x12\x13google.cloud.common\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xf9\x01\n\x11OperationMetadata\x12\x34\n\x0b\x63reate_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x31\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x13\n\x06target\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x11\n\x04verb\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x1a\n\rstatus_detail\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x1d\n\x10\x63\x61ncel_requested\x18\x06 \x01(\x08\x42\x03\xe0\x41\x03\x12\x18\n\x0b\x61pi_version\x18\x07 \x01(\tB\x03\xe0\x41\x03\x42V\n\x17\x63om.google.cloud.commonP\x01Z9google.golang.org/genproto/googleapis/cloud/common;commonb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError => e
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+    ["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
     end
   end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
 end
 
 module Google
@@ -27,3 +42,59 @@ module Google
     end
   end
 end
+
+#### Source proto file: google/cloud/common/operation_metadata.proto ####
+#
+# // Copyright 2021 Google LLC
+# //
+# // Licensed under the Apache License, Version 2.0 (the "License");
+# // you may not use this file except in compliance with the License.
+# // You may obtain a copy of the License at
+# //
+# //     http://www.apache.org/licenses/LICENSE-2.0
+# //
+# // Unless required by applicable law or agreed to in writing, software
+# // distributed under the License is distributed on an "AS IS" BASIS,
+# // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# // See the License for the specific language governing permissions and
+# // limitations under the License.
+#
+# syntax = "proto3";
+#
+# package google.cloud.common;
+#
+# import "google/api/field_behavior.proto";
+# import "google/protobuf/timestamp.proto";
+#
+# option go_package = "google.golang.org/genproto/googleapis/cloud/common;common";
+# option java_multiple_files = true;
+# option java_package = "com.google.cloud.common";
+#
+# // Represents the metadata of the long-running operation.
+# message OperationMetadata {
+#   // Output only. The time the operation was created.
+#   google.protobuf.Timestamp create_time = 1
+#       [(google.api.field_behavior) = OUTPUT_ONLY];
+#
+#   // Output only. The time the operation finished running.
+#   google.protobuf.Timestamp end_time = 2
+#       [(google.api.field_behavior) = OUTPUT_ONLY];
+#
+#   // Output only. Server-defined resource path for the target of the operation.
+#   string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+#
+#   // Output only. Name of the verb executed by the operation.
+#   string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+#
+#   // Output only. Human-readable status of the operation, if any.
+#   string status_detail = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+#
+#   // Output only. Identifies whether the user has requested cancellation
+#   // of the operation. Operations that have successfully been cancelled
+#   // have [Operation.error][] value with a [google.rpc.Status.code][] of 1,
+#   // corresponding to `Code.CANCELLED`.
+#   bool cancel_requested = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+#
+#   // Output only. API version used to start the operation.
+#   string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+# }

data/lib/google/cloud/common/version.rb

@@ -17,7 +17,7 @@
 module Google
   module Cloud
     module Common
-      VERSION = "1.1.0".freeze
+      VERSION = "1.2.0".freeze
     end
   end
 end

data/lib/google/cloud/extended_operations_pb.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/extended_operations.proto
 
@@ -5,16 +6,31 @@ require 'google/protobuf'
 
 require 'google/protobuf/descriptor_pb'
 
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("google/cloud/extended_operations.proto", :syntax => :proto3) do
-    add_enum "google.cloud.OperationResponseMapping" do
-      value :UNDEFINED, 0
-      value :NAME, 1
-      value :STATUS, 2
-      value :ERROR_CODE, 3
-      value :ERROR_MESSAGE, 4
+
+descriptor_data = "\n&google/cloud/extended_operations.proto\x12\x0cgoogle.cloud\x1a google/protobuf/descriptor.proto*b\n\x18OperationResponseMapping\x12\r\n\tUNDEFINED\x10\x00\x12\x08\n\x04NAME\x10\x01\x12\n\n\x06STATUS\x10\x02\x12\x0e\n\nERROR_CODE\x10\x03\x12\x11\n\rERROR_MESSAGE\x10\x04:_\n\x0foperation_field\x12\x1d.google.protobuf.FieldOptions\x18\xfd\x08 \x01(\x0e\x32&.google.cloud.OperationResponseMapping:?\n\x17operation_request_field\x12\x1d.google.protobuf.FieldOptions\x18\xfe\x08 \x01(\t:@\n\x18operation_response_field\x12\x1d.google.protobuf.FieldOptions\x18\xff\x08 \x01(\t::\n\x11operation_service\x12\x1e.google.protobuf.MethodOptions\x18\xe1\t \x01(\t:A\n\x18operation_polling_method\x12\x1e.google.protobuf.MethodOptions\x18\xe2\t \x01(\x08\x42y\n\x10\x63om.google.cloudB\x17\x45xtendedOperationsProtoP\x01ZCgoogle.golang.org/genproto/googleapis/cloud/extendedops;extendedops\xa2\x02\x04GAPIb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError => e
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
     end
   end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
 end
 
 module Google
@@ -22,3 +38,156 @@ module Google
     OperationResponseMapping = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.OperationResponseMapping").enummodule
   end
 end
+
+#### Source proto file: google/cloud/extended_operations.proto ####
+#
+# // Copyright 2021 Google LLC.
+# //
+# // Licensed under the Apache License, Version 2.0 (the "License");
+# // you may not use this file except in compliance with the License.
+# // You may obtain a copy of the License at
+# //
+# //     http://www.apache.org/licenses/LICENSE-2.0
+# //
+# // Unless required by applicable law or agreed to in writing, software
+# // distributed under the License is distributed on an "AS IS" BASIS,
+# // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# // See the License for the specific language governing permissions and
+# // limitations under the License.
+#
+# // This file contains custom annotations that are used by GAPIC generators to
+# // handle Long Running Operation methods (LRO) that are NOT compliant with
+# // https://google.aip.dev/151. These annotations are public for technical
+# // reasons only. Please DO NOT USE them in your protos.
+# syntax = "proto3";
+#
+# package google.cloud;
+#
+# import "google/protobuf/descriptor.proto";
+#
+# option go_package = "google.golang.org/genproto/googleapis/cloud/extendedops;extendedops";
+# option java_multiple_files = true;
+# option java_outer_classname = "ExtendedOperationsProto";
+# option java_package = "com.google.cloud";
+# option objc_class_prefix = "GAPI";
+#
+# // FieldOptions to match corresponding fields in the initial request,
+# // polling request and operation response messages.
+# //
+# // Example:
+# //
+# // In an API-specific operation message:
+# //
+# //     message MyOperation {
+# //       string http_error_message = 1 [(operation_field) = ERROR_MESSAGE];
+# //       int32 http_error_status_code = 2 [(operation_field) = ERROR_CODE];
+# //       string id = 3 [(operation_field) = NAME];
+# //       Status status = 4 [(operation_field) = STATUS];
+# //     }
+# //
+# // In a polling request message (the one which is used to poll for an LRO
+# // status):
+# //
+# //     message MyPollingRequest {
+# //       string operation = 1 [(operation_response_field) = "id"];
+# //       string project = 2;
+# //       string region = 3;
+# //     }
+# //
+# // In an initial request message (the one which starts an LRO):
+# //
+# //    message MyInitialRequest {
+# //      string my_project = 2 [(operation_request_field) = "project"];
+# //      string my_region = 3 [(operation_request_field) = "region"];
+# //    }
+# //
+# extend google.protobuf.FieldOptions {
+#   // A field annotation that maps fields in an API-specific Operation object to
+#   // their standard counterparts in google.longrunning.Operation. See
+#   // OperationResponseMapping enum definition.
+#   OperationResponseMapping operation_field = 1149;
+#
+#   // A field annotation that maps fields in the initial request message
+#   // (the one which started the LRO) to their counterparts in the polling
+#   // request message. For non-standard LRO, the polling response may be missing
+#   // some of the information needed to make a subsequent polling request. The
+#   // missing information (for example, project or region ID) is contained in the
+#   // fields of the initial request message that this annotation must be applied
+#   // to. The string value of the annotation corresponds to the name of the
+#   // counterpart field in the polling request message that the annotated field's
+#   // value will be copied to.
+#   string operation_request_field = 1150;
+#
+#   // A field annotation that maps fields in the polling request message to their
+#   // counterparts in the initial and/or polling response message. The initial
+#   // and the polling methods return an API-specific Operation object. Some of
+#   // the fields from that response object must be reused in the subsequent
+#   // request (like operation name/ID) to fully identify the polled operation.
+#   // This annotation must be applied to the fields in the polling request
+#   // message, the string value of the annotation must correspond to the name of
+#   // the counterpart field in the Operation response object whose value will be
+#   // copied to the annotated field.
+#   string operation_response_field = 1151;
+# }
+#
+# // MethodOptions to identify the actual service and method used for operation
+# // status polling.
+# //
+# // Example:
+# //
+# // In a method, which starts an LRO:
+# //
+# //     service MyService {
+# //       rpc Foo(MyInitialRequest) returns (MyOperation) {
+# //         option (operation_service) = "MyPollingService";
+# //       }
+# //     }
+# //
+# // In a polling method:
+# //
+# //     service MyPollingService {
+# //       rpc Get(MyPollingRequest) returns (MyOperation) {
+# //         option (operation_polling_method) = true;
+# //       }
+# //     }
+# extend google.protobuf.MethodOptions {
+#   // A method annotation that maps an LRO method (the one which starts an LRO)
+#   // to the service, which will be used to poll for the operation status. The
+#   // annotation must be applied to the method which starts an LRO, the string
+#   // value of the annotation must correspond to the name of the service used to
+#   // poll for the operation status.
+#   string operation_service = 1249;
+#
+#   // A method annotation that marks methods that can be used for polling
+#   // operation status (e.g. the MyPollingService.Get(MyPollingRequest) method).
+#   bool operation_polling_method = 1250;
+# }
+#
+# // An enum to be used to mark the essential (for polling) fields in an
+# // API-specific Operation object. A custom Operation object may contain many
+# // different fields, but only few of them are essential to conduct a successful
+# // polling process.
+# enum OperationResponseMapping {
+#   // Do not use.
+#   UNDEFINED = 0;
+#
+#   // A field in an API-specific (custom) Operation object which carries the same
+#   // meaning as google.longrunning.Operation.name.
+#   NAME = 1;
+#
+#   // A field in an API-specific (custom) Operation object which carries the same
+#   // meaning as google.longrunning.Operation.done. If the annotated field is of
+#   // an enum type, `annotated_field_name == EnumType.DONE` semantics should be
+#   // equivalent to `Operation.done == true`. If the annotated field is of type
+#   // boolean, then it should follow the same semantics as Operation.done.
+#   // Otherwise, a non-empty value should be treated as `Operation.done == true`.
+#   STATUS = 2;
+#
+#   // A field in an API-specific (custom) Operation object which carries the same
+#   // meaning as google.longrunning.Operation.error.code.
+#   ERROR_CODE = 3;
+#
+#   // A field in an API-specific (custom) Operation object which carries the same
+#   // meaning as google.longrunning.Operation.error.message.
+#   ERROR_MESSAGE = 4;
+# }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-common
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.18'
 - !ruby/object:Gem::Dependency
   name: googleapis-common-protos-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.7'
 description: Common protocol buffer types used by Google Cloud APIs
 email:
 - googleapis-packages@google.com
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: Common protocol buffer types used in Google Cloud APIs