google-shopping-merchant-lfp-v1beta 0.a → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/shopping/merchant/lfp/v1beta/lfp_inventory_service/client.rb +435 -0
  6. data/lib/google/shopping/merchant/lfp/v1beta/lfp_inventory_service/credentials.rb +49 -0
  7. data/lib/google/shopping/merchant/lfp/v1beta/lfp_inventory_service/paths.rb +70 -0
  8. data/lib/google/shopping/merchant/lfp/v1beta/lfp_inventory_service/rest/client.rb +402 -0
  9. data/lib/google/shopping/merchant/lfp/v1beta/lfp_inventory_service/rest/service_stub.rb +131 -0
  10. data/lib/google/shopping/merchant/lfp/v1beta/lfp_inventory_service/rest.rb +56 -0
  11. data/lib/google/shopping/merchant/lfp/v1beta/lfp_inventory_service.rb +59 -0
  12. data/lib/google/shopping/merchant/lfp/v1beta/lfp_sale_service/client.rb +433 -0
  13. data/lib/google/shopping/merchant/lfp/v1beta/lfp_sale_service/credentials.rb +49 -0
  14. data/lib/google/shopping/merchant/lfp/v1beta/lfp_sale_service/paths.rb +52 -0
  15. data/lib/google/shopping/merchant/lfp/v1beta/lfp_sale_service/rest/client.rb +400 -0
  16. data/lib/google/shopping/merchant/lfp/v1beta/lfp_sale_service/rest/service_stub.rb +131 -0
  17. data/lib/google/shopping/merchant/lfp/v1beta/lfp_sale_service/rest.rb +56 -0
  18. data/lib/google/shopping/merchant/lfp/v1beta/lfp_sale_service.rb +59 -0
  19. data/lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/client.rb +734 -0
  20. data/lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/credentials.rb +49 -0
  21. data/lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/paths.rb +68 -0
  22. data/lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/rest/client.rb +680 -0
  23. data/lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/rest/service_stub.rb +308 -0
  24. data/lib/google/shopping/merchant/lfp/v1beta/lfp_store_service/rest.rb +56 -0
  25. data/lib/google/shopping/merchant/lfp/v1beta/lfp_store_service.rb +59 -0
  26. data/lib/google/shopping/merchant/lfp/v1beta/lfpinventory_pb.rb +54 -0
  27. data/lib/google/shopping/merchant/lfp/v1beta/lfpinventory_services_pb.rb +51 -0
  28. data/lib/google/shopping/merchant/lfp/v1beta/lfpsale_pb.rb +55 -0
  29. data/lib/google/shopping/merchant/lfp/v1beta/lfpsale_services_pb.rb +49 -0
  30. data/lib/google/shopping/merchant/lfp/v1beta/lfpstore_pb.rb +56 -0
  31. data/lib/google/shopping/merchant/lfp/v1beta/lfpstore_services_pb.rb +57 -0
  32. data/lib/google/shopping/merchant/lfp/v1beta/rest.rb +41 -0
  33. data/lib/google/shopping/merchant/lfp/v1beta/version.rb +7 -2
  34. data/lib/google/shopping/merchant/lfp/v1beta.rb +49 -0
  35. data/lib/google-shopping-merchant-lfp-v1beta.rb +21 -0
  36. data/proto_docs/README.md +4 -0
  37. data/proto_docs/google/api/client.rb +399 -0
  38. data/proto_docs/google/api/field_behavior.rb +85 -0
  39. data/proto_docs/google/api/field_info.rb +65 -0
  40. data/proto_docs/google/api/launch_stage.rb +71 -0
  41. data/proto_docs/google/api/resource.rb +222 -0
  42. data/proto_docs/google/protobuf/duration.rb +98 -0
  43. data/proto_docs/google/protobuf/empty.rb +34 -0
  44. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  45. data/proto_docs/google/shopping/merchant/lfp/v1beta/lfpinventory.rb +113 -0
  46. data/proto_docs/google/shopping/merchant/lfp/v1beta/lfpsale.rb +96 -0
  47. data/proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb +185 -0
  48. data/proto_docs/google/shopping/type/types.rb +183 -0
  49. metadata +108 -10
