google-cloud-discovery_engine-v1beta 0.a → 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- 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 +1107 -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 +908 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +905 -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 +905 -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 +513 -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 +465 -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 +905 -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 +41 -0
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +38 -0
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +43 -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 +109 -0
- data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +40 -0
- data/lib/google/cloud/discoveryengine/v1beta/recommendation_service_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1beta/recommendation_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1beta/schema_pb.rb +30 -0
- data/lib/google/cloud/discoveryengine/v1beta/schema_service_pb.rb +72 -0
- data/lib/google/cloud/discoveryengine/v1beta/schema_service_services_pb.rb +53 -0
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +151 -0
- data/lib/google/cloud/discoveryengine/v1beta/search_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +93 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +39 -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 +286 -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 +605 -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 +141 -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 +129 -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,210 @@
|
|
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
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Request message for Recommend method.
|
25
|
+
# @!attribute [rw] serving_config
|
26
|
+
# @return [::String]
|
27
|
+
# Required. Full resource name of the format:
|
28
|
+
# `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
|
29
|
+
#
|
30
|
+
# Before you can request recommendations from your model, you must create at
|
31
|
+
# least one serving config for it.
|
32
|
+
# @!attribute [rw] user_event
|
33
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::UserEvent]
|
34
|
+
# Required. Context about the user, what they are looking at and what action
|
35
|
+
# they took to trigger the Recommend request. Note that this user event
|
36
|
+
# detail won't be ingested to userEvent logs. Thus, a separate userEvent
|
37
|
+
# write request is required for event logging.
|
38
|
+
#
|
39
|
+
# Don't set
|
40
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
|
41
|
+
# or
|
42
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserInfo#user_id UserEvent.user_info.user_id}
|
43
|
+
# to the same fixed ID for different users. If you are trying to receive
|
44
|
+
# non-personalized recommendations (not recommended; this can negatively
|
45
|
+
# impact model performance), instead set
|
46
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
|
47
|
+
# to a random unique ID and leave
|
48
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserInfo#user_id UserEvent.user_info.user_id}
|
49
|
+
# unset.
|
50
|
+
# @!attribute [rw] page_size
|
51
|
+
# @return [::Integer]
|
52
|
+
# Maximum number of results to return. Set this property
|
53
|
+
# to the number of recommendation results needed. If zero, the service will
|
54
|
+
# choose a reasonable default. The maximum allowed value is 100. Values
|
55
|
+
# above 100 will be coerced to 100.
|
56
|
+
# @!attribute [rw] filter
|
57
|
+
# @return [::String]
|
58
|
+
# Filter for restricting recommendation results with a length limit of 5,000
|
59
|
+
# characters. Currently, only filter expressions on the `filter_tags`
|
60
|
+
# attribute is supported.
|
61
|
+
#
|
62
|
+
#
|
63
|
+
# Examples:
|
64
|
+
#
|
65
|
+
# * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
|
66
|
+
# * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
|
67
|
+
#
|
68
|
+
# If your filter blocks all results, the API will return generic
|
69
|
+
# (unfiltered) popular Documents. If you only want results strictly matching
|
70
|
+
# the filters, set `strictFiltering` to True in
|
71
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}
|
72
|
+
# to receive empty results instead.
|
73
|
+
#
|
74
|
+
# Note that the API will never return
|
75
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s with
|
76
|
+
# `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
|
77
|
+
# @!attribute [rw] validate_only
|
78
|
+
# @return [::Boolean]
|
79
|
+
# Use validate only mode for this recommendation query. If set to true, a
|
80
|
+
# fake model will be used that returns arbitrary Document IDs.
|
81
|
+
# Note that the validate only mode should only be used for testing the API,
|
82
|
+
# or if the model is not ready.
|
83
|
+
# @!attribute [rw] params
|
84
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
|
85
|
+
# Additional domain specific parameters for the recommendations.
|
86
|
+
#
|
87
|
+
# Allowed values:
|
88
|
+
#
|
89
|
+
# * `returnDocument`: Boolean. If set to true, the associated Document
|
90
|
+
# object will be returned in
|
91
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult#document RecommendResponse.RecommendationResult.document}.
|
92
|
+
# * `returnScore`: Boolean. If set to true, the recommendation 'score'
|
93
|
+
# corresponding to each returned Document will be set in
|
94
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult#metadata RecommendResponse.RecommendationResult.metadata}.
|
95
|
+
# The given 'score' indicates the probability of a Document conversion
|
96
|
+
# given the user's context and history.
|
97
|
+
# * `strictFiltering`: Boolean. True by default. If set to false, the service
|
98
|
+
# will return generic (unfiltered) popular Documents instead of empty if
|
99
|
+
# your filter blocks all recommendation results.
|
100
|
+
# * `diversityLevel`: String. Default empty. If set to be non-empty, then
|
101
|
+
# it needs to be one of:
|
102
|
+
# * `no-diversity`
|
103
|
+
# * `low-diversity`
|
104
|
+
# * `medium-diversity`
|
105
|
+
# * `high-diversity`
|
106
|
+
# * `auto-diversity`
|
107
|
+
# This gives request-level control and adjusts recommendation results
|
108
|
+
# based on Document category.
|
109
|
+
# @!attribute [rw] user_labels
|
110
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
111
|
+
# The user labels applied to a resource must meet the following requirements:
|
112
|
+
#
|
113
|
+
# * Each resource can have multiple labels, up to a maximum of 64.
|
114
|
+
# * Each label must be a key-value pair.
|
115
|
+
# * Keys have a minimum length of 1 character and a maximum length of 63
|
116
|
+
# characters and cannot be empty. Values can be empty and have a maximum
|
117
|
+
# length of 63 characters.
|
118
|
+
# * Keys and values can contain only lowercase letters, numeric characters,
|
119
|
+
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
120
|
+
# international characters are allowed.
|
121
|
+
# * The key portion of a label must be unique. However, you can use the same
|
122
|
+
# key with multiple resources.
|
123
|
+
# * Keys must start with a lowercase letter or international character.
|
124
|
+
#
|
125
|
+
# See [Requirements for
|
126
|
+
# labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
127
|
+
# for more details.
|
128
|
+
class RecommendRequest
|
129
|
+
include ::Google::Protobuf::MessageExts
|
130
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
131
|
+
|
132
|
+
# @!attribute [rw] key
|
133
|
+
# @return [::String]
|
134
|
+
# @!attribute [rw] value
|
135
|
+
# @return [::Google::Protobuf::Value]
|
136
|
+
class ParamsEntry
|
137
|
+
include ::Google::Protobuf::MessageExts
|
138
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
139
|
+
end
|
140
|
+
|
141
|
+
# @!attribute [rw] key
|
142
|
+
# @return [::String]
|
143
|
+
# @!attribute [rw] value
|
144
|
+
# @return [::String]
|
145
|
+
class UserLabelsEntry
|
146
|
+
include ::Google::Protobuf::MessageExts
|
147
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
148
|
+
end
|
149
|
+
end
|
150
|
+
|
151
|
+
# Response message for Recommend method.
|
152
|
+
# @!attribute [rw] results
|
153
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult>]
|
154
|
+
# A list of recommended Documents. The order represents the ranking (from the
|
155
|
+
# most relevant Document to the least).
|
156
|
+
# @!attribute [rw] attribution_token
|
157
|
+
# @return [::String]
|
158
|
+
# A unique attribution token. This should be included in the
|
159
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent UserEvent} logs resulting
|
160
|
+
# from this recommendation, which enables accurate attribution of
|
161
|
+
# recommendation model performance.
|
162
|
+
# @!attribute [rw] missing_ids
|
163
|
+
# @return [::Array<::String>]
|
164
|
+
# IDs of documents in the request that were missing from the default Branch
|
165
|
+
# associated with the requested ServingConfig.
|
166
|
+
# @!attribute [rw] validate_only
|
167
|
+
# @return [::Boolean]
|
168
|
+
# True if
|
169
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#validate_only RecommendRequest.validate_only}
|
170
|
+
# was set.
|
171
|
+
class RecommendResponse
|
172
|
+
include ::Google::Protobuf::MessageExts
|
173
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
174
|
+
|
175
|
+
# RecommendationResult represents a generic recommendation result with
|
176
|
+
# associated metadata.
|
177
|
+
# @!attribute [rw] id
|
178
|
+
# @return [::String]
|
179
|
+
# Resource ID of the recommended Document.
|
180
|
+
# @!attribute [rw] document
|
181
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
|
182
|
+
# Set if `returnDocument` is set to true in
|
183
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
|
184
|
+
# @!attribute [rw] metadata
|
185
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
|
186
|
+
# Additional Document metadata / annotations.
|
187
|
+
#
|
188
|
+
# Possible values:
|
189
|
+
#
|
190
|
+
# * `score`: Recommendation score in double value. Is set if
|
191
|
+
# `returnScore` is set to true in
|
192
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
|
193
|
+
class RecommendationResult
|
194
|
+
include ::Google::Protobuf::MessageExts
|
195
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
196
|
+
|
197
|
+
# @!attribute [rw] key
|
198
|
+
# @return [::String]
|
199
|
+
# @!attribute [rw] value
|
200
|
+
# @return [::Google::Protobuf::Value]
|
201
|
+
class MetadataEntry
|
202
|
+
include ::Google::Protobuf::MessageExts
|
203
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
204
|
+
end
|
205
|
+
end
|
206
|
+
end
|
207
|
+
end
|
208
|
+
end
|
209
|
+
end
|
210
|
+
end
|
@@ -0,0 +1,45 @@
|
|
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
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Defines the structure and layout of a type of document data.
|
25
|
+
# @!attribute [rw] struct_schema
|
26
|
+
# @return [::Google::Protobuf::Struct]
|
27
|
+
# The structured representation of the schema.
|
28
|
+
# @!attribute [rw] json_schema
|
29
|
+
# @return [::String]
|
30
|
+
# The JSON representation of the schema.
|
31
|
+
# @!attribute [rw] name
|
32
|
+
# @return [::String]
|
33
|
+
# Immutable. The full resource name of the schema, in the format of
|
34
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
|
35
|
+
#
|
36
|
+
# This field must be a UTF-8 encoded string with a length limit of 1024
|
37
|
+
# characters.
|
38
|
+
class Schema
|
39
|
+
include ::Google::Protobuf::MessageExts
|
40
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,180 @@
|
|
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
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Request message for
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#get_schema SchemaService.GetSchema}
|
26
|
+
# method.
|
27
|
+
# @!attribute [rw] name
|
28
|
+
# @return [::String]
|
29
|
+
# Required. The full resource name of the schema, in the format of
|
30
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
|
31
|
+
class GetSchemaRequest
|
32
|
+
include ::Google::Protobuf::MessageExts
|
33
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
34
|
+
end
|
35
|
+
|
36
|
+
# Request message for
|
37
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#list_schemas SchemaService.ListSchemas}
|
38
|
+
# method.
|
39
|
+
# @!attribute [rw] parent
|
40
|
+
# @return [::String]
|
41
|
+
# Required. The parent data store resource name, in the format of
|
42
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
43
|
+
# @!attribute [rw] page_size
|
44
|
+
# @return [::Integer]
|
45
|
+
# The maximum number of {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s
|
46
|
+
# to return. The service may return fewer than this value.
|
47
|
+
#
|
48
|
+
# If unspecified, at most 100
|
49
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s will be returned.
|
50
|
+
#
|
51
|
+
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
52
|
+
# @!attribute [rw] page_token
|
53
|
+
# @return [::String]
|
54
|
+
# A page token, received from a previous
|
55
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#list_schemas SchemaService.ListSchemas}
|
56
|
+
# call. Provide this to retrieve the subsequent page.
|
57
|
+
#
|
58
|
+
# When paginating, all other parameters provided to
|
59
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#list_schemas SchemaService.ListSchemas}
|
60
|
+
# must match the call that provided the page token.
|
61
|
+
class ListSchemasRequest
|
62
|
+
include ::Google::Protobuf::MessageExts
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
64
|
+
end
|
65
|
+
|
66
|
+
# Response message for
|
67
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#list_schemas SchemaService.ListSchemas}
|
68
|
+
# method.
|
69
|
+
# @!attribute [rw] schemas
|
70
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Schema>]
|
71
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s.
|
72
|
+
# @!attribute [rw] next_page_token
|
73
|
+
# @return [::String]
|
74
|
+
# A token that can be sent as
|
75
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ListSchemasRequest#page_token ListSchemasRequest.page_token}
|
76
|
+
# to retrieve the next page. If this field is omitted, there are no
|
77
|
+
# subsequent pages.
|
78
|
+
class ListSchemasResponse
|
79
|
+
include ::Google::Protobuf::MessageExts
|
80
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
81
|
+
end
|
82
|
+
|
83
|
+
# Request message for
|
84
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#create_schema SchemaService.CreateSchema}
|
85
|
+
# method.
|
86
|
+
# @!attribute [rw] parent
|
87
|
+
# @return [::String]
|
88
|
+
# Required. The parent data store resource name, in the format of
|
89
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
90
|
+
# @!attribute [rw] schema
|
91
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Schema]
|
92
|
+
# Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} to
|
93
|
+
# create.
|
94
|
+
# @!attribute [rw] schema_id
|
95
|
+
# @return [::String]
|
96
|
+
# Required. The ID to use for the
|
97
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}, which will become the
|
98
|
+
# final component of the
|
99
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema#name Schema.name}.
|
100
|
+
#
|
101
|
+
# This field should conform to
|
102
|
+
# [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
|
103
|
+
# limit of 63 characters.
|
104
|
+
class CreateSchemaRequest
|
105
|
+
include ::Google::Protobuf::MessageExts
|
106
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
107
|
+
end
|
108
|
+
|
109
|
+
# Request message for
|
110
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#update_schema SchemaService.UpdateSchema}
|
111
|
+
# method.
|
112
|
+
# @!attribute [rw] schema
|
113
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Schema]
|
114
|
+
# Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} to
|
115
|
+
# update.
|
116
|
+
# @!attribute [rw] allow_missing
|
117
|
+
# @return [::Boolean]
|
118
|
+
# If set to true, and the
|
119
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} is not found, a new
|
120
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} will be created. In
|
121
|
+
# this situation, `update_mask` is ignored.
|
122
|
+
class UpdateSchemaRequest
|
123
|
+
include ::Google::Protobuf::MessageExts
|
124
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
125
|
+
end
|
126
|
+
|
127
|
+
# Request message for
|
128
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#delete_schema SchemaService.DeleteSchema}
|
129
|
+
# method.
|
130
|
+
# @!attribute [rw] name
|
131
|
+
# @return [::String]
|
132
|
+
# Required. The full resource name of the schema, in the format of
|
133
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
|
134
|
+
class DeleteSchemaRequest
|
135
|
+
include ::Google::Protobuf::MessageExts
|
136
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
137
|
+
end
|
138
|
+
|
139
|
+
# Metadata for Create Schema LRO.
|
140
|
+
# @!attribute [rw] create_time
|
141
|
+
# @return [::Google::Protobuf::Timestamp]
|
142
|
+
# Operation create time.
|
143
|
+
# @!attribute [rw] update_time
|
144
|
+
# @return [::Google::Protobuf::Timestamp]
|
145
|
+
# Operation last update time. If the operation is done, this is also the
|
146
|
+
# finish time.
|
147
|
+
class CreateSchemaMetadata
|
148
|
+
include ::Google::Protobuf::MessageExts
|
149
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
150
|
+
end
|
151
|
+
|
152
|
+
# Metadata for UpdateSchema LRO.
|
153
|
+
# @!attribute [rw] create_time
|
154
|
+
# @return [::Google::Protobuf::Timestamp]
|
155
|
+
# Operation create time.
|
156
|
+
# @!attribute [rw] update_time
|
157
|
+
# @return [::Google::Protobuf::Timestamp]
|
158
|
+
# Operation last update time. If the operation is done, this is also the
|
159
|
+
# finish time.
|
160
|
+
class UpdateSchemaMetadata
|
161
|
+
include ::Google::Protobuf::MessageExts
|
162
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
163
|
+
end
|
164
|
+
|
165
|
+
# Metadata for DeleteSchema LRO.
|
166
|
+
# @!attribute [rw] create_time
|
167
|
+
# @return [::Google::Protobuf::Timestamp]
|
168
|
+
# Operation create time.
|
169
|
+
# @!attribute [rw] update_time
|
170
|
+
# @return [::Google::Protobuf::Timestamp]
|
171
|
+
# Operation last update time. If the operation is done, this is also the
|
172
|
+
# finish time.
|
173
|
+
class DeleteSchemaMetadata
|
174
|
+
include ::Google::Protobuf::MessageExts
|
175
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
176
|
+
end
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|