googleapis-common-protos-types 1.7.0 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (62) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/lib/google/api/annotations_pb.rb +60 -2
  4. data/lib/google/api/auth_pb.rb +264 -34
  5. data/lib/google/api/backend_pb.rb +212 -23
  6. data/lib/google/api/billing_pb.rb +104 -8
  7. data/lib/google/api/client_pb.rb +422 -86
  8. data/lib/google/api/config_change_pb.rb +111 -17
  9. data/lib/google/api/consumer_pb.rb +109 -16
  10. data/lib/google/api/context_pb.rb +117 -11
  11. data/lib/google/api/control_pb.rb +71 -4
  12. data/lib/google/api/distribution_pb.rb +242 -39
  13. data/lib/google/api/documentation_pb.rb +195 -19
  14. data/lib/google/api/endpoint_pb.rb +100 -7
  15. data/lib/google/api/error_reason_pb.rb +597 -33
  16. data/lib/google/api/field_behavior_pb.rb +117 -11
  17. data/lib/google/api/http_pb.rb +406 -23
  18. data/lib/google/api/httpbody_pb.rb +109 -6
  19. data/lib/google/api/label_pb.rb +75 -11
  20. data/lib/google/api/launch_stage_pb.rb +99 -11
  21. data/lib/google/api/log_pb.rb +82 -7
  22. data/lib/google/api/logging_pb.rb +108 -9
  23. data/lib/google/api/metric_pb.rb +297 -38
  24. data/lib/google/api/monitored_resource_pb.rb +159 -17
  25. data/lib/google/api/monitoring_pb.rb +134 -9
  26. data/lib/google/api/policy_pb.rb +129 -0
  27. data/lib/google/api/quota_pb.rb +211 -21
  28. data/lib/google/api/resource_pb.rb +265 -23
  29. data/lib/google/api/routing_pb.rb +488 -8
  30. data/lib/google/api/service_pb.rb +239 -29
  31. data/lib/google/api/source_info_pb.rb +59 -4
  32. data/lib/google/api/system_parameter_pb.rb +123 -13
  33. data/lib/google/api/usage_pb.rb +123 -11
  34. data/lib/google/api/visibility_pb.rb +140 -8
  35. data/lib/google/logging/type/http_request_pb.rb +123 -18
  36. data/lib/google/logging/type/log_severity_pb.rb +98 -12
  37. data/lib/google/longrunning/operations_pb.rb +277 -37
  38. data/lib/google/rpc/code_pb.rb +213 -20
  39. data/lib/google/rpc/context/attribute_context_pb.rb +375 -66
  40. data/lib/google/rpc/context/audit_context_pb.rb +77 -8
  41. data/lib/google/rpc/error_details_pb.rb +313 -56
  42. data/lib/google/rpc/http_pb.rb +91 -17
  43. data/lib/google/rpc/status_pb.rb +77 -6
  44. data/lib/google/type/calendar_period_pb.rb +83 -11
  45. data/lib/google/type/color_pb.rb +202 -7
  46. data/lib/google/type/date_pb.rb +79 -6
  47. data/lib/google/type/datetime_pb.rb +132 -18
  48. data/lib/google/type/dayofweek_pb.rb +77 -11
  49. data/lib/google/type/decimal_pb.rb +122 -4
  50. data/lib/google/type/expr_pb.rb +100 -7
  51. data/lib/google/type/fraction_pb.rb +60 -5
  52. data/lib/google/type/interval_pb.rb +74 -5
  53. data/lib/google/type/latlng_pb.rb +64 -5
  54. data/lib/google/type/localized_text_pb.rb +63 -5
  55. data/lib/google/type/money_pb.rb +69 -6
  56. data/lib/google/type/month_pb.rb +92 -16
  57. data/lib/google/type/phone_number_pb.rb +140 -12
  58. data/lib/google/type/postal_address_pb.rb +161 -14
  59. data/lib/google/type/quaternion_pb.rb +121 -7
  60. data/lib/google/type/timeofday_pb.rb +71 -7
  61. data/lib/googleapis/common/protos/types/version.rb +1 -1
  62. metadata +5 -4
data/lib/google/api/billing_pb.rb CHANGED
@@ -1,18 +1,34 @@
1
+ # frozen_string_literal: true
1
2
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
3
  # source: google/api/billing.proto
3
4
 
4
5
  require 'google/protobuf'
5
6
 