@@ -0,0 +1,56 @@
1
+ # frozen_string_literal: true
2
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
3
+ # source: google/shopping/merchant/lfp/v1beta/lfpstore.proto
4
+
5
+ require 'google/protobuf'
6
+
7
+ require 'google/api/annotations_pb'
8
+ require 'google/api/client_pb'
9
+ require 'google/api/field_behavior_pb'
10
+ require 'google/api/resource_pb'
11
+ require 'google/protobuf/empty_pb'
12
+
13
+
14
+ descriptor_data = "\n2google/shopping/merchant/lfp/v1beta/lfpstore.proto\x12#google.shopping.merchant.lfp.v1beta\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1bgoogle/protobuf/empty.proto\"\xe6\x05\n\x08LfpStore\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xe0\x41\x03\xe0\x41\x08\x12\x1b\n\x0etarget_account\x18\x02 \x01(\x03\x42\x03\xe0\x41\x02\x12\x1a\n\nstore_code\x18\x03 \x01(\tB\x06\xe0\x41\x02\xe0\x41\x05\x12\x1a\n\rstore_address\x18\x04 \x01(\tB\x03\xe0\x41\x02\x12\x1c\n\nstore_name\x18\x05 \x01(\tB\x03\xe0\x41\x01H\x00\x88\x01\x01\x12\x1e\n\x0cphone_number\x18\x06 \x01(\tB\x03\xe0\x41\x01H\x01\x88\x01\x01\x12\x1d\n\x0bwebsite_uri\x18\x07 \x01(\tB\x03\xe0\x41\x01H\x02\x88\x01\x01\x12\x1a\n\rgcid_category\x18\x08 \x03(\tB\x03\xe0\x41\x01\x12\x1a\n\x08place_id\x18\t \x01(\tB\x03\xe0\x41\x01H\x03\x88\x01\x01\x12`\n\x0ematching_state\x18\n \x01(\x0e\x32@.google.shopping.merchant.lfp.v1beta.LfpStore.StoreMatchingStateB\x06\xe0\x41\x01\xe0\x41\x03\x12(\n\x13matching_state_hint\x18\x0b \x01(\tB\x06\xe0\x41\x01\xe0\x41\x03H\x04\x88\x01\x01\"}\n\x12StoreMatchingState\x12$\n STORE_MATCHING_STATE_UNSPECIFIED\x10\x00\x12 \n\x1cSTORE_MATCHING_STATE_MATCHED\x10\x01\x12\x1f\n\x1bSTORE_MATCHING_STATE_FAILED\x10\x02:z\xea\x41w\n#merchantapi.googleapis.com/LfpStore\x12;accounts/{account}/lfpStores/{target_merchant}~{store_code}*\tlfpStores2\x08lfpStoreB\r\n\x0b_store_nameB\x0f\n\r_phone_numberB\x0e\n\x0c_website_uriB\x0b\n\t_place_idB\x16\n\x14_matching_state_hint\"O\n\x12GetLfpStoreRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#merchantapi.googleapis.com/LfpStore\"\x9b\x01\n\x15InsertLfpStoreRequest\x12;\n\x06parent\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\x12#merchantapi.googleapis.com/LfpStore\x12\x45\n\tlfp_store\x18\x02 \x01(\x0b\x32-.google.shopping.merchant.lfp.v1beta.LfpStoreB\x03\xe0\x41\x02\"R\n\x15\x44\x65leteLfpStoreRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#merchantapi.googleapis.com/LfpStore\"\xa1\x01\n\x14ListLfpStoresRequest\x12;\n\x06parent\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\x12#merchantapi.googleapis.com/LfpStore\x12\x1b\n\x0etarget_account\x18\x02 \x01(\x03\x42\x03\xe0\x41\x02\x12\x16\n\tpage_size\x18\x03 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x04 \x01(\tB\x03\xe0\x41\x01\"s\n\x15ListLfpStoresResponse\x12\x41\n\nlfp_stores\x18\x01 \x03(\x0b\x32-.google.shopping.merchant.lfp.v1beta.LfpStore\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t2\xc8\x06\n\x0fLfpStoreService\x12\xaf\x01\n\x0bGetLfpStore\x12\x37.google.shopping.merchant.lfp.v1beta.GetLfpStoreRequest\x1a-.google.shopping.merchant.lfp.v1beta.LfpStore\"8\xda\x41\x04name\x82\xd3\xe4\x93\x02+\x12)/lfp/v1beta/{name=accounts/*/lfpStores/*}\x12\xd3\x01\n\x0eInsertLfpStore\x12:.google.shopping.merchant.lfp.v1beta.InsertLfpStoreRequest\x1a-.google.shopping.merchant.lfp.v1beta.LfpStore\"V\xda\x41\x10parent,lfp_store\x82\xd3\xe4\x93\x02=\"0/lfp/v1beta/{parent=accounts/*}/lfpStores:insert:\tlfp_store\x12\x9e\x01\n\x0e\x44\x65leteLfpStore\x12:.google.shopping.merchant.lfp.v1beta.DeleteLfpStoreRequest\x1a\x16.google.protobuf.Empty\"8\xda\x41\x04name\x82\xd3\xe4\x93\x02+*)/lfp/v1beta/{name=accounts/*/lfpStores/*}\x12\xc2\x01\n\rListLfpStores\x12\x39.google.shopping.merchant.lfp.v1beta.ListLfpStoresRequest\x1a:.google.shopping.merchant.lfp.v1beta.ListLfpStoresResponse\":\xda\x41\x06parent\x82\xd3\xe4\x93\x02+\x12)/lfp/v1beta/{parent=accounts/*}/lfpStores\x1aG\xca\x41\x1amerchantapi.googleapis.com\xd2\x41\'https://www.googleapis.com/auth/contentB{\n\'com.google.shopping.merchant.lfp.v1betaB\rLfpStoreProtoP\x01Z?cloud.google.com/go/shopping/merchant/lfp/apiv1beta/lfppb;lfppbb\x06proto3"
15
+
16
+ pool = Google::Protobuf::DescriptorPool.generated_pool
17
+
18
+ begin
19
+ pool.add_serialized_file(descriptor_data)
20
+ rescue TypeError
21
+ # Compatibility code: will be removed in the next major version.
22
+ require 'google/protobuf/descriptor_pb'
23
+ parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
24
+ parsed.clear_dependency
25
+ serialized = parsed.class.encode(parsed)
26
+ file = pool.add_serialized_file(serialized)
27
+ warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
28
+ imports = [
29
+ ]
30
+ imports.each do |type_name, expected_filename|
31
+ import_file = pool.lookup(type_name).file_descriptor
32
+ if import_file.name != expected_filename
33
+ warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
34
+ end
35
+ end
36
+ warn "Each proto file must use a consistent fully-qualified name."
37
+ warn "This will become an error in the next major version."
38
+ end
39
+
40
+ module Google
41
+ module Shopping
42
+ module Merchant
43
+ module Lfp
44
+ module V1beta
45
+ LfpStore = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.lfp.v1beta.LfpStore").msgclass
46
+ LfpStore::StoreMatchingState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.lfp.v1beta.LfpStore.StoreMatchingState").enummodule
47
+ GetLfpStoreRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.lfp.v1beta.GetLfpStoreRequest").msgclass
48
+ InsertLfpStoreRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.lfp.v1beta.InsertLfpStoreRequest").msgclass
49
+ DeleteLfpStoreRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.lfp.v1beta.DeleteLfpStoreRequest").msgclass
50
+ ListLfpStoresRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.lfp.v1beta.ListLfpStoresRequest").msgclass
51
+ ListLfpStoresResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.shopping.merchant.lfp.v1beta.ListLfpStoresResponse").msgclass
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,57 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/shopping/merchant/lfp/v1beta/lfpstore.proto for package 'google.shopping.merchant.lfp.v1beta'
3
+ # Original file comments:
4
+ # Copyright 2023 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/shopping/merchant/lfp/v1beta/lfpstore_pb'
21
+
22
+ module Google
23
+ module Shopping
24
+ module Merchant
25
+ module Lfp
26
+ module V1beta
27
+ module LfpStoreService
28
+ # Service for a [LFP
29
+ # partner](https://support.google.com/merchants/answer/7676652) to submit local
30
+ # stores for a merchant.
31
+ class Service
32
+
33
+ include ::GRPC::GenericService
34
+
35
+ self.marshal_class_method = :encode
36
+ self.unmarshal_class_method = :decode
37
+ self.service_name = 'google.shopping.merchant.lfp.v1beta.LfpStoreService'
38
+
39
+ # Retrieves information about a store.
40
+ rpc :GetLfpStore, ::Google::Shopping::Merchant::Lfp::V1beta::GetLfpStoreRequest, ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore
41
+ # Inserts a store for the target merchant. If the store with the same store
42
+ # code already exists, it will be replaced.
43
+ rpc :InsertLfpStore, ::Google::Shopping::Merchant::Lfp::V1beta::InsertLfpStoreRequest, ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore
44
+ # Deletes a store for a target merchant.
45
+ rpc :DeleteLfpStore, ::Google::Shopping::Merchant::Lfp::V1beta::DeleteLfpStoreRequest, ::Google::Protobuf::Empty
46
+ # Lists the stores of the target merchant, specified by the filter in
47
+ # `ListLfpStoresRequest`.
48
+ rpc :ListLfpStores, ::Google::Shopping::Merchant::Lfp::V1beta::ListLfpStoresRequest, ::Google::Shopping::Merchant::Lfp::V1beta::ListLfpStoresResponse
49
+ end
50
+
51
+ Stub = Service.rpc_stub_class
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,41 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/shopping/merchant/lfp/v1beta/lfp_inventory_service/rest"
20
+ require "google/shopping/merchant/lfp/v1beta/lfp_sale_service/rest"
21
+ require "google/shopping/merchant/lfp/v1beta/lfp_store_service/rest"
22
+ require "google/shopping/merchant/lfp/v1beta/version"
23
+
24
+ module Google
25
+ module Shopping
26
+ module Merchant
27
+ module Lfp
28
+ ##
29
+ # To load just the REST part of this package, including all its services, and instantiate a REST client:
30
+ #
31
+ # @example
32
+ #
33
+ # require "google/shopping/merchant/lfp/v1beta/rest"
34
+ # client = ::Google::Shopping::Merchant::Lfp::V1beta::LfpInventoryService::Rest::Client.new
35
+ #
36
+ module V1beta
37
+ end
38
+ end
39
+ end
40
+ end
41
+ end
@@ -1,10 +1,12 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Copyright 2024 Google LLC
2
4
  #
