google-cloud-retail-v2 0.11.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +1 -1
  3. data/README.md +1 -1
  4. data/lib/google/cloud/retail/v2/catalog_pb.rb +14 -0
  5. data/lib/google/cloud/retail/v2/catalog_service/client.rb +1 -1
  6. data/lib/google/cloud/retail/v2/catalog_service.rb +1 -1
  7. data/lib/google/cloud/retail/v2/completion_service/client.rb +7 -5
  8. data/lib/google/cloud/retail/v2/completion_service.rb +2 -2
  9. data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +3 -3
  10. data/lib/google/cloud/retail/v2/control_service.rb +1 -1
  11. data/lib/google/cloud/retail/v2/prediction_service/client.rb +7 -8
  12. data/lib/google/cloud/retail/v2/prediction_service.rb +1 -1
  13. data/lib/google/cloud/retail/v2/prediction_service_pb.rb +1 -0
  14. data/lib/google/cloud/retail/v2/product_service/client.rb +48 -38
  15. data/lib/google/cloud/retail/v2/product_service.rb +1 -1
  16. data/lib/google/cloud/retail/v2/product_service_services_pb.rb +48 -38
  17. data/lib/google/cloud/retail/v2/search_service/client.rb +4 -4
  18. data/lib/google/cloud/retail/v2/search_service.rb +2 -2
  19. data/lib/google/cloud/retail/v2/search_service_services_pb.rb +2 -2
  20. data/lib/google/cloud/retail/v2/serving_config_pb.rb +7 -0
  21. data/lib/google/cloud/retail/v2/serving_config_service/client.rb +5 -5
  22. data/lib/google/cloud/retail/v2/serving_config_service.rb +1 -1
  23. data/lib/google/cloud/retail/v2/user_event_service/client.rb +25 -12
  24. data/lib/google/cloud/retail/v2/user_event_service.rb +1 -1
  25. data/lib/google/cloud/retail/v2/user_event_service_pb.rb +6 -0
  26. data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +8 -8
  27. data/lib/google/cloud/retail/v2/version.rb +1 -1
  28. data/lib/google/cloud/retail/v2.rb +2 -2
  29. data/proto_docs/google/api/client.rb +318 -0
  30. data/proto_docs/google/api/launch_stage.rb +71 -0
  31. data/proto_docs/google/cloud/retail/v2/catalog.rb +51 -13
  32. data/proto_docs/google/cloud/retail/v2/catalog_service.rb +1 -1
  33. data/proto_docs/google/cloud/retail/v2/common.rb +5 -3
  34. data/proto_docs/google/cloud/retail/v2/completion_service.rb +4 -2
  35. data/proto_docs/google/cloud/retail/v2/control.rb +2 -3
  36. data/proto_docs/google/cloud/retail/v2/prediction_service.rb +7 -8
  37. data/proto_docs/google/cloud/retail/v2/product.rb +27 -5
  38. data/proto_docs/google/cloud/retail/v2/search_service.rb +15 -8
  39. data/proto_docs/google/cloud/retail/v2/serving_config.rb +32 -15
  40. data/proto_docs/google/cloud/retail/v2/serving_config_service.rb +5 -5
  41. data/proto_docs/google/cloud/retail/v2/user_event.rb +1 -1
  42. data/proto_docs/google/cloud/retail/v2/user_event_service.rb +24 -8
  43. data/proto_docs/google/rpc/status.rb +4 -2
  44. metadata +6 -4
@@ -27,7 +27,7 @@ module Google
27
27
  # Service for search.
28
28
  #
29
29
  # This feature is only available for users who have Retail Search enabled.
30
- # Please enable Retail Search on Cloud Console before using this feature.
30
+ # Enable Retail Search on Cloud Console before using this feature.
31
31
  class Service
32
32
 
33
33
  include ::GRPC::GenericService
@@ -39,7 +39,7 @@ module Google
39
39
  # Performs a search.
40
40
  #
41
41
  # This feature is only available for users who have Retail Search enabled.
