google-cloud-discovery_engine-v1beta 0.11.0 → 0.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (164) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +9 -3
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +13 -5
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +9 -3
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +35 -6
  6. data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +875 -0
  7. data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb +47 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb +167 -0
  9. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +814 -0
  10. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb +440 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest.rb +55 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/control_service.rb +58 -0
  13. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +31 -15
  14. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +31 -15
  15. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +15 -7
  16. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +13 -5
  17. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +15 -7
  18. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +35 -6
  19. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +24 -15
  20. data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +13 -5
  21. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +24 -15
  22. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +35 -6
  23. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +19 -8
  24. data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +13 -5
  25. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +19 -8
  26. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +35 -6
  27. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +824 -0
  28. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/credentials.rb +47 -0
  29. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +809 -0
  30. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/paths.rb +250 -0
  31. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +770 -0
  32. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +1106 -0
  33. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/service_stub.rb +306 -0
  34. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest.rb +54 -0
  35. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service.rb +57 -0
  36. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +25 -3
  37. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +25 -3
  38. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +485 -0
  39. data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +809 -0
  41. data/lib/google/cloud/discovery_engine/v1beta/project_service/paths.rb +47 -0
  42. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +452 -0
  43. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +1106 -0
  44. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +129 -0
  45. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest.rb +54 -0
  46. data/lib/google/cloud/discovery_engine/v1beta/project_service.rb +57 -0
  47. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +24 -2
  48. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +24 -2
  49. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +24 -19
  50. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/paths.rb +66 -0
  51. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +24 -19
  52. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +5 -0
  53. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +1035 -0
  54. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/credentials.rb +47 -0
  55. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +809 -0
  56. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/paths.rb +73 -0
  57. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +967 -0
  58. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +1106 -0
  59. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/service_stub.rb +426 -0
  60. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest.rb +54 -0
  61. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service.rb +57 -0
  62. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +911 -0
  63. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials.rb +47 -0
  64. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/paths.rb +69 -0
  65. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client.rb +850 -0
  66. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/service_stub.rb +366 -0
  67. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest.rb +53 -0
  68. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service.rb +56 -0
  69. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +18 -10
  70. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +13 -5
  71. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +18 -10
  72. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +35 -6
  73. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +25 -12
  74. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +25 -12
  75. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +104 -2
  76. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +13 -5
  77. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +97 -2
  78. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +35 -6
  79. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +59 -0
  80. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +9 -3
  81. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +9 -3
  82. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +27 -12
  83. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +13 -5
  84. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +27 -12
  85. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +35 -6
  86. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +23 -6
  87. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +13 -5
  88. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/paths.rb +21 -0
  89. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +23 -6
  90. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +35 -6
  91. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
  92. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  93. data/lib/google/cloud/discovery_engine/v1beta.rb +5 -0
  94. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +3 -1
  95. data/lib/google/cloud/discoveryengine/v1beta/chunk_pb.rb +50 -0
  96. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
  97. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +55 -0
  98. data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +57 -0
  99. data/lib/google/cloud/discoveryengine/v1beta/control_service_services_pb.rb +69 -0
  100. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
  101. data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +48 -0
  102. data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +4 -1
  103. data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +1 -1
  104. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
  105. data/lib/google/cloud/discoveryengine/v1beta/evaluation_pb.rb +56 -0
  106. data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_pb.rb +59 -0
  107. data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_services_pb.rb +57 -0
  108. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +1 -1
  109. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +1 -1
  110. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +7 -1
  111. data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +49 -0
  112. data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +50 -0
  113. data/lib/google/cloud/discoveryengine/v1beta/project_service_services_pb.rb +51 -0
  114. data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +1 -1
  115. data/lib/google/cloud/discoveryengine/v1beta/sample_query_pb.rb +49 -0
  116. data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_pb.rb +59 -0
  117. data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_services_pb.rb +63 -0
  118. data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_pb.rb +47 -0
  119. data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_pb.rb +57 -0
  120. data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_services_pb.rb +59 -0
  121. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +5 -1
  122. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +5 -1
  123. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_services_pb.rb +2 -0
  124. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
  125. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  126. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
  127. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +1 -1
  128. data/proto_docs/google/api/client.rb +14 -10
  129. data/proto_docs/google/api/resource.rb +7 -2
  130. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +9 -1
  131. data/proto_docs/google/cloud/discoveryengine/v1beta/chunk.rb +119 -0
  132. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +16 -0
  133. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +209 -0
  134. data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +126 -0
  135. data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +2 -2
  136. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +29 -5
  137. data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +75 -0
  138. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +2 -2
  139. data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +1 -1
  140. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +44 -2
  141. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +6 -7
  142. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +3 -3
  143. data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb +223 -0
  144. data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation_service.rb +194 -0
  145. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +39 -1
  146. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +3 -0
  147. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +89 -4
  148. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +106 -0
  149. data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +57 -0
  150. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +28 -0
  151. data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +20 -19
  152. data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb +82 -0
  153. data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_service.rb +179 -0
  154. data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set.rb +57 -0
  155. data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set_service.rb +186 -0
  156. data/proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb +5 -5
  157. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +95 -28
  158. data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +31 -0
  159. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +11 -5
  160. data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +4 -1
  161. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +3 -0
  162. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +24 -3
  163. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +13 -1
  164. metadata +72 -2