6
- Google::Protobuf::DescriptorPool.generated_pool.build do
7
- add_file("google/api/billing.proto", :syntax => :proto3) do
8
- add_message "google.api.Billing" do
9
- repeated :consumer_destinations, :message, 8, "google.api.Billing.BillingDestination"
10
- end
11
- add_message "google.api.Billing.BillingDestination" do
12
- optional :monitored_resource, :string, 1
13
- repeated :metrics, :string, 2
7
+
8
+ descriptor_data = "\n\x18google/api/billing.proto\x12\ngoogle.api\"\x93\x01\n\x07\x42illing\x12\x45\n\x15\x63onsumer_destinations\x18\x08 \x03(\x0b\x32&.google.api.Billing.BillingDestination\x1a\x41\n\x12\x42illingDestination\x12\x1a\n\x12monitored_resource\x18\x01 \x01(\t\x12\x0f\n\x07metrics\x18\x02 \x03(\tBn\n\x0e\x63om.google.apiB\x0c\x42illingProtoP\x01ZEgoogle.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig\xa2\x02\x04GAPIb\x06proto3"
9
+
10
+ pool = Google::Protobuf::DescriptorPool.generated_pool
11
+
12
+ begin
13
+ pool.add_serialized_file(descriptor_data)
14
+ rescue TypeError => e
15
+ # Compatibility code: will be removed in the next major version.
16
+ require 'google/protobuf/descriptor_pb'
17
+ parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
18
+ parsed.clear_dependency
19
+ serialized = parsed.class.encode(parsed)
20
+ file = pool.add_serialized_file(serialized)
21
+ warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
22
+ imports = [
23
+ ]
24
+ imports.each do |type_name, expected_filename|
25
+ import_file = pool.lookup(type_name).file_descriptor
26
+ if import_file.name != expected_filename
27
+ warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
14
28
  end
15
29
  end
30
+ warn "Each proto file must use a consistent fully-qualified name."
31
+ warn "This will become an error in the next major version."
16
32
  end
17
33
 
18
34
  module Google
@@ -21,3 +37,83 @@ module Google
21
37
  Billing::BillingDestination = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.Billing.BillingDestination").msgclass
22
38
  end
23
39
  end
40
+
41
+ #### Source proto file: google/api/billing.proto ####
42
+ #
43
+ # // Copyright 2023 Google LLC
44
+ # //
45
+ # // Licensed under the Apache License, Version 2.0 (the "License");
46
+ # // you may not use this file except in compliance with the License.
47
+ # // You may obtain a copy of the License at
48
+ # //
49
+ # // http://www.apache.org/licenses/LICENSE-2.0
50
+ # //
51
+ # // Unless required by applicable law or agreed to in writing, software
52
+ # // distributed under the License is distributed on an "AS IS" BASIS,
53
+ # // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
54
+ # // See the License for the specific language governing permissions and
55
+ # // limitations under the License.
56
+ #
57
+ # syntax = "proto3";
58
+ #
59
+ # package google.api;
60
+ #
61
+ # option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
62
+ # option java_multiple_files = true;
63
+ # option java_outer_classname = "BillingProto";
64
+ # option java_package = "com.google.api";
65
+ # option objc_class_prefix = "GAPI";
66
+ #
67
+ # // Billing related configuration of the service.
68
+ # //
69
+ # // The following example shows how to configure monitored resources and metrics
70
+ # // for billing, `consumer_destinations` is the only supported destination and
71
+ # // the monitored resources need at least one label key
72
+ # // `cloud.googleapis.com/location` to indicate the location of the billing
73
+ # // usage, using different monitored resources between monitoring and billing is
74
+ # // recommended so they can be evolved independently:
75
+ # //
76
+ # //
77
+ # // monitored_resources:
78
+ # // - type: library.googleapis.com/billing_branch
79
+ # // labels:
80
+ # // - key: cloud.googleapis.com/location
81
+ # // description: |
82
+ # // Predefined label to support billing location restriction.
83
+ # // - key: city
84
+ # // description: |
85
+ # // Custom label to define the city where the library branch is located
86
+ # // in.
87
+ # // - key: name
88
+ # // description: Custom label to define the name of the library branch.
89
+ # // metrics:
90
+ # // - name: library.googleapis.com/book/borrowed_count
91
+ # // metric_kind: DELTA
92
+ # // value_type: INT64
93
+ # // unit: "1"
94
+ # // billing:
95
+ # // consumer_destinations:
96
+ # // - monitored_resource: library.googleapis.com/billing_branch
97
+ # // metrics:
98
+ # // - library.googleapis.com/book/borrowed_count
99
+ # message Billing {
100
+ # // Configuration of a specific billing destination (Currently only support
101
+ # // bill against consumer project).
102
+ # message BillingDestination {
103
+ # // The monitored resource type. The type must be defined in
104
+ # // [Service.monitored_resources][google.api.Service.monitored_resources]
105
+ # // section.
106
+ # string monitored_resource = 1;
107
+ #
108
+ # // Names of the metrics to report to this billing destination.
109
+ # // Each name must be defined in
110
+ # // [Service.metrics][google.api.Service.metrics] section.
111
+ # repeated string metrics = 2;
112
+ # }
113
+ #
114
+ # // Billing configurations for sending metrics to the consumer project.
115
+ # // There can be multiple consumer destinations per service, each one must have
116
+ # // a different monitored resource type. A metric can be used in at most
117
+ # // one consumer destination.
118
+ # repeated BillingDestination consumer_destinations = 8;
119
+ # }
data/lib/google/api/client_pb.rb CHANGED
@@ -1,3 +1,4 @@
1
+ # frozen_string_literal: true
1
2
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
3
  # source: google/api/client.proto