42
- # Please enable Retail Search on Cloud Console before using this feature.
42
+ # Enable Retail Search on Cloud Console before using this feature.
43
43
  rpc :Search, ::Google::Cloud::Retail::V2::SearchRequest, ::Google::Cloud::Retail::V2::SearchResponse
44
44
  end
45
45
 
@@ -26,10 +26,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
26
26
  repeated :replacement_control_ids, :string, 14
27
27
  repeated :ignore_control_ids, :string, 15
28
28
  optional :diversity_level, :string, 8
29
+ optional :diversity_type, :enum, 20, "google.cloud.retail.v2.ServingConfig.DiversityType"
29
30
  optional :enable_category_filter_level, :string, 16
30
31
  optional :personalization_spec, :message, 21, "google.cloud.retail.v2.SearchRequest.PersonalizationSpec"
31
32
  repeated :solution_types, :enum, 19, "google.cloud.retail.v2.SolutionType"
32
33
  end
34
+ add_enum "google.cloud.retail.v2.ServingConfig.DiversityType" do
35
+ value :DIVERSITY_TYPE_UNSPECIFIED, 0
36
+ value :RULE_BASED_DIVERSITY, 2
37
+ value :DATA_DRIVEN_DIVERSITY, 3
38
+ end
33
39
  end
34
40
  end
35
41
 
@@ -38,6 +44,7 @@ module Google
38
44
  module Retail
39
45
  module V2
40
46
  ServingConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ServingConfig").msgclass
47
+ ServingConfig::DiversityType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ServingConfig.DiversityType").enummodule
41
48
  end
42
49
  end
43
50
  end
@@ -264,7 +264,7 @@ module Google
264
264
  #
265
265
  # @param name [::String]
266
266
  # Required. The resource name of the ServingConfig to delete. Format:
267
- # projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
267
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
268
268
  #
269
269
  # @yield [response, operation] Access the result along with the RPC operation
270
270
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -445,7 +445,7 @@ module Google
445
445
  #
446
446
  # @param name [::String]
447
447
  # Required. The resource name of the ServingConfig to get. Format:
448
- # projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
448
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
449
449
  #
450
450
  # @yield [response, operation] Access the result along with the RPC operation
451
451
  # @yieldparam response [::Google::Cloud::Retail::V2::ServingConfig]
@@ -531,7 +531,7 @@ module Google
531
531
  #
532
532
  # @param parent [::String]
533
533
  # Required. The catalog resource name. Format:
534
- # projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}
534
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
535
535
  # @param page_size [::Integer]
536
536
  # Optional. Maximum number of results to return. If unspecified, defaults
537
537
  # to 100. If a value greater than 100 is provided, at most 100 results are
@@ -637,7 +637,7 @@ module Google
637
637
  #
638
638
  # @param serving_config [::String]
639
639
  # Required. The source ServingConfig resource name . Format:
640
- # projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
640
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
641
641
  # @param control_id [::String]
642
642
  # Required. The id of the control to apply. Assumed to be in the same catalog
643
643
  # as the serving config - if id is not found a NOT_FOUND error is returned.
@@ -729,7 +729,7 @@ module Google
729
729
  #
730
730
  # @param serving_config [::String]
731
731
  # Required. The source ServingConfig resource name . Format:
732
- # projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
732
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
733
733
  # @param control_id [::String]
734
734
  # Required. The id of the control to apply. Assumed to be in the same catalog
735
735
  # as the serving config.
@@ -33,7 +33,7 @@ module Google
33
33
  ##
34
34
  # Service for modifying ServingConfig.
35
35
  #
36
- # To load this service and instantiate a client:
36
+ # @example Load this service and instantiate a gRPC client
37
37
  #
38
38
  # require "google/cloud/retail/v2/serving_config_service"
39
39
  # client = ::Google::Cloud::Retail::V2::ServingConfigService::Client.new
@@ -185,7 +185,7 @@ module Google
185
185
  # @param options [::Gapic::CallOptions, ::Hash]
186
186
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
187
187
  #
