google-cloud-discovery_engine-v1 0.7.0 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +228 -3
- data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +214 -3
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +136 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/client.rb +875 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/paths.rb +167 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb +814 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/rest/service_stub.rb +440 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/rest.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/control_service.rb +58 -0
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +911 -135
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +199 -0
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +733 -6
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +520 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +45 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +26 -14
- data/lib/google/cloud/discovery_engine/v1/document_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +26 -14
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/client.rb +471 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/paths.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb +438 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/client.rb +485 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/paths.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/client.rb +452 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +1114 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1/project_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +481 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/paths.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +448 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb +24 -19
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/paths.rb +66 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb +24 -19
- data/lib/google/cloud/discovery_engine/v1/rest.rb +4 -0
- data/lib/google/cloud/discovery_engine/v1/schema_service/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1/schema_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/schema_service/rest/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +57 -9
- data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +68 -0
- data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +57 -9
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/user_event_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb +15 -0
- data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1/answer_pb.rb +69 -0
- data/lib/google/cloud/discoveryengine/v1/chunk_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1/common_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1/completion_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb +8 -0
- data/lib/google/cloud/discoveryengine/v1/control_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1/control_service_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1/control_service_services_pb.rb +69 -0
- data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +32 -1
- data/lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb +25 -0
- data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/document_processing_config_pb.rb +51 -0
- data/lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +52 -0
- data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/grounding_pb.rb +46 -0
- data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +6 -1
- data/lib/google/cloud/discoveryengine/v1/project_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1/project_service_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1/project_service_services_pb.rb +51 -0
- data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1/rank_service_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1/rank_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +9 -1
- data/lib/google/cloud/discoveryengine/v1/session_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +375 -0
- data/proto_docs/google/cloud/discoveryengine/v1/chunk.rb +119 -0
- data/proto_docs/google/cloud/discoveryengine/v1/common.rb +16 -0
- data/proto_docs/google/cloud/discoveryengine/v1/completion.rb +31 -0
- data/proto_docs/google/cloud/discoveryengine/v1/control.rb +207 -0
- data/proto_docs/google/cloud/discoveryengine/v1/control_service.rb +126 -0
- data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +529 -0
- data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1/document.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +143 -0
- data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +5 -5
- data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +3 -3
- data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +144 -0
- data/proto_docs/google/cloud/discoveryengine/v1/grounding.rb +79 -0
- data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +118 -4
- data/proto_docs/google/cloud/discoveryengine/v1/project.rb +106 -0
- data/proto_docs/google/cloud/discoveryengine/v1/project_service.rb +57 -0
- data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +42 -0
- data/proto_docs/google/cloud/discoveryengine/v1/rank_service.rb +124 -0
- data/proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb +20 -19
- data/proto_docs/google/cloud/discoveryengine/v1/schema_service.rb +5 -5
- data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +230 -20
- data/proto_docs/google/cloud/discoveryengine/v1/session.rb +88 -0
- data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +24 -3
- data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb +13 -1
- metadata +58 -2
@@ -0,0 +1,207 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1
|
24
|
+
# Defines circumstances to be checked before allowing a behavior
|
25
|
+
# @!attribute [rw] query_terms
|
26
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Condition::QueryTerm>]
|
27
|
+
# Search only
|
28
|
+
# A list of terms to match the query on.
|
29
|
+
#
|
30
|
+
# Maximum of 10 query terms.
|
31
|
+
# @!attribute [rw] active_time_range
|
32
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Condition::TimeRange>]
|
33
|
+
# Range of time(s) specifying when condition is active.
|
34
|
+
#
|
35
|
+
# Maximum of 10 time ranges.
|
36
|
+
class Condition
|
37
|
+
include ::Google::Protobuf::MessageExts
|
38
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
39
|
+
|
40
|
+
# Matcher for search request query
|
41
|
+
# @!attribute [rw] value
|
42
|
+
# @return [::String]
|
43
|
+
# The specific query value to match against
|
44
|
+
#
|
45
|
+
# Must be lowercase, must be UTF-8.
|
46
|
+
# Can have at most 3 space separated terms if full_match is true.
|
47
|
+
# Cannot be an empty string.
|
48
|
+
# Maximum length of 5000 characters.
|
49
|
+
# @!attribute [rw] full_match
|
50
|
+
# @return [::Boolean]
|
51
|
+
# Whether the search query needs to exactly match the query term.
|
52
|
+
class QueryTerm
|
53
|
+
include ::Google::Protobuf::MessageExts
|
54
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
55
|
+
end
|
56
|
+
|
57
|
+
# Used for time-dependent conditions.
|
58
|
+
# @!attribute [rw] start_time
|
59
|
+
# @return [::Google::Protobuf::Timestamp]
|
60
|
+
# Start of time range.
|
61
|
+
#
|
62
|
+
# Range is inclusive.
|
63
|
+
# @!attribute [rw] end_time
|
64
|
+
# @return [::Google::Protobuf::Timestamp]
|
65
|
+
# End of time range.
|
66
|
+
#
|
67
|
+
# Range is inclusive.
|
68
|
+
# Must be in the future.
|
69
|
+
class TimeRange
|
70
|
+
include ::Google::Protobuf::MessageExts
|
71
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
# Defines a conditioned behavior to employ during serving.
|
76
|
+
# Must be attached to a [ServingConfig][] to be considered at serving time.
|
77
|
+
# Permitted actions dependent on `SolutionType`.
|
78
|
+
# @!attribute [rw] boost_action
|
79
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction]
|
80
|
+
# Defines a boost-type control
|
81
|
+
# @!attribute [rw] filter_action
|
82
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction]
|
83
|
+
# Defines a filter-type control
|
84
|
+
# Currently not supported by Recommendation
|
85
|
+
# @!attribute [rw] redirect_action
|
86
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction]
|
87
|
+
# Defines a redirect-type control.
|
88
|
+
# @!attribute [rw] synonyms_action
|
89
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction]
|
90
|
+
# Treats a group of terms as synonyms of one another.
|
91
|
+
# @!attribute [rw] name
|
92
|
+
# @return [::String]
|
93
|
+
# Immutable. Fully qualified name
|
94
|
+
# `projects/*/locations/global/dataStore/*/controls/*`
|
95
|
+
# @!attribute [rw] display_name
|
96
|
+
# @return [::String]
|
97
|
+
# Required. Human readable name. The identifier used in UI views.
|
98
|
+
#
|
99
|
+
# Must be UTF-8 encoded string. Length limit is 128 characters.
|
100
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
101
|
+
# @!attribute [r] associated_serving_config_ids
|
102
|
+
# @return [::Array<::String>]
|
103
|
+
# Output only. List of all [ServingConfig][] ids this control is attached to.
|
104
|
+
# May take up to 10 minutes to update after changes.
|
105
|
+
# @!attribute [rw] solution_type
|
106
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::SolutionType]
|
107
|
+
# Required. Immutable. What solution the control belongs to.
|
108
|
+
#
|
109
|
+
# Must be compatible with vertical of resource.
|
110
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
111
|
+
# @!attribute [rw] use_cases
|
112
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchUseCase>]
|
113
|
+
# Specifies the use case for the control.
|
114
|
+
# Affects what condition fields can be set.
|
115
|
+
# Only applies to
|
116
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
|
117
|
+
# Currently only allow one use case per control.
|
118
|
+
# Must be set when solution_type is
|
119
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SolutionType.SOLUTION_TYPE_SEARCH}.
|
120
|
+
# @!attribute [rw] conditions
|
121
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Condition>]
|
122
|
+
# Determines when the associated action will trigger.
|
123
|
+
#
|
124
|
+
# Omit to always apply the action.
|
125
|
+
# Currently only a single condition may be specified.
|
126
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
127
|
+
class Control
|
128
|
+
include ::Google::Protobuf::MessageExts
|
129
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
130
|
+
|
131
|
+
# Adjusts order of products in returned list.
|
132
|
+
# @!attribute [rw] boost
|
133
|
+
# @return [::Float]
|
134
|
+
# Required. Strength of the boost, which should be in [-1, 1]. Negative
|
135
|
+
# boost means demotion. Default is 0.0 (No-op).
|
136
|
+
# @!attribute [rw] filter
|
137
|
+
# @return [::String]
|
138
|
+
# Required. Specifies which products to apply the boost to.
|
139
|
+
#
|
140
|
+
# If no filter is provided all products will be boosted (No-op).
|
141
|
+
# Syntax documentation:
|
142
|
+
# https://cloud.google.com/retail/docs/filter-and-order
|
143
|
+
# Maximum length is 5000 characters.
|
144
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
145
|
+
# @!attribute [rw] data_store
|
146
|
+
# @return [::String]
|
147
|
+
# Required. Specifies which data store's documents can be boosted by this
|
148
|
+
# control. Full data store name e.g.
|
149
|
+
# projects/123/locations/global/collections/default_collection/dataStores/default_data_store
|
150
|
+
class BoostAction
|
151
|
+
include ::Google::Protobuf::MessageExts
|
152
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
153
|
+
end
|
154
|
+
|
155
|
+
# Specified which products may be included in results.
|
156
|
+
# Uses same filter as boost.
|
157
|
+
# @!attribute [rw] filter
|
158
|
+
# @return [::String]
|
159
|
+
# Required. A filter to apply on the matching condition results.
|
160
|
+
#
|
161
|
+
# Required
|
162
|
+
# Syntax documentation:
|
163
|
+
# https://cloud.google.com/retail/docs/filter-and-order
|
164
|
+
# Maximum length is 5000 characters. Otherwise an INVALID
|
165
|
+
# ARGUMENT error is thrown.
|
166
|
+
# @!attribute [rw] data_store
|
167
|
+
# @return [::String]
|
168
|
+
# Required. Specifies which data store's documents can be filtered by this
|
169
|
+
# control. Full data store name e.g.
|
170
|
+
# projects/123/locations/global/collections/default_collection/dataStores/default_data_store
|
171
|
+
class FilterAction
|
172
|
+
include ::Google::Protobuf::MessageExts
|
173
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
174
|
+
end
|
175
|
+
|
176
|
+
# Redirects a shopper to the provided URI.
|
177
|
+
# @!attribute [rw] redirect_uri
|
178
|
+
# @return [::String]
|
179
|
+
# Required. The URI to which the shopper will be redirected.
|
180
|
+
#
|
181
|
+
# Required.
|
182
|
+
# URI must have length equal or less than 2000 characters.
|
183
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
184
|
+
class RedirectAction
|
185
|
+
include ::Google::Protobuf::MessageExts
|
186
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
187
|
+
end
|
188
|
+
|
189
|
+
# Creates a set of terms that will act as synonyms of one another.
|
190
|
+
#
|
191
|
+
# Example: "happy" will also be considered as "glad", "glad" will also be
|
192
|
+
# considered as "happy".
|
193
|
+
# @!attribute [rw] synonyms
|
194
|
+
# @return [::Array<::String>]
|
195
|
+
# Defines a set of synonyms.
|
196
|
+
# Can specify up to 100 synonyms.
|
197
|
+
# Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
|
198
|
+
# thrown.
|
199
|
+
class SynonymsAction
|
200
|
+
include ::Google::Protobuf::MessageExts
|
201
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
202
|
+
end
|
203
|
+
end
|
204
|
+
end
|
205
|
+
end
|
206
|
+
end
|
207
|
+
end
|
@@ -0,0 +1,126 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1
|
24
|
+
# Request for CreateControl method.
|
25
|
+
# @!attribute [rw] parent
|
26
|
+
# @return [::String]
|
27
|
+
# Required. Full resource name of parent data store. Format:
|
28
|
+
# `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
|
29
|
+
# or
|
30
|
+
# `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
|
31
|
+
# @!attribute [rw] control
|
32
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Control]
|
33
|
+
# Required. The Control to create.
|
34
|
+
# @!attribute [rw] control_id
|
35
|
+
# @return [::String]
|
36
|
+
# Required. The ID to use for the Control, which will become the final
|
37
|
+
# component of the Control's resource name.
|
38
|
+
#
|
39
|
+
# This value must be within 1-63 characters.
|
40
|
+
# Valid characters are /[a-z][0-9]-_/.
|
41
|
+
class CreateControlRequest
|
42
|
+
include ::Google::Protobuf::MessageExts
|
43
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
44
|
+
end
|
45
|
+
|
46
|
+
# Request for UpdateControl method.
|
47
|
+
# @!attribute [rw] control
|
48
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Control]
|
49
|
+
# Required. The Control to update.
|
50
|
+
# @!attribute [rw] update_mask
|
51
|
+
# @return [::Google::Protobuf::FieldMask]
|
52
|
+
# Optional. Indicates which fields in the provided
|
53
|
+
# {::Google::Cloud::DiscoveryEngine::V1::Control Control} to update. The following
|
54
|
+
# are NOT supported:
|
55
|
+
#
|
56
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::Control#name Control.name}
|
57
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::Control#solution_type Control.solution_type}
|
58
|
+
#
|
59
|
+
# If not set or empty, all supported fields are updated.
|
60
|
+
class UpdateControlRequest
|
61
|
+
include ::Google::Protobuf::MessageExts
|
62
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
63
|
+
end
|
64
|
+
|
65
|
+
# Request for DeleteControl method.
|
66
|
+
# @!attribute [rw] name
|
67
|
+
# @return [::String]
|
68
|
+
# Required. The resource name of the Control to delete. Format:
|
69
|
+
# `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
|
70
|
+
class DeleteControlRequest
|
71
|
+
include ::Google::Protobuf::MessageExts
|
72
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
73
|
+
end
|
74
|
+
|
75
|
+
# Request for GetControl method.
|
76
|
+
# @!attribute [rw] name
|
77
|
+
# @return [::String]
|
78
|
+
# Required. The resource name of the Control to get. Format:
|
79
|
+
# `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
|
80
|
+
class GetControlRequest
|
81
|
+
include ::Google::Protobuf::MessageExts
|
82
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
|
+
end
|
84
|
+
|
85
|
+
# Request for ListControls method.
|
86
|
+
# @!attribute [rw] parent
|
87
|
+
# @return [::String]
|
88
|
+
# Required. The data store resource name. Format:
|
89
|
+
# `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
|
90
|
+
# or
|
91
|
+
# `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
|
92
|
+
# @!attribute [rw] page_size
|
93
|
+
# @return [::Integer]
|
94
|
+
# Optional. Maximum number of results to return. If unspecified, defaults
|
95
|
+
# to 50. Max allowed value is 1000.
|
96
|
+
# @!attribute [rw] page_token
|
97
|
+
# @return [::String]
|
98
|
+
# Optional. A page token, received from a previous `ListControls` call.
|
99
|
+
# Provide this to retrieve the subsequent page.
|
100
|
+
# @!attribute [rw] filter
|
101
|
+
# @return [::String]
|
102
|
+
# Optional. A filter to apply on the list results. Supported features:
|
103
|
+
#
|
104
|
+
# * List all the products under the parent branch if
|
105
|
+
# {::Google::Cloud::DiscoveryEngine::V1::ListControlsRequest#filter filter} is
|
106
|
+
# unset. Currently this field is unsupported.
|
107
|
+
class ListControlsRequest
|
108
|
+
include ::Google::Protobuf::MessageExts
|
109
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
110
|
+
end
|
111
|
+
|
112
|
+
# Response for ListControls method.
|
113
|
+
# @!attribute [rw] controls
|
114
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Control>]
|
115
|
+
# All the Controls for a given data store.
|
116
|
+
# @!attribute [rw] next_page_token
|
117
|
+
# @return [::String]
|
118
|
+
# Pagination token, if not returned indicates the last page.
|
119
|
+
class ListControlsResponse
|
120
|
+
include ::Google::Protobuf::MessageExts
|
121
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
122
|
+
end
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
@@ -25,9 +25,9 @@ module Google
|
|
25
25
|
# @!attribute [rw] name
|
26
26
|
# @return [::String]
|
27
27
|
# Immutable. Fully qualified name
|
28
|
-
# `project
|
28
|
+
# `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*`
|
29
29
|
# or
|
30
|
-
# `project
|
30
|
+
# `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.
|
31
31
|
# @!attribute [rw] state
|
32
32
|
# @return [::Google::Cloud::DiscoveryEngine::V1::Conversation::State]
|
33
33
|
# The state of the Conversation.
|