3
4
 
@@ -7,94 +8,32 @@ require 'google/api/launch_stage_pb'
7
8
  require 'google/protobuf/descriptor_pb'
8
9
  require 'google/protobuf/duration_pb'
9
10
 
10
- Google::Protobuf::DescriptorPool.generated_pool.build do
11
- add_file("google/api/client.proto", :syntax => :proto3) do
12
- add_message "google.api.CommonLanguageSettings" do
13
- optional :reference_docs_uri, :string, 1
14
- repeated :destinations, :enum, 2, "google.api.ClientLibraryDestination"
15
- end
16
- add_message "google.api.ClientLibrarySettings" do
17
- optional :version, :string, 1
18
- optional :launch_stage, :enum, 2, "google.api.LaunchStage"
19
- optional :rest_numeric_enums, :bool, 3
20
- optional :java_settings, :message, 21, "google.api.JavaSettings"
21
- optional :cpp_settings, :message, 22, "google.api.CppSettings"
22
- optional :php_settings, :message, 23, "google.api.PhpSettings"
23
- optional :python_settings, :message, 24, "google.api.PythonSettings"
24
- optional :node_settings, :message, 25, "google.api.NodeSettings"
25
- optional :dotnet_settings, :message, 26, "google.api.DotnetSettings"
26
- optional :ruby_settings, :message, 27, "google.api.RubySettings"
27
- optional :go_settings, :message, 28, "google.api.GoSettings"
28
- end
29
- add_message "google.api.Publishing" do
30
- repeated :method_settings, :message, 2, "google.api.MethodSettings"
31
- optional :new_issue_uri, :string, 101
32
- optional :documentation_uri, :string, 102
33
- optional :api_short_name, :string, 103
34
- optional :github_label, :string, 104
35
- repeated :codeowner_github_teams, :string, 105
36
- optional :doc_tag_prefix, :string, 106
37
- optional :organization, :enum, 107, "google.api.ClientLibraryOrganization"
38
- repeated :library_settings, :message, 109, "google.api.ClientLibrarySettings"
39
- optional :proto_reference_documentation_uri, :string, 110
40
- end
41
- add_message "google.api.JavaSettings" do
42
- optional :library_package, :string, 1
43
- map :service_class_names, :string, :string, 2
44
- optional :common, :message, 3, "google.api.CommonLanguageSettings"
45
- end
46
- add_message "google.api.CppSettings" do
47
- optional :common, :message, 1, "google.api.CommonLanguageSettings"
48
- end
49
- add_message "google.api.PhpSettings" do
50
- optional :common, :message, 1, "google.api.CommonLanguageSettings"
51
- end
52
- add_message "google.api.PythonSettings" do
53
- optional :common, :message, 1, "google.api.CommonLanguageSettings"
54
- end
55
- add_message "google.api.NodeSettings" do
56
- optional :common, :message, 1, "google.api.CommonLanguageSettings"
57
- end
58
- add_message "google.api.DotnetSettings" do
59
- optional :common, :message, 1, "google.api.CommonLanguageSettings"
60
- map :renamed_services, :string, :string, 2
61
- map :renamed_resources, :string, :string, 3
62
- repeated :ignored_resources, :string, 4
63
- repeated :forced_namespace_aliases, :string, 5
64
- repeated :handwritten_signatures, :string, 6
65
- end
66
- add_message "google.api.RubySettings" do
67
- optional :common, :message, 1, "google.api.CommonLanguageSettings"
68
- end
69
- add_message "google.api.GoSettings" do
70
- optional :common, :message, 1, "google.api.CommonLanguageSettings"
71
- end
72
- add_message "google.api.MethodSettings" do
73
- optional :selector, :string, 1
74
- optional :long_running, :message, 2, "google.api.MethodSettings.LongRunning"
75
- end
76
- add_message "google.api.MethodSettings.LongRunning" do
77
- optional :initial_poll_delay, :message, 1, "google.protobuf.Duration"
78
- optional :poll_delay_multiplier, :float, 2
79
- optional :max_poll_delay, :message, 3, "google.protobuf.Duration"
80
- optional :total_poll_timeout, :message, 4, "google.protobuf.Duration"
81
- end
82
- add_enum "google.api.ClientLibraryOrganization" do
83
- value :CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED, 0
84
- value :CLOUD, 1
85
- value :ADS, 2
86
- value :PHOTOS, 3
87
- value :STREET_VIEW, 4
88
- value :SHOPPING, 5
89
- value :GEO, 6
90
- value :GENERATIVE_AI, 7
91
- end
92
- add_enum "google.api.ClientLibraryDestination" do
93
- value :CLIENT_LIBRARY_DESTINATION_UNSPECIFIED, 0
94
- value :GITHUB, 10
95
- value :PACKAGE_MANAGER, 20
11
+
12
+ descriptor_data = "\n\x17google/api/client.proto\x12\ngoogle.api\x1a\x1dgoogle/api/launch_stage.proto\x1a google/protobuf/descriptor.proto\x1a\x1egoogle/protobuf/duration.proto\"t\n\x16\x43ommonLanguageSettings\x12\x1e\n\x12reference_docs_uri\x18\x01 \x01(\tB\x02\x18\x01\x12:\n\x0c\x64\x65stinations\x18\x02 \x03(\x0e\x32$.google.api.ClientLibraryDestination\"\xfb\x03\n\x15\x43lientLibrarySettings\x12\x0f\n\x07version\x18\x01 \x01(\t\x12-\n\x0claunch_stage\x18\x02 \x01(\x0e\x32\x17.google.api.LaunchStage\x12\x1a\n\x12rest_numeric_enums\x18\x03 \x01(\x08\x12/\n\rjava_settings\x18\x15 \x01(\x0b\x32\x18.google.api.JavaSettings\x12-\n\x0c\x63pp_settings\x18\x16 \x01(\x0b\x32\x17.google.api.CppSettings\x12-\n\x0cphp_settings\x18\x17 \x01(\x0b\x32\x17.google.api.PhpSettings\x12\x33\n\x0fpython_settings\x18\x18 \x01(\x0b\x32\x1a.google.api.PythonSettings\x12/\n\rnode_settings\x18\x19 \x01(\x0b\x32\x18.google.api.NodeSettings\x12\x33\n\x0f\x64otnet_settings\x18\x1a \x01(\x0b\x32\x1a.google.api.DotnetSettings\x12/\n\rruby_settings\x18\x1b \x01(\x0b\x32\x18.google.api.RubySettings\x12+\n\x0bgo_settings\x18\x1c \x01(\x0b\x32\x16.google.api.GoSettings\"\xfe\x02\n\nPublishing\x12\x33\n\x0fmethod_settings\x18\x02 \x03(\x0b\x32\x1a.google.api.MethodSettings\x12\x15\n\rnew_issue_uri\x18\x65 \x01(\t\x12\x19\n\x11\x64ocumentation_uri\x18\x66 \x01(\t\x12\x16\n\x0e\x61pi_short_name\x18g \x01(\t\x12\x14\n\x0cgithub_label\x18h \x01(\t\x12\x1e\n\x16\x63odeowner_github_teams\x18i \x03(\t\x12\x16\n\x0e\x64oc_tag_prefix\x18j \x01(\t\x12;\n\x0corganization\x18k \x01(\x0e\x32%.google.api.ClientLibraryOrganization\x12;\n\x10library_settings\x18m \x03(\x0b\x32!.google.api.ClientLibrarySettings\x12)\n!proto_reference_documentation_uri\x18n \x01(\t\"\xe3\x01\n\x0cJavaSettings\x12\x17\n\x0flibrary_package\x18\x01 \x01(\t\x12L\n\x13service_class_names\x18\x02 \x03(\x0b\x32/.google.api.JavaSettings.ServiceClassNamesEntry\x12\x32\n\x06\x63ommon\x18\x03 \x01(\x0b\x32\".google.api.CommonLanguageSettings\x1a\x38\n\x16ServiceClassNamesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"A\n\x0b\x43ppSettings\x12\x32\n\x06\x63ommon\x18\x01 \x01(\x0b\x32\".google.api.CommonLanguageSettings\"A\n\x0bPhpSettings\x12\x32\n\x06\x63ommon\x18\x01 \x01(\x0b\x32\".google.api.CommonLanguageSettings\"D\n\x0ePythonSettings\x12\x32\n\x06\x63ommon\x18\x01 \x01(\x0b\x32\".google.api.CommonLanguageSettings\"B\n\x0cNodeSettings\x12\x32\n\x06\x63ommon\x18\x01 \x01(\x0b\x32\".google.api.CommonLanguageSettings\"\xaa\x03\n\x0e\x44otnetSettings\x12\x32\n\x06\x63ommon\x18\x01 \x01(\x0b\x32\".google.api.CommonLanguageSettings\x12I\n\x10renamed_services\x18\x02 \x03(\x0b\x32/.google.api.DotnetSettings.RenamedServicesEntry\x12K\n\x11renamed_resources\x18\x03 \x03(\x0b\x32\x30.google.api.DotnetSettings.RenamedResourcesEntry\x12\x19\n\x11ignored_resources\x18\x04 \x03(\t\x12 \n\x18\x66orced_namespace_aliases\x18\x05 \x03(\t\x12\x1e\n\x16handwritten_signatures\x18\x06 \x03(\t\x1a\x36\n\x14RenamedServicesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\x1a\x37\n\x15RenamedResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"B\n\x0cRubySettings\x12\x32\n\x06\x63ommon\x18\x01 \x01(\x0b\x32\".google.api.CommonLanguageSettings\"@\n\nGoSettings\x12\x32\n\x06\x63ommon\x18\x01 \x01(\x0b\x32\".google.api.CommonLanguageSettings\"\xb0\x02\n\x0eMethodSettings\x12\x10\n\x08selector\x18\x01 \x01(\t\x12<\n\x0clong_running\x18\x02 \x01(\x0b\x32&.google.api.MethodSettings.LongRunning\x1a\xcd\x01\n\x0bLongRunning\x12\x35\n\x12initial_poll_delay\x18\x01 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x1d\n\x15poll_delay_multiplier\x18\x02 \x01(\x02\x12\x31\n\x0emax_poll_delay\x18\x03 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x35\n\x12total_poll_timeout\x18\x04 \x01(\x0b\x32\x19.google.protobuf.Duration*\xa3\x01\n\x19\x43lientLibraryOrganization\x12+\n\'CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED\x10\x00\x12\t\n\x05\x43LOUD\x10\x01\x12\x07\n\x03\x41\x44S\x10\x02\x12\n\n\x06PHOTOS\x10\x03\x12\x0f\n\x0bSTREET_VIEW\x10\x04\x12\x0c\n\x08SHOPPING\x10\x05\x12\x07\n\x03GEO\x10\x06\x12\x11\n\rGENERATIVE_AI\x10\x07*g\n\x18\x43lientLibraryDestination\x12*\n&CLIENT_LIBRARY_DESTINATION_UNSPECIFIED\x10\x00\x12\n\n\x06GITHUB\x10\n\x12\x13\n\x0fPACKAGE_MANAGER\x10\x14:9\n\x10method_signature\x12\x1e.google.protobuf.MethodOptions\x18\x9b\x08 \x03(\t:6\n\x0c\x64\x65\x66\x61ult_host\x12\x1f.google.protobuf.ServiceOptions\x18\x99\x08 \x01(\t:6\n\x0coauth_scopes\x12\x1f.google.protobuf.ServiceOptions\x18\x9a\x08 \x01(\tBi\n\x0e\x63om.google.apiB\x0b\x43lientProtoP\x01ZAgoogle.golang.org/genproto/googleapis/api/annotations;annotations\xa2\x02\x04GAPIb\x06proto3"
13
+
14
+ pool = Google::Protobuf::DescriptorPool.generated_pool
15
+
16
+ begin
17
+ pool.add_serialized_file(descriptor_data)
18
+ rescue TypeError => e
19
+ # Compatibility code: will be removed in the next major version.
20
+ require 'google/protobuf/descriptor_pb'
21
+ parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
22
+ parsed.clear_dependency
23
+ serialized = parsed.class.encode(parsed)
24
+ file = pool.add_serialized_file(serialized)
25
+ warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
26
+ imports = [
27
+ ["google.protobuf.Duration", "google/protobuf/duration.proto"],
28
+ ]
29
+ imports.each do |type_name, expected_filename|
30
+ import_file = pool.lookup(type_name).file_descriptor
31
+ if import_file.name != expected_filename
32
+ warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
96
33
  end
97
34
  end
35
+ warn "Each proto file must use a consistent fully-qualified name."
36
+ warn "This will become an error in the next major version."
98
37
  end
99
38
 
100
39
  module Google
@@ -116,3 +55,400 @@ module Google
116
55
  ClientLibraryDestination = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.ClientLibraryDestination").enummodule
117
56
  end
118
57
  end
58
+
59
+ #### Source proto file: google/api/client.proto ####
60
+ #
61
+ # // Copyright 2023 Google LLC
62
+ # //
63
+ # // Licensed under the Apache License, Version 2.0 (the "License");
64
+ # // you may not use this file except in compliance with the License.
65
+ # // You may obtain a copy of the License at
66
+ # //
67
+ # // http://www.apache.org/licenses/LICENSE-2.0
68
+ # //
69
+ # // Unless required by applicable law or agreed to in writing, software
70
+ # // distributed under the License is distributed on an "AS IS" BASIS,
71
+ # // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
72
+ # // See the License for the specific language governing permissions and
73
+ # // limitations under the License.
74
+ #
75
+ # syntax = "proto3";
76
+ #
77
+ # package google.api;
78
+ #
79
+ # import "google/api/launch_stage.proto";
80
+ # import "google/protobuf/descriptor.proto";
81
+ # import "google/protobuf/duration.proto";
82
+ #
83
+ # option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
84
+ # option java_multiple_files = true;
85
+ # option java_outer_classname = "ClientProto";
86
+ # option java_package = "com.google.api";
87
+ # option objc_class_prefix = "GAPI";
88
+ #
89
+ # extend google.protobuf.MethodOptions {
90
+ # // A definition of a client library method signature.
91
+ # //
92
+ # // In client libraries, each proto RPC corresponds to one or more methods
93
+ # // which the end user is able to call, and calls the underlying RPC.
94
+ # // Normally, this method receives a single argument (a struct or instance
95
+ # // corresponding to the RPC request object). Defining this field will
96
+ # // add one or more overloads providing flattened or simpler method signatures
97
+ # // in some languages.
98
+ # //
99
+ # // The fields on the method signature are provided as a comma-separated
100
+ # // string.
101
+ # //
102
+ # // For example, the proto RPC and annotation:
103
+ # //
104
+ # // rpc CreateSubscription(CreateSubscriptionRequest)
105
+ # // returns (Subscription) {
106
+ # // option (google.api.method_signature) = "name,topic";
107
+ # // }
108
+ # //
109
+ # // Would add the following Java overload (in addition to the method accepting
110
+ # // the request object):
111
+ # //
112
+ # // public final Subscription createSubscription(String name, String topic)
113
+ # //
114
+ # // The following backwards-compatibility guidelines apply:
115
+ # //
116
+ # // * Adding this annotation to an unannotated method is backwards
117
+ # // compatible.
118
+ # // * Adding this annotation to a method which already has existing
119
+ # // method signature annotations is backwards compatible if and only if
120
+ # // the new method signature annotation is last in the sequence.
121
+ # // * Modifying or removing an existing method signature annotation is
122
+ # // a breaking change.
123
+ # // * Re-ordering existing method signature annotations is a breaking
124
+ # // change.
125
+ # repeated string method_signature = 1051;
126
+ # }
127
+ #
128
+ # extend google.protobuf.ServiceOptions {
129
+ # // The hostname for this service.
130
+ # // This should be specified with no prefix or protocol.
131
+ # //
132
+ # // Example:
133
+ # //
134
+ # // service Foo {
135
+ # // option (google.api.default_host) = "foo.googleapi.com";
136
+ # // ...
137
+ # // }
138
+ # string default_host = 1049;
139
+ #
140
+ # // OAuth scopes needed for the client.
141
+ # //
142
+ # // Example:
143
+ # //
144
+ # // service Foo {
145
+ # // option (google.api.oauth_scopes) = \
146
+ # // "https://www.googleapis.com/auth/cloud-platform";
147
+ # // ...
148
+ # // }
149
+ # //
150
+ # // If there is more than one scope, use a comma-separated string:
151
+ # //
152
+ # // Example:
153
+ # //
154
+ # // service Foo {
155
+ # // option (google.api.oauth_scopes) = \
156
+ # // "https://www.googleapis.com/auth/cloud-platform,"
157
+ # // "https://www.googleapis.com/auth/monitoring";
158
+ # // ...
159
+ # // }
160
+ # string oauth_scopes = 1050;
161
+ # }
162
+ #
163
+ # // Required information for every language.
164
+ # message CommonLanguageSettings {
165
+ # // Link to automatically generated reference documentation. Example:
166
+ # // https://cloud.google.com/nodejs/docs/reference/asset/latest
167
+ # string reference_docs_uri = 1 [deprecated = true];
168
+ #
169
+ # // The destination where API teams want this client library to be published.
170
+ # repeated ClientLibraryDestination destinations = 2;
171
+ # }
172
+ #
173
+ # // Details about how and where to publish client libraries.
174
+ # message ClientLibrarySettings {
175
+ # // Version of the API to apply these settings to. This is the full protobuf
176
+ # // package for the API, ending in the version element.
177
+ # // Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
178
+ # string version = 1;
179
+ #
180
+ # // Launch stage of this version of the API.
181
+ # LaunchStage launch_stage = 2;
182
+ #
183
+ # // When using transport=rest, the client request will encode enums as
184
+ # // numbers rather than strings.
185
+ # bool rest_numeric_enums = 3;
186
+ #
187
+ # // Settings for legacy Java features, supported in the Service YAML.
188
+ # JavaSettings java_settings = 21;
189
+ #
190
+ # // Settings for C++ client libraries.
191
+ # CppSettings cpp_settings = 22;
192
+ #
193
+ # // Settings for PHP client libraries.
194
+ # PhpSettings php_settings = 23;
195
+ #
196
+ # // Settings for Python client libraries.
197
+ # PythonSettings python_settings = 24;
198
+ #
199
+ # // Settings for Node client libraries.
200
+ # NodeSettings node_settings = 25;
201
+ #
202
+ # // Settings for .NET client libraries.
203
+ # DotnetSettings dotnet_settings = 26;
204
+ #
205
+ # // Settings for Ruby client libraries.
206
+ # RubySettings ruby_settings = 27;
207
+ #
208
+ # // Settings for Go client libraries.
209
+ # GoSettings go_settings = 28;
210
+ # }
211
+ #
212
+ # // This message configures the settings for publishing [Google Cloud Client
213
+ # // libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
214
+ # // generated from the service config.
215
+ # message Publishing {
216
+ # // A list of API method settings, e.g. the behavior for methods that use the
217
+ # // long-running operation pattern.
218
+ # repeated MethodSettings method_settings = 2;
219
+ #
220
+ # // Link to a *public* URI where users can report issues. Example:
221
+ # // https://issuetracker.google.com/issues/new?component=190865&template=1161103
222
+ # string new_issue_uri = 101;
223
+ #
224
+ # // Link to product home page. Example:
225
+ # // https://cloud.google.com/asset-inventory/docs/overview
226
+ # string documentation_uri = 102;
227
+ #
228
+ # // Used as a tracking tag when collecting data about the APIs developer
229
+ # // relations artifacts like docs, packages delivered to package managers,
230
+ # // etc. Example: "speech".
231
+ # string api_short_name = 103;
232
+ #
233
+ # // GitHub label to apply to issues and pull requests opened for this API.
234
+ # string github_label = 104;
235
+ #
236
+ # // GitHub teams to be added to CODEOWNERS in the directory in GitHub
237
+ # // containing source code for the client libraries for this API.
238
+ # repeated string codeowner_github_teams = 105;
239
+ #
240
+ # // A prefix used in sample code when demarking regions to be included in
241
+ # // documentation.
242
+ # string doc_tag_prefix = 106;
243
+ #
244
+ # // For whom the client library is being published.
245
+ # ClientLibraryOrganization organization = 107;
246
+ #
247
+ # // Client library settings. If the same version string appears multiple
248
+ # // times in this list, then the last one wins. Settings from earlier
249
+ # // settings with the same version string are discarded.
250
+ # repeated ClientLibrarySettings library_settings = 109;
251
+ #
252
+ # // Optional link to proto reference documentation. Example:
253
+ # // https://cloud.google.com/pubsub/lite/docs/reference/rpc
254
+ # string proto_reference_documentation_uri = 110;
255
+ # }
256
+ #
257
+ # // Settings for Java client libraries.
258
+ # message JavaSettings {
259
+ # // The package name to use in Java. Clobbers the java_package option
260
+ # // set in the protobuf. This should be used **only** by APIs
261
+ # // who have already set the language_settings.java.package_name" field
262
+ # // in gapic.yaml. API teams should use the protobuf java_package option
263
+ # // where possible.
264
+ # //
265
+ # // Example of a YAML configuration::
266
+ # //
267
+ # // publishing:
268
+ # // java_settings:
269
+ # // library_package: com.google.cloud.pubsub.v1
270
+ # string library_package = 1;
271
+ #
272
+ # // Configure the Java class name to use instead of the service's for its
273
+ # // corresponding generated GAPIC client. Keys are fully-qualified
274
+ # // service names as they appear in the protobuf (including the full
275
+ # // the language_settings.java.interface_names" field in gapic.yaml. API
276
+ # // teams should otherwise use the service name as it appears in the
277
+ # // protobuf.
278
+ # //
279
+ # // Example of a YAML configuration::
280
+ # //
281
+ # // publishing:
282
+ # // java_settings:
283
+ # // service_class_names:
284
+ # // - google.pubsub.v1.Publisher: TopicAdmin
285
+ # // - google.pubsub.v1.Subscriber: SubscriptionAdmin
286
+ # map<string, string> service_class_names = 2;
287
+ #
288
+ # // Some settings.
289
+ # CommonLanguageSettings common = 3;
290
+ # }
291
+ #
292
+ # // Settings for C++ client libraries.
293
+ # message CppSettings {
294
+ # // Some settings.
295
+ # CommonLanguageSettings common = 1;
296
+ # }
297
+ #
298
+ # // Settings for Php client libraries.
299
+ # message PhpSettings {
300
+ # // Some settings.
301
+ # CommonLanguageSettings common = 1;
302
+ # }
303
+ #
304
+ # // Settings for Python client libraries.
305
+ # message PythonSettings {
306
+ # // Some settings.
307
+ # CommonLanguageSettings common = 1;
308
+ # }
309
+ #
310
+ # // Settings for Node client libraries.
311
+ # message NodeSettings {
312
+ # // Some settings.
313
+ # CommonLanguageSettings common = 1;
314
+ # }
315
+ #
316
+ # // Settings for Dotnet client libraries.
317
+ # message DotnetSettings {
318
+ # // Some settings.
319
+ # CommonLanguageSettings common = 1;
320
+ #
321
+ # // Map from original service names to renamed versions.
322
+ # // This is used when the default generated types
323
+ # // would cause a naming conflict. (Neither name is
324
+ # // fully-qualified.)
325
+ # // Example: Subscriber to SubscriberServiceApi.
326
+ # map<string, string> renamed_services = 2;
327
+ #
328
+ # // Map from full resource types to the effective short name
329
+ # // for the resource. This is used when otherwise resource
330
+ # // named from different services would cause naming collisions.
331
+ # // Example entry:
332
+ # // "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
333
+ # map<string, string> renamed_resources = 3;
334
+ #
335
+ # // List of full resource types to ignore during generation.
336
+ # // This is typically used for API-specific Location resources,
337
+ # // which should be handled by the generator as if they were actually
338
+ # // the common Location resources.
339
+ # // Example entry: "documentai.googleapis.com/Location"
340
+ # repeated string ignored_resources = 4;
341
+ #
342
+ # // Namespaces which must be aliased in snippets due to
343
+ # // a known (but non-generator-predictable) naming collision
344
+ # repeated string forced_namespace_aliases = 5;
345
+ #
346
+ # // Method signatures (in the form "service.method(signature)")
347
+ # // which are provided separately, so shouldn't be generated.
348
+ # // Snippets *calling* these methods are still generated, however.
349
+ # repeated string handwritten_signatures = 6;
350
+ # }
351
+ #
352
+ # // Settings for Ruby client libraries.
353
+ # message RubySettings {
354
+ # // Some settings.
355
+ # CommonLanguageSettings common = 1;
356
+ # }
357
+ #
358
+ # // Settings for Go client libraries.
359
+ # message GoSettings {
360
+ # // Some settings.
361
+ # CommonLanguageSettings common = 1;
362
+ # }
363
+ #
364
+ # // Describes the generator configuration for a method.
365
+ # message MethodSettings {
366
+ # // Describes settings to use when generating API methods that use the
367
+ # // long-running operation pattern.
368
+ # // All default values below are from those used in the client library
369
+ # // generators (e.g.
370
+ # // [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
371
+ # message LongRunning {
372
+ # // Initial delay after which the first poll request will be made.
373
+ # // Default value: 5 seconds.
374
+ # google.protobuf.Duration initial_poll_delay = 1;
375
+ #
376
+ # // Multiplier to gradually increase delay between subsequent polls until it
377
+ # // reaches max_poll_delay.
378
+ # // Default value: 1.5.
379
+ # float poll_delay_multiplier = 2;
380
+ #
381
+ # // Maximum time between two subsequent poll requests.
382
+ # // Default value: 45 seconds.
383
+ # google.protobuf.Duration max_poll_delay = 3;
384
+ #
385
+ # // Total polling timeout.
386
+ # // Default value: 5 minutes.
387
+ # google.protobuf.Duration total_poll_timeout = 4;
388
+ # }
389
+ #
390
+ # // The fully qualified name of the method, for which the options below apply.
391
+ # // This is used to find the method to apply the options.
392
+ # string selector = 1;
393
+ #
394
+ # // Describes settings to use for long-running operations when generating
395
+ # // API methods for RPCs. Complements RPCs that use the annotations in
396
+ # // google/longrunning/operations.proto.
397
+ # //
398
+ # // Example of a YAML configuration::
399
+ # //
400
+ # // publishing:
401
+ # // method_settings:
402
+ # // - selector: google.cloud.speech.v2.Speech.BatchRecognize
403
+ # // long_running:
404
+ # // initial_poll_delay:
405
+ # // seconds: 60 # 1 minute
406
+ # // poll_delay_multiplier: 1.5
407
+ # // max_poll_delay:
408
+ # // seconds: 360 # 6 minutes
409
+ # // total_poll_timeout:
410
+ # // seconds: 54000 # 90 minutes
411
+ # LongRunning long_running = 2;
412
+ # }
413
+ #
414
+ # // The organization for which the client libraries are being published.
415
+ # // Affects the url where generated docs are published, etc.
416
+ # enum ClientLibraryOrganization {
417
+ # // Not useful.
418
+ # CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0;
419
+ #
420
+ # // Google Cloud Platform Org.
421
+ # CLOUD = 1;
422
+ #
423
+ # // Ads (Advertising) Org.
424
+ # ADS = 2;
425
+ #
426
+ # // Photos Org.
427
+ # PHOTOS = 3;
428
+ #
429
+ # // Street View Org.
430
+ # STREET_VIEW = 4;
431
+ #
432
+ # // Shopping Org.
433
+ # SHOPPING = 5;
434
+ #
435
+ # // Geo Org.
436
+ # GEO = 6;
437
+ #
438
+ # // Generative AI - https://developers.generativeai.google
439
+ # GENERATIVE_AI = 7;
440
+ # }
441
+ #
442
+ # // To where should client libraries be published?
443
+ # enum ClientLibraryDestination {
444
+ # // Client libraries will neither be generated nor published to package
445
+ # // managers.
446
+ # CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0;
447
+ #
448
+ # // Generate the client library in a repo under github.com/googleapis,
449
+ # // but don't publish it to package managers.
450
+ # GITHUB = 10;
451
+ #
452
+ # // Publish the library to package managers like nuget.org and npmjs.com.
453
+ # PACKAGE_MANAGER = 20;
454
+ # }