@@ -0,0 +1,850 @@
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/cloud/errors"
20
+ require "google/cloud/discoveryengine/v1beta/sample_query_set_service_pb"
21
+ require "google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/service_stub"
22
+ require "google/cloud/location/rest"
23
+
24
+ module Google
25
+ module Cloud
26
+ module DiscoveryEngine
27
+ module V1beta
28
+ module SampleQuerySetService
29
+ module Rest
30
+ ##
31
+ # REST client for the SampleQuerySetService service.
32
+ #
33
+ # Service for managing
34
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s,
35
+ #
36
+ class Client
37
+ # @private
38
+ API_VERSION = ""
39
+
40
+ # @private
41
+ DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
42
+
43
+ include Paths
44
+
45
+ # @private
46
+ attr_reader :sample_query_set_service_stub
47
+
48
+ ##
49
+ # Configure the SampleQuerySetService Client class.
50
+ #
51
+ # See {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client::Configuration}
52
+ # for a description of the configuration fields.
53
+ #
54
+ # @example
55
+ #
56
+ # # Modify the configuration for all SampleQuerySetService clients
57
+ # ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.configure do |config|
58
+ # config.timeout = 10.0
59
+ # end
60
+ #
61
+ # @yield [config] Configure the Client client.
62
+ # @yieldparam config [Client::Configuration]
63
+ #
64
+ # @return [Client::Configuration]
65
+ #
66
+ def self.configure
67
+ @configure ||= begin
68
+ namespace = ["Google", "Cloud", "DiscoveryEngine", "V1beta"]
69
+ parent_config = while namespace.any?
70
+ parent_name = namespace.join "::"
71
+ parent_const = const_get parent_name
72
+ break parent_const.configure if parent_const.respond_to? :configure
73
+ namespace.pop
74
+ end
75
+ default_config = Client::Configuration.new parent_config
76
+
77
+ default_config.timeout = 30.0
78
+ default_config.retry_policy = {
79
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
80
+ }
81
+
82
+ default_config
83
+ end
84
+ yield @configure if block_given?
85
+ @configure
86
+ end
87
+
88
+ ##
89
+ # Configure the SampleQuerySetService Client instance.
90
+ #
91
+ # The configuration is set to the derived mode, meaning that values can be changed,
92
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
93
+ # should be made on {Client.configure}.
94
+ #
95
+ # See {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client::Configuration}
96
+ # for a description of the configuration fields.
97
+ #
98
+ # @yield [config] Configure the Client client.
99
+ # @yieldparam config [Client::Configuration]
100
+ #
101
+ # @return [Client::Configuration]
102
+ #
103
+ def configure
104
+ yield @config if block_given?
105
+ @config
106
+ end
107
+
108
+ ##
109
+ # The effective universe domain
110
+ #
111
+ # @return [String]
112
+ #
113
+ def universe_domain
114
+ @sample_query_set_service_stub.universe_domain
115
+ end
116
+
117
+ ##
118
+ # Create a new SampleQuerySetService REST client object.
119
+ #
120
+ # @example
121
+ #
122
+ # # Create a client using the default configuration
123
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new
124
+ #
125
+ # # Create a client using a custom configuration
126
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new do |config|
127
+ # config.timeout = 10.0
128
+ # end
129
+ #
130
+ # @yield [config] Configure the SampleQuerySetService client.
131
+ # @yieldparam config [Client::Configuration]
132
+ #
133
+ def initialize
134
+ # Create the configuration object
135
+ @config = Configuration.new Client.configure
136
+
137
+ # Yield the configuration if needed
138
+ yield @config if block_given?
139
+
140
+ # Create credentials
141
+ credentials = @config.credentials
142
+ # Use self-signed JWT if the endpoint is unchanged from default,
143
+ # but only if the default endpoint does not have a region prefix.
144
+ enable_self_signed_jwt = @config.endpoint.nil? ||
145
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
146
+ !@config.endpoint.split(".").first.include?("-"))
147
+ credentials ||= Credentials.default scope: @config.scope,
148
+ enable_self_signed_jwt: enable_self_signed_jwt
149
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
150
+ credentials = Credentials.new credentials, scope: @config.scope
151
+ end
152
+
153
+ @quota_project_id = @config.quota_project
154
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
155
+
156
+ @sample_query_set_service_stub = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::ServiceStub.new(
157
+ endpoint: @config.endpoint,
158
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
159
+ universe_domain: @config.universe_domain,
160
+ credentials: credentials
161
+ )
162
+
163
+ @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
164
+ config.credentials = credentials
165
+ config.quota_project = @quota_project_id
166
+ config.endpoint = @sample_query_set_service_stub.endpoint
167
+ config.universe_domain = @sample_query_set_service_stub.universe_domain
168
+ end
169
+ end
170
+
171
+ ##
172
+ # Get the associated client for mix-in of the Locations.
173
+ #
174
+ # @return [Google::Cloud::Location::Locations::Rest::Client]
175
+ #
176
+ attr_reader :location_client
177
+
178
+ # Service calls
179
+
180
+ ##
181
+ # Gets a
182
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}.
183
+ #
184
+ # @overload get_sample_query_set(request, options = nil)
185
+ # Pass arguments to `get_sample_query_set` via a request object, either of type
186
+ # {::Google::Cloud::DiscoveryEngine::V1beta::GetSampleQuerySetRequest} or an equivalent Hash.
187
+ #
188
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::GetSampleQuerySetRequest, ::Hash]
189
+ # A request object representing the call parameters. Required. To specify no
190
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
191
+ # @param options [::Gapic::CallOptions, ::Hash]
192
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
193
+ #
194
+ # @overload get_sample_query_set(name: nil)
195
+ # Pass arguments to `get_sample_query_set` via keyword arguments. Note that at
196
+ # least one keyword argument is required. To specify no parameters, or to keep all
197
+ # the default parameter values, pass an empty Hash as a request object (see above).
198
+ #
199
+ # @param name [::String]
200
+ # Required. Full resource name of
201
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, such
202
+ # as
203
+ # `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
204
+ #
205
+ # If the caller does not have permission to access the
206
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
207
+ # regardless of whether or not it exists, a PERMISSION_DENIED error is
208
+ # returned.
209
+ #
210
+ # If the requested
211
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet} does
212
+ # not exist, a NOT_FOUND error is returned.
213
+ # @yield [result, operation] Access the result along with the TransportOperation object
214
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
215
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
216
+ #
217
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
218
+ #
219
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
220
+ #
221
+ # @example Basic example
222
+ # require "google/cloud/discovery_engine/v1beta"
223
+ #
224
+ # # Create a client object. The client can be reused for multiple calls.
225
+ # client = Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new
226
+ #
227
+ # # Create a request. To set request fields, pass in keyword arguments.
228
+ # request = Google::Cloud::DiscoveryEngine::V1beta::GetSampleQuerySetRequest.new
229
+ #
230
+ # # Call the get_sample_query_set method.
231
+ # result = client.get_sample_query_set request
232
+ #
233
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet.
234
+ # p result
235
+ #
236
+ def get_sample_query_set request, options = nil
237
+ raise ::ArgumentError, "request must be provided" if request.nil?
238
+
239
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::GetSampleQuerySetRequest
240
+
241
+ # Converts hash and nil to an options object
242
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
243
+
244
+ # Customize the options with defaults
245
+ call_metadata = @config.rpcs.get_sample_query_set.metadata.to_h
246
+
247
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
248
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
249
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
250
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
251
+ transports_version_send: [:rest]
252
+
253
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
254
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
255
+
256
+ options.apply_defaults timeout: @config.rpcs.get_sample_query_set.timeout,
257
+ metadata: call_metadata,
258
+ retry_policy: @config.rpcs.get_sample_query_set.retry_policy
259
+
260
+ options.apply_defaults timeout: @config.timeout,
261
+ metadata: @config.metadata,
262
+ retry_policy: @config.retry_policy
263
+
264
+ @sample_query_set_service_stub.get_sample_query_set request, options do |result, operation|
265
+ yield result, operation if block_given?
266
+ return result
267
+ end
268
+ rescue ::Gapic::Rest::Error => e
269
+ raise ::Google::Cloud::Error.from_error(e)
270
+ end
271
+
272
+ ##
273
+ # Gets a list of
274
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s.
275
+ #
276
+ # @overload list_sample_query_sets(request, options = nil)
277
+ # Pass arguments to `list_sample_query_sets` via a request object, either of type
278
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsRequest} or an equivalent Hash.
279
+ #
280
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsRequest, ::Hash]
281
+ # A request object representing the call parameters. Required. To specify no
282
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
283
+ # @param options [::Gapic::CallOptions, ::Hash]
284
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
285
+ #
286
+ # @overload list_sample_query_sets(parent: nil, page_size: nil, page_token: nil)
287
+ # Pass arguments to `list_sample_query_sets` via keyword arguments. Note that at
288
+ # least one keyword argument is required. To specify no parameters, or to keep all
289
+ # the default parameter values, pass an empty Hash as a request object (see above).
290
+ #
291
+ # @param parent [::String]
292
+ # Required. The parent location resource name, such as
293
+ # `projects/{project}/locations/{location}`.
294
+ #
295
+ # If the caller does not have permission to list
296
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s under
297
+ # this location, regardless of whether or not this location exists, a
298
+ # `PERMISSION_DENIED` error is returned.
299
+ # @param page_size [::Integer]
300
+ # Maximum number of
301
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s to
302
+ # return. If unspecified, defaults to 100. The maximum allowed value is 1000.
303
+ # Values above 1000 will be coerced to 1000.
304
+ #
305
+ # If this field is negative, an `INVALID_ARGUMENT` error is returned.
306
+ # @param page_token [::String]
307
+ # A page token
308
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsResponse#next_page_token ListSampleQuerySetsResponse.next_page_token},
309
+ # received from a previous
310
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
311
+ # call. Provide this to retrieve the subsequent page.
312
+ #
313
+ # When paginating, all other parameters provided to
314
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
315
+ # must match the call that provided the page token. Otherwise, an
316
+ # `INVALID_ARGUMENT` error is returned.
317
+ # @yield [result, operation] Access the result along with the TransportOperation object
318
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet>]
319
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
320
+ #
321
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet>]
322
+ #
323
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
324
+ #
325
+ # @example Basic example
326
+ # require "google/cloud/discovery_engine/v1beta"
327
+ #
328
+ # # Create a client object. The client can be reused for multiple calls.
329
+ # client = Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new
330
+ #
331
+ # # Create a request. To set request fields, pass in keyword arguments.
332
+ # request = Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsRequest.new
333
+ #
334
+ # # Call the list_sample_query_sets method.
335
+ # result = client.list_sample_query_sets request
336
+ #
337
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
338
+ # # over elements, and API calls will be issued to fetch pages as needed.
339
+ # result.each do |item|
340
+ # # Each element is of type ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet.
341
+ # p item
342
+ # end
343
+ #
344
+ def list_sample_query_sets request, options = nil
345
+ raise ::ArgumentError, "request must be provided" if request.nil?
346
+
347
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsRequest
348
+
349
+ # Converts hash and nil to an options object
350
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
351
+
352
+ # Customize the options with defaults
353
+ call_metadata = @config.rpcs.list_sample_query_sets.metadata.to_h
354
+
355
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
356
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
357
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
358
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
359
+ transports_version_send: [:rest]
360
+
361
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
362
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
363
+
364
+ options.apply_defaults timeout: @config.rpcs.list_sample_query_sets.timeout,
365
+ metadata: call_metadata,
366
+ retry_policy: @config.rpcs.list_sample_query_sets.retry_policy
367
+
368
+ options.apply_defaults timeout: @config.timeout,
369
+ metadata: @config.metadata,
370
+ retry_policy: @config.retry_policy
371
+
372
+ @sample_query_set_service_stub.list_sample_query_sets request, options do |result, operation|
373
+ result = ::Gapic::Rest::PagedEnumerable.new @sample_query_set_service_stub, :list_sample_query_sets, "sample_query_sets", request, result, options
374
+ yield result, operation if block_given?
375
+ return result
376
+ end
377
+ rescue ::Gapic::Rest::Error => e
378
+ raise ::Google::Cloud::Error.from_error(e)
379
+ end
380
+
381
+ ##
382
+ # Creates a
383
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
384
+ #
385
+ # @overload create_sample_query_set(request, options = nil)
386
+ # Pass arguments to `create_sample_query_set` via a request object, either of type
387
+ # {::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQuerySetRequest} or an equivalent Hash.
388
+ #
389
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQuerySetRequest, ::Hash]
390
+ # A request object representing the call parameters. Required. To specify no
391
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
392
+ # @param options [::Gapic::CallOptions, ::Hash]
393
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
394
+ #
395
+ # @overload create_sample_query_set(parent: nil, sample_query_set: nil, sample_query_set_id: nil)
396
+ # Pass arguments to `create_sample_query_set` via keyword arguments. Note that at
397
+ # least one keyword argument is required. To specify no parameters, or to keep all
398
+ # the default parameter values, pass an empty Hash as a request object (see above).
399
+ #
400
+ # @param parent [::String]
401
+ # Required. The parent resource name, such as
402
+ # `projects/{project}/locations/{location}`.
403
+ # @param sample_query_set [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet, ::Hash]
404
+ # Required. The
405
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet} to
406
+ # create.
407
+ # @param sample_query_set_id [::String]
408
+ # Required. The ID to use for the
409
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, which
410
+ # will become the final component of the
411
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet#name SampleQuerySet.name}.
412
+ #
413
+ # If the caller does not have permission to create the
414
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
415
+ # regardless of whether or not it exists, a `PERMISSION_DENIED` error is
416
+ # returned.
417
+ #
418
+ # This field must be unique among all
419
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s with
420
+ # the same
421
+ # {::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQuerySetRequest#parent parent}.
422
+ # Otherwise, an `ALREADY_EXISTS` error is returned.
423
+ #
424
+ # This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
425
+ # standard with a length limit of 63 characters. Otherwise, an
426
+ # `INVALID_ARGUMENT` error is returned.
427
+ # @yield [result, operation] Access the result along with the TransportOperation object
428
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
429
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
430
+ #
431
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
432
+ #
433
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
434
+ #
435
+ # @example Basic example
436
+ # require "google/cloud/discovery_engine/v1beta"
437
+ #
438
+ # # Create a client object. The client can be reused for multiple calls.
439
+ # client = Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new
440
+ #
441
+ # # Create a request. To set request fields, pass in keyword arguments.
442
+ # request = Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQuerySetRequest.new
443
+ #
444
+ # # Call the create_sample_query_set method.
445
+ # result = client.create_sample_query_set request
446
+ #
447
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet.
448
+ # p result
449
+ #
450
+ def create_sample_query_set request, options = nil
451
+ raise ::ArgumentError, "request must be provided" if request.nil?
452
+
453
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQuerySetRequest
454
+
455
+ # Converts hash and nil to an options object
456
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
457
+
458
+ # Customize the options with defaults
459
+ call_metadata = @config.rpcs.create_sample_query_set.metadata.to_h
460
+
461
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
462
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
463
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
464
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
465
+ transports_version_send: [:rest]
466
+
467
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
468
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
469
+
470
+ options.apply_defaults timeout: @config.rpcs.create_sample_query_set.timeout,
471
+ metadata: call_metadata,
472
+ retry_policy: @config.rpcs.create_sample_query_set.retry_policy
473
+
474
+ options.apply_defaults timeout: @config.timeout,
475
+ metadata: @config.metadata,
476
+ retry_policy: @config.retry_policy
477
+
478
+ @sample_query_set_service_stub.create_sample_query_set request, options do |result, operation|
479
+ yield result, operation if block_given?
480
+ return result
481
+ end
482
+ rescue ::Gapic::Rest::Error => e
483
+ raise ::Google::Cloud::Error.from_error(e)
484
+ end
485
+
486
+ ##
487
+ # Updates a
488
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}.
489
+ #
490
+ # @overload update_sample_query_set(request, options = nil)
491
+ # Pass arguments to `update_sample_query_set` via a request object, either of type
492
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UpdateSampleQuerySetRequest} or an equivalent Hash.
493
+ #
494
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::UpdateSampleQuerySetRequest, ::Hash]
495
+ # A request object representing the call parameters. Required. To specify no
496
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
497
+ # @param options [::Gapic::CallOptions, ::Hash]
498
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
499
+ #
500
+ # @overload update_sample_query_set(sample_query_set: nil, update_mask: nil)
501
+ # Pass arguments to `update_sample_query_set` via keyword arguments. Note that at
502
+ # least one keyword argument is required. To specify no parameters, or to keep all
503
+ # the default parameter values, pass an empty Hash as a request object (see above).
504
+ #
505
+ # @param sample_query_set [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet, ::Hash]
506
+ # Required. The sample query set to update.
507
+ #
508
+ # If the caller does not have permission to update the
509
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
510
+ # regardless of whether or not it exists, a `PERMISSION_DENIED` error is
511
+ # returned.
512
+ #
513
+ # If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
514
+ # to update does not exist a `NOT_FOUND` error is returned.
515
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
516
+ # Indicates which fields in the provided imported 'sample query set' to
517
+ # update. If not set, will by default update all fields.
518
+ # @yield [result, operation] Access the result along with the TransportOperation object
519
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
520
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
521
+ #
522
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
523
+ #
524
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
525
+ #
526
+ # @example Basic example
527
+ # require "google/cloud/discovery_engine/v1beta"
528
+ #
529
+ # # Create a client object. The client can be reused for multiple calls.
530
+ # client = Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new
531
+ #
532
+ # # Create a request. To set request fields, pass in keyword arguments.
533
+ # request = Google::Cloud::DiscoveryEngine::V1beta::UpdateSampleQuerySetRequest.new
534
+ #
535
+ # # Call the update_sample_query_set method.
536
+ # result = client.update_sample_query_set request
537
+ #
538
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet.
539
+ # p result
540
+ #
541
+ def update_sample_query_set request, options = nil
542
+ raise ::ArgumentError, "request must be provided" if request.nil?
543
+
544
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::UpdateSampleQuerySetRequest
545
+
546
+ # Converts hash and nil to an options object
547
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
548
+
549
+ # Customize the options with defaults
550
+ call_metadata = @config.rpcs.update_sample_query_set.metadata.to_h
551
+
552
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
553
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
554
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
555
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
556
+ transports_version_send: [:rest]
557
+
558
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
559
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
560
+
561
+ options.apply_defaults timeout: @config.rpcs.update_sample_query_set.timeout,
562
+ metadata: call_metadata,
563
+ retry_policy: @config.rpcs.update_sample_query_set.retry_policy
564
+
565
+ options.apply_defaults timeout: @config.timeout,
566
+ metadata: @config.metadata,
567
+ retry_policy: @config.retry_policy
568
+
569
+ @sample_query_set_service_stub.update_sample_query_set request, options do |result, operation|
570
+ yield result, operation if block_given?
571
+ return result
572
+ end
573
+ rescue ::Gapic::Rest::Error => e
574
+ raise ::Google::Cloud::Error.from_error(e)
575
+ end
576
+
577
+ ##
578
+ # Deletes a
579
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}.
580
+ #
581
+ # @overload delete_sample_query_set(request, options = nil)
582
+ # Pass arguments to `delete_sample_query_set` via a request object, either of type
583
+ # {::Google::Cloud::DiscoveryEngine::V1beta::DeleteSampleQuerySetRequest} or an equivalent Hash.
584
+ #
585
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::DeleteSampleQuerySetRequest, ::Hash]
586
+ # A request object representing the call parameters. Required. To specify no
587
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
588
+ # @param options [::Gapic::CallOptions, ::Hash]
589
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
590
+ #
591
+ # @overload delete_sample_query_set(name: nil)
592
+ # Pass arguments to `delete_sample_query_set` via keyword arguments. Note that at
593
+ # least one keyword argument is required. To specify no parameters, or to keep all
594
+ # the default parameter values, pass an empty Hash as a request object (see above).
595
+ #
596
+ # @param name [::String]
597
+ # Required. Full resource name of
598
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, such
599
+ # as
600
+ # `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
601
+ #
602
+ # If the caller does not have permission to delete the
603
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
604
+ # regardless of whether or not it exists, a `PERMISSION_DENIED` error is
605
+ # returned.
606
+ #
607
+ # If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
608
+ # to delete does not exist, a `NOT_FOUND` error is returned.
609
+ # @yield [result, operation] Access the result along with the TransportOperation object
610
+ # @yieldparam result [::Google::Protobuf::Empty]
611
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
612
+ #
613
+ # @return [::Google::Protobuf::Empty]
614
+ #
615
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
616
+ #
617
+ # @example Basic example
618
+ # require "google/cloud/discovery_engine/v1beta"
619
+ #
620
+ # # Create a client object. The client can be reused for multiple calls.
621
+ # client = Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new
622
+ #
623
+ # # Create a request. To set request fields, pass in keyword arguments.
624
+ # request = Google::Cloud::DiscoveryEngine::V1beta::DeleteSampleQuerySetRequest.new
625
+ #
626
+ # # Call the delete_sample_query_set method.
627
+ # result = client.delete_sample_query_set request
628
+ #
629
+ # # The returned object is of type Google::Protobuf::Empty.
630
+ # p result
631
+ #
632
+ def delete_sample_query_set request, options = nil
633
+ raise ::ArgumentError, "request must be provided" if request.nil?
634
+
635
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::DeleteSampleQuerySetRequest
636
+
637
+ # Converts hash and nil to an options object
638
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
639
+
640
+ # Customize the options with defaults
641
+ call_metadata = @config.rpcs.delete_sample_query_set.metadata.to_h
642
+
643
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
644
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
645
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
646
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
647
+ transports_version_send: [:rest]
648
+
649
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
650
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
651
+
652
+ options.apply_defaults timeout: @config.rpcs.delete_sample_query_set.timeout,
653
+ metadata: call_metadata,
654
+ retry_policy: @config.rpcs.delete_sample_query_set.retry_policy
655
+
656
+ options.apply_defaults timeout: @config.timeout,
657
+ metadata: @config.metadata,
658
+ retry_policy: @config.retry_policy
659
+
660
+ @sample_query_set_service_stub.delete_sample_query_set request, options do |result, operation|
661
+ yield result, operation if block_given?
662
+ return result
663
+ end
664
+ rescue ::Gapic::Rest::Error => e
665
+ raise ::Google::Cloud::Error.from_error(e)
666
+ end
667
+
668
+ ##
669
+ # Configuration class for the SampleQuerySetService REST API.
670
+ #
671
+ # This class represents the configuration for SampleQuerySetService REST,
672
+ # providing control over timeouts, retry behavior, logging, transport
673
+ # parameters, and other low-level controls. Certain parameters can also be
674
+ # applied individually to specific RPCs. See
675
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client::Configuration::Rpcs}
676
+ # for a list of RPCs that can be configured independently.
677
+ #
678
+ # Configuration can be applied globally to all clients, or to a single client
679
+ # on construction.
680
+ #
681
+ # @example
682
+ #
683
+ # # Modify the global config, setting the timeout for
684
+ # # get_sample_query_set to 20 seconds,
685
+ # # and all remaining timeouts to 10 seconds.
686
+ # ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.configure do |config|
687
+ # config.timeout = 10.0
688
+ # config.rpcs.get_sample_query_set.timeout = 20.0
689
+ # end
690
+ #
691
+ # # Apply the above configuration only to a new client.
692
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new do |config|
693
+ # config.timeout = 10.0
694
+ # config.rpcs.get_sample_query_set.timeout = 20.0
695
+ # end
696
+ #
697
+ # @!attribute [rw] endpoint
698
+ # A custom service endpoint, as a hostname or hostname:port. The default is
699
+ # nil, indicating to use the default endpoint in the current universe domain.
700
+ # @return [::String,nil]
701
+ # @!attribute [rw] credentials
702
+ # Credentials to send with calls. You may provide any of the following types:
703
+ # * (`String`) The path to a service account key file in JSON format
704
+ # * (`Hash`) A service account key as a Hash
705
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
706
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
707
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
708
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
709
+ # * (`nil`) indicating no credentials
710
+ # @return [::Object]
711
+ # @!attribute [rw] scope
712
+ # The OAuth scopes
713
+ # @return [::Array<::String>]
714
+ # @!attribute [rw] lib_name
715
+ # The library name as recorded in instrumentation and logging
716
+ # @return [::String]
717
+ # @!attribute [rw] lib_version
718
+ # The library version as recorded in instrumentation and logging
719
+ # @return [::String]
720
+ # @!attribute [rw] timeout
721
+ # The call timeout in seconds.
722
+ # @return [::Numeric]
723
+ # @!attribute [rw] metadata
724
+ # Additional headers to be sent with the call.
725
+ # @return [::Hash{::Symbol=>::String}]
726
+ # @!attribute [rw] retry_policy
727
+ # The retry policy. The value is a hash with the following keys:
728
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
729
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
730
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
731
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
732
+ # trigger a retry.
733
+ # @return [::Hash]
734
+ # @!attribute [rw] quota_project
735
+ # A separate project against which to charge quota.
736
+ # @return [::String]
737
+ # @!attribute [rw] universe_domain
738
+ # The universe domain within which to make requests. This determines the
739
+ # default endpoint URL. The default value of nil uses the environment
740
+ # universe (usually the default "googleapis.com" universe).
741
+ # @return [::String,nil]
742
+ #
743
+ class Configuration
744
+ extend ::Gapic::Config
745
+
746
+ # @private
747
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
748
+ DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
749
+
750
+ config_attr :endpoint, nil, ::String, nil
751
+ config_attr :credentials, nil do |value|
752
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
753
+ allowed.any? { |klass| klass === value }
754
+ end
755
+ config_attr :scope, nil, ::String, ::Array, nil
756
+ config_attr :lib_name, nil, ::String, nil
757
+ config_attr :lib_version, nil, ::String, nil
758
+ config_attr :timeout, nil, ::Numeric, nil
759
+ config_attr :metadata, nil, ::Hash, nil
760
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
761
+ config_attr :quota_project, nil, ::String, nil
762
+ config_attr :universe_domain, nil, ::String, nil
763
+
764
+ # @private
765
+ def initialize parent_config = nil
766
+ @parent_config = parent_config unless parent_config.nil?
767
+
768
+ yield self if block_given?
769
+ end
770
+
771
+ ##
772
+ # Configurations for individual RPCs
773
+ # @return [Rpcs]
774
+ #
775
+ def rpcs
776
+ @rpcs ||= begin
777
+ parent_rpcs = nil
778
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
779
+ Rpcs.new parent_rpcs
780
+ end
781
+ end
782
+
783
+ ##
784
+ # Configuration RPC class for the SampleQuerySetService API.
785
+ #
786
+ # Includes fields providing the configuration for each RPC in this service.
787
+ # Each configuration object is of type `Gapic::Config::Method` and includes
788
+ # the following configuration fields:
789
+ #
790
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
791
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
792
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
793
+ # include the following keys:
794
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
795
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
796
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
797
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
798
+ # trigger a retry.
799
+ #
800
+ class Rpcs
801
+ ##
802
+ # RPC-specific configuration for `get_sample_query_set`
803
+ # @return [::Gapic::Config::Method]
804
+ #
805
+ attr_reader :get_sample_query_set
806
+ ##
807
+ # RPC-specific configuration for `list_sample_query_sets`
808
+ # @return [::Gapic::Config::Method]
809
+ #
810
+ attr_reader :list_sample_query_sets
811
+ ##
812
+ # RPC-specific configuration for `create_sample_query_set`
813
+ # @return [::Gapic::Config::Method]
814
+ #
815
+ attr_reader :create_sample_query_set
816
+ ##
817
+ # RPC-specific configuration for `update_sample_query_set`
818
+ # @return [::Gapic::Config::Method]
819
+ #
820
+ attr_reader :update_sample_query_set
821
+ ##
822
+ # RPC-specific configuration for `delete_sample_query_set`
823
+ # @return [::Gapic::Config::Method]
824
+ #
825
+ attr_reader :delete_sample_query_set
826
+
827
+ # @private
828
+ def initialize parent_rpcs = nil
829
+ get_sample_query_set_config = parent_rpcs.get_sample_query_set if parent_rpcs.respond_to? :get_sample_query_set
830
+ @get_sample_query_set = ::Gapic::Config::Method.new get_sample_query_set_config
831
+ list_sample_query_sets_config = parent_rpcs.list_sample_query_sets if parent_rpcs.respond_to? :list_sample_query_sets
832
+ @list_sample_query_sets = ::Gapic::Config::Method.new list_sample_query_sets_config
833
+ create_sample_query_set_config = parent_rpcs.create_sample_query_set if parent_rpcs.respond_to? :create_sample_query_set
834
+ @create_sample_query_set = ::Gapic::Config::Method.new create_sample_query_set_config
835
+ update_sample_query_set_config = parent_rpcs.update_sample_query_set if parent_rpcs.respond_to? :update_sample_query_set
836
+ @update_sample_query_set = ::Gapic::Config::Method.new update_sample_query_set_config
837
+ delete_sample_query_set_config = parent_rpcs.delete_sample_query_set if parent_rpcs.respond_to? :delete_sample_query_set
838
+ @delete_sample_query_set = ::Gapic::Config::Method.new delete_sample_query_set_config
839
+
840
+ yield self if block_given?
841
+ end
842
+ end
843
+ end
844
+ end
845
+ end
846
+ end
847
+ end
848
+ end
849
+ end
850
+ end