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