188
- # @overload write_user_event(parent: nil, user_event: nil)
188
+ # @overload write_user_event(parent: nil, user_event: nil, write_async: nil)
189
189
  # Pass arguments to `write_user_event` via keyword arguments. Note that at
190
190
  # least one keyword argument is required. To specify no parameters, or to keep all
191
191
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -195,6 +195,11 @@ module Google
195
195
  # `projects/1234/locations/global/catalogs/default_catalog`.
196
196
  # @param user_event [::Google::Cloud::Retail::V2::UserEvent, ::Hash]
197
197
  # Required. User event to write.
198
+ # @param write_async [::Boolean]
199
+ # If set to true, the user event will be written asynchronously after
200
+ # validation, and the API will respond without waiting for the write.
201
+ # Therefore, silent failures can occur even if the API returns success. In
202
+ # case of silent failures, error messages can be found in Stackdriver logs.
198
203
  #
199
204
  # @yield [response, operation] Access the result along with the RPC operation
200
205
  # @yieldparam response [::Google::Cloud::Retail::V2::UserEvent]
@@ -277,11 +282,14 @@ module Google
277
282
  # @param options [::Gapic::CallOptions, ::Hash]
278
283
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
279
284
  #
280
- # @overload collect_user_event(parent: nil, user_event: nil, uri: nil, ets: nil)
285
+ # @overload collect_user_event(prebuilt_rule: nil, parent: nil, user_event: nil, uri: nil, ets: nil, raw_json: nil)
281
286
  # Pass arguments to `collect_user_event` via keyword arguments. Note that at
282
287
  # least one keyword argument is required. To specify no parameters, or to keep all
283
288
  # the default parameter values, pass an empty Hash as a request object (see above).
284
289
  #
290
+ # @param prebuilt_rule [::String]
291
+ # The prebuilt rule name that can convert a specific type of raw_json.
292
+ # For example: "default_schema/v1.0"
285
293
  # @param parent [::String]
286
294
  # Required. The parent catalog name, such as
287
295
  # `projects/1234/locations/global/catalogs/default_catalog`.
@@ -297,6 +305,11 @@ module Google
297
305
  # The event timestamp in milliseconds. This prevents browser caching of
298
306
  # otherwise identical get requests. The name is abbreviated to reduce the
299
307
  # payload bytes.
308
+ # @param raw_json [::String]
309
+ # An arbitrary serialized JSON string that contains necessary information
310
+ # that can comprise a user event. When this field is specified, the
311
+ # user_event field will be ignored. Note: line-delimited JSON is not
312
+ # supported, a single JSON only.
300
313
  #
301
314
  # @yield [response, operation] Access the result along with the RPC operation
302
315
  # @yieldparam response [::Google::Api::HttpBody]
@@ -593,14 +606,14 @@ module Google
593
606
  end
594
607
 
595
608
  ##
596
- # Starts a user event rejoin operation with latest product catalog. Events
597
- # will not be annotated with detailed product information if product is
598
- # missing from the catalog at the time the user event is ingested, and these
599
- # events are stored as unjoined events with a limited usage on training and
600
- # serving. This method can be used to start a join operation on specified
601
- # events with latest version of product catalog. It can also be used to
602
- # correct events joined with the wrong product catalog. A rejoin operation
603
- # can take hours or days to complete.
609
+ # Starts a user-event rejoin operation with latest product catalog. Events
610
+ # are not annotated with detailed product information for products that are
611
+ # missing from the catalog when the user event is ingested. These
612
+ # events are stored as unjoined events with limited usage on training and
613
+ # serving. You can use this method to start a join operation on specified
614
+ # events with the latest version of product catalog. You can also use this
615
+ # method to correct events joined with the wrong product catalog. A rejoin
616
+ # operation can take hours or days to complete.
604
617
  #
605
618
  # @overload rejoin_user_events(request, options = nil)
606
619
  # Pass arguments to `rejoin_user_events` via a request object, either of type
@@ -623,8 +636,8 @@ module Google
623
636
  # @param user_event_rejoin_scope [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
624
637
  # The type of the user event rejoin to define the scope and range of the user