3
5
  # Licensed under the Apache License, Version 2.0 (the "License");
4
6
  # you may not use this file except in compliance with the License.
5
7
  # You may obtain a copy of the License at
6
8
  #
7
- # http://www.apache.org/licenses/LICENSE-2.0
9
+ # https://www.apache.org/licenses/LICENSE-2.0
8
10
  #
9
11
  # Unless required by applicable law or agreed to in writing, software
10
12
  # distributed under the License is distributed on an "AS IS" BASIS,
@@ -12,12 +14,15 @@
12
14
  # See the License for the specific language governing permissions and
13
15
  # limitations under the License.
14
16
 
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
15
20
  module Google
16
21
  module Shopping
17
22
  module Merchant
18
23
  module Lfp
19
24
  module V1beta
20
- VERSION = "0.a"
25
+ VERSION = "0.1.0"
21
26
  end
22
27
  end
23
28
  end
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/shopping/merchant/lfp/v1beta/lfp_inventory_service"
20
+ require "google/shopping/merchant/lfp/v1beta/lfp_sale_service"
21
+ require "google/shopping/merchant/lfp/v1beta/lfp_store_service"
22
+ require "google/shopping/merchant/lfp/v1beta/version"
23
+
24
+ module Google
25
+ module Shopping
26
+ module Merchant
27
+ module Lfp
28
+ ##
29
+ # API client module.
30
+ #
31
+ # @example Load this package, including all its services, and instantiate a gRPC client
32
+ #
33
+ # require "google/shopping/merchant/lfp/v1beta"
34
+ # client = ::Google::Shopping::Merchant::Lfp::V1beta::LfpInventoryService::Client.new
35
+ #
36
+ # @example Load this package, including all its services, and instantiate a REST client
37
+ #
38
+ # require "google/shopping/merchant/lfp/v1beta"
39
+ # client = ::Google::Shopping::Merchant::Lfp::V1beta::LfpInventoryService::Rest::Client.new
40
+ #
41
+ module V1beta
42
+ end
43
+ end
44
+ end
45
+ end
46
+ end
47
+
48
+ helper_path = ::File.join __dir__, "v1beta", "_helpers.rb"
49
+ require "google/shopping/merchant/lfp/v1beta/_helpers" if ::File.file? helper_path
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/shopping/merchant/lfp/v1beta"
@@ -0,0 +1,4 @@
1
+ # Merchant V1BETA Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,399 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
25
+ # @return [::String]
26
+ # Link to automatically generated reference documentation. Example:
27
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
28
+ # @!attribute [rw] destinations
29
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
30
+ # The destination where API teams want this client library to be published.
31
+ class CommonLanguageSettings
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+ end
35
+
36
+ # Details about how and where to publish client libraries.
37
+ # @!attribute [rw] version
38
+ # @return [::String]
39
+ # Version of the API to apply these settings to. This is the full protobuf
40
+ # package for the API, ending in the version element.
41
+ # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
42
+ # @!attribute [rw] launch_stage
43
+ # @return [::Google::Api::LaunchStage]
44
+ # Launch stage of this version of the API.
45
+ # @!attribute [rw] rest_numeric_enums
46
+ # @return [::Boolean]
47
+ # When using transport=rest, the client request will encode enums as
48
+ # numbers rather than strings.
49
+ # @!attribute [rw] java_settings
50
+ # @return [::Google::Api::JavaSettings]
51
+ # Settings for legacy Java features, supported in the Service YAML.
52
+ # @!attribute [rw] cpp_settings
53
+ # @return [::Google::Api::CppSettings]
54
+ # Settings for C++ client libraries.
55
+ # @!attribute [rw] php_settings
56
+ # @return [::Google::Api::PhpSettings]
57
+ # Settings for PHP client libraries.
58
+ # @!attribute [rw] python_settings
59
+ # @return [::Google::Api::PythonSettings]
60
+ # Settings for Python client libraries.
61
+ # @!attribute [rw] node_settings
62
+ # @return [::Google::Api::NodeSettings]
63
+ # Settings for Node client libraries.
64
+ # @!attribute [rw] dotnet_settings
65
+ # @return [::Google::Api::DotnetSettings]
66
+ # Settings for .NET client libraries.
67
+ # @!attribute [rw] ruby_settings
68
+ # @return [::Google::Api::RubySettings]
69
+ # Settings for Ruby client libraries.
70
+ # @!attribute [rw] go_settings
71
+ # @return [::Google::Api::GoSettings]
72
+ # Settings for Go client libraries.
73
+ class ClientLibrarySettings
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+
78
+ # This message configures the settings for publishing [Google Cloud Client
79
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
80
+ # generated from the service config.
81
+ # @!attribute [rw] method_settings
82
+ # @return [::Array<::Google::Api::MethodSettings>]
83
+ # A list of API method settings, e.g. the behavior for methods that use the
84
+ # long-running operation pattern.
85
+ # @!attribute [rw] new_issue_uri
86
+ # @return [::String]
87
+ # Link to a *public* URI where users can report issues. Example:
88
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
89
+ # @!attribute [rw] documentation_uri
90
+ # @return [::String]
91
+ # Link to product home page. Example:
92
+ # https://cloud.google.com/asset-inventory/docs/overview
93
+ # @!attribute [rw] api_short_name
94
+ # @return [::String]
95
+ # Used as a tracking tag when collecting data about the APIs developer
96
+ # relations artifacts like docs, packages delivered to package managers,
97
+ # etc. Example: "speech".
98
+ # @!attribute [rw] github_label
99
+ # @return [::String]
100
+ # GitHub label to apply to issues and pull requests opened for this API.
101
+ # @!attribute [rw] codeowner_github_teams
102
+ # @return [::Array<::String>]
103
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
104
+ # containing source code for the client libraries for this API.
105
+ # @!attribute [rw] doc_tag_prefix
106
+ # @return [::String]
107
+ # A prefix used in sample code when demarking regions to be included in
108
+ # documentation.
109
+ # @!attribute [rw] organization
110
+ # @return [::Google::Api::ClientLibraryOrganization]
111
+ # For whom the client library is being published.
112
+ # @!attribute [rw] library_settings
113
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
114
+ # Client library settings. If the same version string appears multiple
115
+ # times in this list, then the last one wins. Settings from earlier
116
+ # settings with the same version string are discarded.
117
+ # @!attribute [rw] proto_reference_documentation_uri
118
+ # @return [::String]
119
+ # Optional link to proto reference documentation. Example:
120
+ # https://cloud.google.com/pubsub/lite/docs/reference/rpc
121
+ # @!attribute [rw] rest_reference_documentation_uri
122
+ # @return [::String]
123
+ # Optional link to REST reference documentation. Example:
124
+ # https://cloud.google.com/pubsub/lite/docs/reference/rest
125
+ class Publishing
126
+ include ::Google::Protobuf::MessageExts
127
+ extend ::Google::Protobuf::MessageExts::ClassMethods
128
+ end
129
+
130
+ # Settings for Java client libraries.
131
+ # @!attribute [rw] library_package
132
+ # @return [::String]
133
+ # The package name to use in Java. Clobbers the java_package option
134
+ # set in the protobuf. This should be used **only** by APIs
135
+ # who have already set the language_settings.java.package_name" field
136
+ # in gapic.yaml. API teams should use the protobuf java_package option
137
+ # where possible.
138
+ #
139
+ # Example of a YAML configuration::
140
+ #
141
+ # publishing:
142
+ # java_settings:
143
+ # library_package: com.google.cloud.pubsub.v1
144
+ # @!attribute [rw] service_class_names
145
+ # @return [::Google::Protobuf::Map{::String => ::String}]
146
+ # Configure the Java class name to use instead of the service's for its
147
+ # corresponding generated GAPIC client. Keys are fully-qualified
148
+ # service names as they appear in the protobuf (including the full
149
+ # the language_settings.java.interface_names" field in gapic.yaml. API
150
+ # teams should otherwise use the service name as it appears in the
151
+ # protobuf.
152
+ #
153
+ # Example of a YAML configuration::
154
+ #
155
+ # publishing:
156
+ # java_settings:
157
+ # service_class_names:
158
+ # - google.pubsub.v1.Publisher: TopicAdmin
159
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
160
+ # @!attribute [rw] common
161
+ # @return [::Google::Api::CommonLanguageSettings]
162
+ # Some settings.
163
+ class JavaSettings
164
+ include ::Google::Protobuf::MessageExts
165
+ extend ::Google::Protobuf::MessageExts::ClassMethods
166
+
167
+ # @!attribute [rw] key
168
+ # @return [::String]
169
+ # @!attribute [rw] value
170
+ # @return [::String]
171
+ class ServiceClassNamesEntry
172
+ include ::Google::Protobuf::MessageExts
173
+ extend ::Google::Protobuf::MessageExts::ClassMethods
174
+ end
175
+ end
176
+
177
+ # Settings for C++ client libraries.
178
+ # @!attribute [rw] common
179
+ # @return [::Google::Api::CommonLanguageSettings]
180
+ # Some settings.
181
+ class CppSettings
182
+ include ::Google::Protobuf::MessageExts
183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
184
+ end
185
+
186
+ # Settings for Php client libraries.
187
+ # @!attribute [rw] common
188
+ # @return [::Google::Api::CommonLanguageSettings]
189
+ # Some settings.
190
+ class PhpSettings
191
+ include ::Google::Protobuf::MessageExts
192
+ extend ::Google::Protobuf::MessageExts::ClassMethods
193
+ end
194
+
195
+ # Settings for Python client libraries.
196
+ # @!attribute [rw] common
197
+ # @return [::Google::Api::CommonLanguageSettings]
198
+ # Some settings.
199
+ class PythonSettings
200
+ include ::Google::Protobuf::MessageExts
201
+ extend ::Google::Protobuf::MessageExts::ClassMethods
202
+ end
203
+
204
+ # Settings for Node client libraries.
205
+ # @!attribute [rw] common
206
+ # @return [::Google::Api::CommonLanguageSettings]
207
+ # Some settings.
208
+ class NodeSettings
209
+ include ::Google::Protobuf::MessageExts
210
+ extend ::Google::Protobuf::MessageExts::ClassMethods
211
+ end
212
+
213
+ # Settings for Dotnet client libraries.
214
+ # @!attribute [rw] common
215
+ # @return [::Google::Api::CommonLanguageSettings]
216
+ # Some settings.
217
+ # @!attribute [rw] renamed_services
218
+ # @return [::Google::Protobuf::Map{::String => ::String}]
219
+ # Map from original service names to renamed versions.
220
+ # This is used when the default generated types
221
+ # would cause a naming conflict. (Neither name is
222
+ # fully-qualified.)
223
+ # Example: Subscriber to SubscriberServiceApi.
224
+ # @!attribute [rw] renamed_resources
225
+ # @return [::Google::Protobuf::Map{::String => ::String}]
226
+ # Map from full resource types to the effective short name
227
+ # for the resource. This is used when otherwise resource
228
+ # named from different services would cause naming collisions.
229
+ # Example entry:
230
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
231
+ # @!attribute [rw] ignored_resources
232
+ # @return [::Array<::String>]
233
+ # List of full resource types to ignore during generation.
234
+ # This is typically used for API-specific Location resources,
235
+ # which should be handled by the generator as if they were actually
236
+ # the common Location resources.
237
+ # Example entry: "documentai.googleapis.com/Location"
238
+ # @!attribute [rw] forced_namespace_aliases
239
+ # @return [::Array<::String>]
240
+ # Namespaces which must be aliased in snippets due to
241
+ # a known (but non-generator-predictable) naming collision
242
+ # @!attribute [rw] handwritten_signatures
243
+ # @return [::Array<::String>]
244
+ # Method signatures (in the form "service.method(signature)")
245
+ # which are provided separately, so shouldn't be generated.
246
+ # Snippets *calling* these methods are still generated, however.
247
+ class DotnetSettings
248
+ include ::Google::Protobuf::MessageExts
249
+ extend ::Google::Protobuf::MessageExts::ClassMethods
250
+
251
+ # @!attribute [rw] key
252
+ # @return [::String]
253
+ # @!attribute [rw] value
254
+ # @return [::String]
255
+ class RenamedServicesEntry
256
+ include ::Google::Protobuf::MessageExts
257
+ extend ::Google::Protobuf::MessageExts::ClassMethods
258
+ end
259
+
260
+ # @!attribute [rw] key
261
+ # @return [::String]
262
+ # @!attribute [rw] value
263
+ # @return [::String]
264
+ class RenamedResourcesEntry
265
+ include ::Google::Protobuf::MessageExts
266
+ extend ::Google::Protobuf::MessageExts::ClassMethods
267
+ end
268
+ end
269
+
270
+ # Settings for Ruby client libraries.
271
+ # @!attribute [rw] common
272
+ # @return [::Google::Api::CommonLanguageSettings]
273
+ # Some settings.
274
+ class RubySettings
275
+ include ::Google::Protobuf::MessageExts
276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
277
+ end
278
+
279
+ # Settings for Go client libraries.
280
+ # @!attribute [rw] common
281
+ # @return [::Google::Api::CommonLanguageSettings]
282
+ # Some settings.
283
+ class GoSettings
284
+ include ::Google::Protobuf::MessageExts
285
+ extend ::Google::Protobuf::MessageExts::ClassMethods
286
+ end
287
+
288
+ # Describes the generator configuration for a method.
289
+ # @!attribute [rw] selector
290
+ # @return [::String]
291
+ # The fully qualified name of the method, for which the options below apply.
292
+ # This is used to find the method to apply the options.
293
+ # @!attribute [rw] long_running
294
+ # @return [::Google::Api::MethodSettings::LongRunning]
295
+ # Describes settings to use for long-running operations when generating
296
+ # API methods for RPCs. Complements RPCs that use the annotations in
297
+ # google/longrunning/operations.proto.
298
+ #
299
+ # Example of a YAML configuration::
300
+ #
301
+ # publishing:
302
+ # method_settings:
303
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
304
+ # long_running:
305
+ # initial_poll_delay:
306
+ # seconds: 60 # 1 minute
307
+ # poll_delay_multiplier: 1.5
308
+ # max_poll_delay:
309
+ # seconds: 360 # 6 minutes
310
+ # total_poll_timeout:
311
+ # seconds: 54000 # 90 minutes
312
+ # @!attribute [rw] auto_populated_fields
313
+ # @return [::Array<::String>]
314
+ # List of top-level fields of the request message, that should be
315
+ # automatically populated by the client libraries based on their
316
+ # (google.api.field_info).format. Currently supported format: UUID4.
317
+ #
318
+ # Example of a YAML configuration:
319
+ #
320
+ # publishing:
321
+ # method_settings:
322
+ # - selector: google.example.v1.ExampleService.CreateExample
323
+ # auto_populated_fields:
324
+ # - request_id
325
+ class MethodSettings
326
+ include ::Google::Protobuf::MessageExts
327
+ extend ::Google::Protobuf::MessageExts::ClassMethods
328
+
329
+ # Describes settings to use when generating API methods that use the
330
+ # long-running operation pattern.
331
+ # All default values below are from those used in the client library
332
+ # generators (e.g.
333
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
334
+ # @!attribute [rw] initial_poll_delay
335
+ # @return [::Google::Protobuf::Duration]
336
+ # Initial delay after which the first poll request will be made.
337
+ # Default value: 5 seconds.
338
+ # @!attribute [rw] poll_delay_multiplier
339
+ # @return [::Float]
340
+ # Multiplier to gradually increase delay between subsequent polls until it
341
+ # reaches max_poll_delay.
342
+ # Default value: 1.5.
343
+ # @!attribute [rw] max_poll_delay
344
+ # @return [::Google::Protobuf::Duration]
345
+ # Maximum time between two subsequent poll requests.
346
+ # Default value: 45 seconds.
347
+ # @!attribute [rw] total_poll_timeout
348
+ # @return [::Google::Protobuf::Duration]
349
+ # Total polling timeout.
350
+ # Default value: 5 minutes.
351
+ class LongRunning
352
+ include ::Google::Protobuf::MessageExts
353
+ extend ::Google::Protobuf::MessageExts::ClassMethods
354
+ end
355
+ end
356
+
357
+ # The organization for which the client libraries are being published.
358
+ # Affects the url where generated docs are published, etc.
359
+ module ClientLibraryOrganization
360
+ # Not useful.
361
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
362
+
363
+ # Google Cloud Platform Org.
364
+ CLOUD = 1
365
+
366
+ # Ads (Advertising) Org.
367
+ ADS = 2
368
+
369
+ # Photos Org.
370
+ PHOTOS = 3
371
+
372
+ # Street View Org.
373
+ STREET_VIEW = 4
374
+
375
+ # Shopping Org.
376
+ SHOPPING = 5
377
+
378
+ # Geo Org.
379
+ GEO = 6
380
+
381
+ # Generative AI - https://developers.generativeai.google
382
+ GENERATIVE_AI = 7
383
+ end
384
+
385
+ # To where should client libraries be published?
386
+ module ClientLibraryDestination
387
+ # Client libraries will neither be generated nor published to package
388
+ # managers.
389
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
390
+
391
+ # Generate the client library in a repo under github.com/googleapis,
392
+ # but don't publish it to package managers.
393
+ GITHUB = 10
394
+
395
+ # Publish the library to package managers like nuget.org and npmjs.com.
396
+ PACKAGE_MANAGER = 20
397
+ end
398
+ end
399
+ end