625
638
  # events to be rejoined with the latest product catalog. Defaults to
626
- # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
627
- # invalid integer value.
639
+ # `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to
640
+ # an invalid integer value.
628
641
  #
629
642
  # @yield [response, operation] Access the result along with the RPC operation
630
643
  # @yieldparam response [::Gapic::Operation]
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # Service for ingesting end user actions on the customer website.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/retail/v2/user_event_service"
40
40
  # client = ::Google::Cloud::Retail::V2::UserEventService::Client.new
@@ -7,6 +7,7 @@ require 'google/api/annotations_pb'
7
7
  require 'google/api/client_pb'
8
8
  require 'google/api/field_behavior_pb'
9
9
  require 'google/api/httpbody_pb'
10
+ require 'google/api/resource_pb'
10
11
  require 'google/cloud/retail/v2/import_config_pb'
11
12
  require 'google/cloud/retail/v2/purge_config_pb'
12
13
  require 'google/cloud/retail/v2/user_event_pb'
@@ -17,12 +18,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
17
18
  add_message "google.cloud.retail.v2.WriteUserEventRequest" do
18
19
  optional :parent, :string, 1
19
20
  optional :user_event, :message, 2, "google.cloud.retail.v2.UserEvent"
21
+ optional :write_async, :bool, 3
20
22
  end
21
23
  add_message "google.cloud.retail.v2.CollectUserEventRequest" do
22
24
  optional :parent, :string, 1
23
25
  optional :user_event, :string, 2
24
26
  optional :uri, :string, 3
25
27
  optional :ets, :int64, 4
28
+ optional :raw_json, :string, 5
29
+ oneof :conversion_rule do
30
+ optional :prebuilt_rule, :string, 6
31
+ end
26
32
  end
27
33
  add_message "google.cloud.retail.v2.RejoinUserEventsRequest" do
28
34
  optional :parent, :string, 1
@@ -54,14 +54,14 @@ module Google
54
54
  # possible for a subset of the items to be successfully inserted.
55
55
  # `Operation.metadata` is of type `ImportMetadata`.
56
56
  rpc :ImportUserEvents, ::Google::Cloud::Retail::V2::ImportUserEventsRequest, ::Google::Longrunning::Operation
57
- # Starts a user event rejoin operation with latest product catalog. Events
58
- # will not be annotated with detailed product information if product is
59
- # missing from the catalog at the time the user event is ingested, and these
60
- # events are stored as unjoined events with a limited usage on training and
61
- # serving. This method can be used to start a join operation on specified
62
- # events with latest version of product catalog. It can also be used to
63
- # correct events joined with the wrong product catalog. A rejoin operation
64
- # can take hours or days to complete.
57
+ # Starts a user-event rejoin operation with latest product catalog. Events
58
+ # are not annotated with detailed product information for products that are
59
+ # missing from the catalog when the user event is ingested. These
60
+ # events are stored as unjoined events with limited usage on training and
61
+ # serving. You can use this method to start a join operation on specified
62
+ # events with the latest version of product catalog. You can also use this
63
+ # method to correct events joined with the wrong product catalog. A rejoin
64
+ # operation can take hours or days to complete.
65
65
  rpc :RejoinUserEvents, ::Google::Cloud::Retail::V2::RejoinUserEventsRequest, ::Google::Longrunning::Operation
66
66
  end
67
67
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Retail
23
23
  module V2
24
- VERSION = "0.11.0"
24
+ VERSION = "0.12.0"
25
25
  end
26
26
  end
27
27
  end
@@ -30,9 +30,9 @@ module Google
30
30
  module Cloud
31
31
  module Retail
32
32
  ##
33
- # To load this package, including all its services, and instantiate a client:
33
+ # API client module.
34
34
  #
35
- # @example
35
+ # @example Load this package, including all its services, and instantiate a gRPC client
36
36
  #
37
37
  # require "google/cloud/retail/v2"
38
38
  # client = ::Google::Cloud::Retail::V2::CatalogService::Client.new
@@ -0,0 +1,318 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end