google-cloud-discovery_engine-v1 0.a → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (104) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +451 -0
  6. data/lib/google/cloud/discovery_engine/v1/completion_service/credentials.rb +47 -0
  7. data/lib/google/cloud/discovery_engine/v1/completion_service/paths.rb +78 -0
  8. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +408 -0
  9. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +114 -0
  10. data/lib/google/cloud/discovery_engine/v1/completion_service/rest.rb +52 -0
  11. data/lib/google/cloud/discovery_engine/v1/completion_service.rb +55 -0
  12. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +959 -0
  13. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/credentials.rb +47 -0
  14. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +176 -0
  15. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +797 -0
  16. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +450 -0
  17. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest.rb +52 -0
  18. data/lib/google/cloud/discovery_engine/v1/conversational_search_service.rb +55 -0
  19. data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +1170 -0
  20. data/lib/google/cloud/discovery_engine/v1/document_service/credentials.rb +47 -0
  21. data/lib/google/cloud/discovery_engine/v1/document_service/operations.rb +770 -0
  22. data/lib/google/cloud/discovery_engine/v1/document_service/paths.rb +135 -0
  23. data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +971 -0
  24. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +977 -0
  25. data/lib/google/cloud/discovery_engine/v1/document_service/rest/service_stub.rb +518 -0
  26. data/lib/google/cloud/discovery_engine/v1/document_service/rest.rb +54 -0
  27. data/lib/google/cloud/discovery_engine/v1/document_service.rb +57 -0
  28. data/lib/google/cloud/discovery_engine/v1/rest.rb +42 -0
  29. data/lib/google/cloud/discovery_engine/v1/schema_service/client.rb +853 -0
  30. data/lib/google/cloud/discovery_engine/v1/schema_service/credentials.rb +47 -0
  31. data/lib/google/cloud/discovery_engine/v1/schema_service/operations.rb +770 -0
  32. data/lib/google/cloud/discovery_engine/v1/schema_service/paths.rb +127 -0
  33. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/client.rb +693 -0
  34. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +977 -0
  35. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/service_stub.rb +382 -0
  36. data/lib/google/cloud/discovery_engine/v1/schema_service/rest.rb +53 -0
  37. data/lib/google/cloud/discovery_engine/v1/schema_service.rb +56 -0
  38. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +529 -0
  39. data/lib/google/cloud/discovery_engine/v1/search_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +131 -0
  41. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +481 -0
  42. data/lib/google/cloud/discovery_engine/v1/search_service/rest/service_stub.rb +116 -0
  43. data/lib/google/cloud/discovery_engine/v1/search_service/rest.rb +52 -0
  44. data/lib/google/cloud/discovery_engine/v1/search_service.rb +55 -0
  45. data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +654 -0
  46. data/lib/google/cloud/discovery_engine/v1/user_event_service/credentials.rb +47 -0
  47. data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb +770 -0
  48. data/lib/google/cloud/discovery_engine/v1/user_event_service/paths.rb +131 -0
  49. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +558 -0
  50. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +977 -0
  51. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb +250 -0
  52. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest.rb +53 -0
  53. data/lib/google/cloud/discovery_engine/v1/user_event_service.rb +56 -0
  54. data/lib/google/cloud/discovery_engine/v1/version.rb +7 -2
  55. data/lib/google/cloud/discovery_engine/v1.rb +50 -0
  56. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +46 -0
  57. data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +49 -0
  58. data/lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb +45 -0
  59. data/lib/google/cloud/discoveryengine/v1/conversation_pb.rb +54 -0
  60. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +61 -0
  61. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb +67 -0
  62. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +48 -0
  63. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +58 -0
  64. data/lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb +79 -0
  65. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +66 -0
  66. data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +49 -0
  67. data/lib/google/cloud/discoveryengine/v1/schema_pb.rb +47 -0
  68. data/lib/google/cloud/discoveryengine/v1/schema_service_pb.rb +61 -0
  69. data/lib/google/cloud/discoveryengine/v1/schema_service_services_pb.rb +53 -0
  70. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +73 -0
  71. data/lib/google/cloud/discoveryengine/v1/search_service_services_pb.rb +45 -0
  72. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +58 -0
  73. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +53 -0
  74. data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +59 -0
  75. data/lib/google-cloud-discovery_engine-v1.rb +21 -0
  76. data/proto_docs/README.md +4 -0
  77. data/proto_docs/google/api/client.rb +381 -0
  78. data/proto_docs/google/api/field_behavior.rb +85 -0
  79. data/proto_docs/google/api/httpbody.rb +80 -0
  80. data/proto_docs/google/api/launch_stage.rb +71 -0
  81. data/proto_docs/google/api/resource.rb +222 -0
  82. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +106 -0
  83. data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb +111 -0
  84. data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +113 -0
  85. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +206 -0
  86. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +108 -0
  87. data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +181 -0
  88. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +340 -0
  89. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +84 -0
  90. data/proto_docs/google/cloud/discoveryengine/v1/schema.rb +45 -0
  91. data/proto_docs/google/cloud/discoveryengine/v1/schema_service.rb +177 -0
  92. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +730 -0
  93. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +478 -0
  94. data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb +64 -0
  95. data/proto_docs/google/longrunning/operations.rb +164 -0
  96. data/proto_docs/google/protobuf/any.rb +144 -0
  97. data/proto_docs/google/protobuf/duration.rb +98 -0
  98. data/proto_docs/google/protobuf/empty.rb +34 -0
  99. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  100. data/proto_docs/google/protobuf/struct.rb +96 -0
  101. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  102. data/proto_docs/google/rpc/status.rb +48 -0
  103. data/proto_docs/google/type/date.rb +53 -0
  104. metadata +277 -13
@@ -0,0 +1,340 @@
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 V1
24
+ # Cloud Storage location for input content.
25
+ # @!attribute [rw] input_uris
26
+ # @return [::Array<::String>]
27
+ # Required. Cloud Storage URIs to input files. URI can be up to
28
+ # 2000 characters long. URIs can match the full object path (for example,
29
+ # `gs://bucket/directory/object.json`) or a pattern matching one or more
30
+ # files, such as `gs://bucket/directory/*.json`.
31
+ #
32
+ # A request can contain at most 100 files (or 100,000 files if `data_schema`
33
+ # is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is
34
+ # `content`).
35
+ # @!attribute [rw] data_schema
36
+ # @return [::String]
37
+ # The schema to use when parsing the data from the source.
38
+ #
39
+ # Supported values for document imports:
40
+ #
41
+ # * `document` (default): One JSON
42
+ # {::Google::Cloud::DiscoveryEngine::V1::Document Document} per line. Each
43
+ # document must
44
+ # have a valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
45
+ # * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
46
+ # `input_uris` becomes a document, with the ID set to the first 128
47
+ # bits of SHA256(URI) encoded as a hex string.
48
+ # * `custom`: One custom data JSON per row in arbitrary format that conforms
49
+ # to the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
50
+ # data store. This can only be used by Gen App Builder.
51
+ # * `csv`: A CSV file with header conforming to the defined
52
+ # {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
53
+ # data store. Each entry after the header is imported as a Document.
54
+ # This can only be used by Gen App Builder.
55
+ #
56
+ # Supported values for user even imports:
57
+ #
58
+ # * `user_event` (default): One JSON
59
+ # {::Google::Cloud::DiscoveryEngine::V1::UserEvent UserEvent} per line.
60
+ class GcsSource
61
+ include ::Google::Protobuf::MessageExts
62
+ extend ::Google::Protobuf::MessageExts::ClassMethods
63
+ end
64
+
65
+ # BigQuery source import data from.
66
+ # @!attribute [rw] partition_date
67
+ # @return [::Google::Type::Date]
68
+ # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
69
+ # @!attribute [rw] project_id
70
+ # @return [::String]
71
+ # The project ID (can be project # or ID) that the BigQuery source is in with
72
+ # a length limit of 128 characters. If not specified, inherits the project
73
+ # ID from the parent request.
74
+ # @!attribute [rw] dataset_id
75
+ # @return [::String]
76
+ # Required. The BigQuery data set to copy the data from with a length limit
77
+ # of 1,024 characters.
78
+ # @!attribute [rw] table_id
79
+ # @return [::String]
80
+ # Required. The BigQuery table to copy the data from with a length limit of
81
+ # 1,024 characters.
82
+ # @!attribute [rw] gcs_staging_dir
83
+ # @return [::String]
84
+ # Intermediate Cloud Storage directory used for the import with a length
85
+ # limit of 2,000 characters. Can be specified if one wants to have the
86
+ # BigQuery export to a specific Cloud Storage directory.
87
+ # @!attribute [rw] data_schema
88
+ # @return [::String]
89
+ # The schema to use when parsing the data from the source.
90
+ #
91
+ # Supported values for user event imports:
92
+ #
93
+ # * `user_event` (default): One
94
+ # {::Google::Cloud::DiscoveryEngine::V1::UserEvent UserEvent} per row.
95
+ #
96
+ # Supported values for document imports:
97
+ #
98
+ # * `document` (default): One
99
+ # {::Google::Cloud::DiscoveryEngine::V1::Document Document} format per
100
+ # row. Each document must have a valid
101
+ # {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id} and one of
102
+ # {::Google::Cloud::DiscoveryEngine::V1::Document#json_data Document.json_data}
103
+ # or
104
+ # {::Google::Cloud::DiscoveryEngine::V1::Document#struct_data Document.struct_data}.
105
+ # * `custom`: One custom data per row in arbitrary format that conforms to
106
+ # the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the data
107
+ # store. This can only be used by Gen App Builder.
108
+ class BigQuerySource
109
+ include ::Google::Protobuf::MessageExts
110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
111
+ end
112
+
113
+ # Configuration of destination for Import related errors.
114
+ # @!attribute [rw] gcs_prefix
115
+ # @return [::String]
116
+ # Cloud Storage prefix for import errors. This must be an empty,
117
+ # existing Cloud Storage directory. Import errors are written to
118
+ # sharded files in this directory, one per line, as a JSON-encoded
119
+ # `google.rpc.Status` message.
120
+ class ImportErrorConfig
121
+ include ::Google::Protobuf::MessageExts
122
+ extend ::Google::Protobuf::MessageExts::ClassMethods
123
+ end
124
+
125
+ # Request message for the ImportUserEvents request.
126
+ # @!attribute [rw] inline_source
127
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ImportUserEventsRequest::InlineSource]
128
+ # The Inline source for the input content for UserEvents.
129
+ # @!attribute [rw] gcs_source
130
+ # @return [::Google::Cloud::DiscoveryEngine::V1::GcsSource]
131
+ # Cloud Storage location for the input content.
132
+ # @!attribute [rw] bigquery_source
133
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource]
134
+ # BigQuery input source.
135
+ # @!attribute [rw] parent
136
+ # @return [::String]
137
+ # Required. Parent DataStore resource name, of the form
138
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
139
+ # @!attribute [rw] error_config
140
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig]
141
+ # The desired location of errors incurred during the Import. Cannot be set
142
+ # for inline user event imports.
143
+ class ImportUserEventsRequest
144
+ include ::Google::Protobuf::MessageExts
145
+ extend ::Google::Protobuf::MessageExts::ClassMethods
146
+
147
+ # The inline source for the input config for ImportUserEvents method.
148
+ # @!attribute [rw] user_events
149
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::UserEvent>]
150
+ # Required. A list of user events to import. Recommended max of 10k items.
151
+ class InlineSource
152
+ include ::Google::Protobuf::MessageExts
153
+ extend ::Google::Protobuf::MessageExts::ClassMethods
154
+ end
155
+ end
156
+
157
+ # Response of the ImportUserEventsRequest. If the long running
158
+ # operation was successful, then this message is returned by the
159
+ # google.longrunning.Operations.response field if the operation was successful.
160
+ # @!attribute [rw] error_samples
161
+ # @return [::Array<::Google::Rpc::Status>]
162
+ # A sample of errors encountered while processing the request.
163
+ # @!attribute [rw] error_config
164
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig]
165
+ # Echoes the destination for the complete errors if this field was set in
166
+ # the request.
167
+ # @!attribute [rw] joined_events_count
168
+ # @return [::Integer]
169
+ # Count of user events imported with complete existing Documents.
170
+ # @!attribute [rw] unjoined_events_count
171
+ # @return [::Integer]
172
+ # Count of user events imported, but with Document information not found
173
+ # in the existing Branch.
174
+ class ImportUserEventsResponse
175
+ include ::Google::Protobuf::MessageExts
176
+ extend ::Google::Protobuf::MessageExts::ClassMethods
177
+ end
178
+
179
+ # Metadata related to the progress of the Import operation. This is
180
+ # returned by the google.longrunning.Operation.metadata field.
181
+ # @!attribute [rw] create_time
182
+ # @return [::Google::Protobuf::Timestamp]
183
+ # Operation create time.
184
+ # @!attribute [rw] update_time
185
+ # @return [::Google::Protobuf::Timestamp]
186
+ # Operation last update time. If the operation is done, this is also the
187
+ # finish time.
188
+ # @!attribute [rw] success_count
189
+ # @return [::Integer]
190
+ # Count of entries that were processed successfully.
191
+ # @!attribute [rw] failure_count
192
+ # @return [::Integer]
193
+ # Count of entries that encountered errors while processing.
194
+ class ImportUserEventsMetadata
195
+ include ::Google::Protobuf::MessageExts
196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
197
+ end
198
+
199
+ # Metadata related to the progress of the ImportDocuments operation. This is
200
+ # returned by the google.longrunning.Operation.metadata field.
201
+ # @!attribute [rw] create_time
202
+ # @return [::Google::Protobuf::Timestamp]
203
+ # Operation create time.
204
+ # @!attribute [rw] update_time
205
+ # @return [::Google::Protobuf::Timestamp]
206
+ # Operation last update time. If the operation is done, this is also the
207
+ # finish time.
208
+ # @!attribute [rw] success_count
209
+ # @return [::Integer]
210
+ # Count of entries that were processed successfully.
211
+ # @!attribute [rw] failure_count
212
+ # @return [::Integer]
213
+ # Count of entries that encountered errors while processing.
214
+ class ImportDocumentsMetadata
215
+ include ::Google::Protobuf::MessageExts
216
+ extend ::Google::Protobuf::MessageExts::ClassMethods
217
+ end
218
+
219
+ # Request message for Import methods.
220
+ # @!attribute [rw] inline_source
221
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::InlineSource]
222
+ # The Inline source for the input content for documents.
223
+ # @!attribute [rw] gcs_source
224
+ # @return [::Google::Cloud::DiscoveryEngine::V1::GcsSource]
225
+ # Cloud Storage location for the input content.
226
+ # @!attribute [rw] bigquery_source
227
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource]
228
+ # BigQuery input source.
229
+ # @!attribute [rw] parent
230
+ # @return [::String]
231
+ # Required. The parent branch resource name, such as
232
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
233
+ # Requires create/update permission.
234
+ # @!attribute [rw] error_config
235
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig]
236
+ # The desired location of errors incurred during the Import.
237
+ # @!attribute [rw] reconciliation_mode
238
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode]
239
+ # The mode of reconciliation between existing documents and the documents to
240
+ # be imported. Defaults to
241
+ # {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
242
+ # @!attribute [rw] auto_generate_ids
243
+ # @return [::Boolean]
244
+ # Whether to automatically generate IDs for the documents if absent.
245
+ #
246
+ # If set to `true`,
247
+ # {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s are
248
+ # automatically generated based on the hash of the payload, where IDs may not
249
+ # be consistent during multiple imports. In which case
250
+ # {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode::FULL ReconciliationMode.FULL}
251
+ # is highly recommended to avoid duplicate contents. If unset or set to
252
+ # `false`, {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s have
253
+ # to be specified using
254
+ # {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#id_field id_field},
255
+ # otherwise, documents without IDs fail to be imported.
256
+ #
257
+ # Only set this field when using
258
+ # {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
259
+ # {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}, and when
260
+ # {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
261
+ # or
262
+ # {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
263
+ # is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
264
+ # @!attribute [rw] id_field
265
+ # @return [::String]
266
+ # The field in the Cloud Storage and BigQuery sources that indicates the
267
+ # unique IDs of the documents.
268
+ #
269
+ # For {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} it is the key of
270
+ # the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`.
271
+ # For {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource} it is
272
+ # the column name of the BigQuery table where the unique ids are stored.
273
+ #
274
+ # The values of the JSON field or the BigQuery column are used as the
275
+ # {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s. The JSON field
276
+ # or the BigQuery column must be of string type, and the values must be set
277
+ # as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
278
+ # with 1-63 characters. Otherwise, documents without valid IDs fail to be
279
+ # imported.
280
+ #
281
+ # Only set this field when using
282
+ # {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
283
+ # {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}, and when
284
+ # {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
285
+ # or
286
+ # {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
287
+ # is `custom`. And only set this field when
288
+ # {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#auto_generate_ids auto_generate_ids}
289
+ # is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
290
+ #
291
+ # If it is unset, a default value `_id` is used when importing from the
292
+ # allowed data sources.
293
+ class ImportDocumentsRequest
294
+ include ::Google::Protobuf::MessageExts
295
+ extend ::Google::Protobuf::MessageExts::ClassMethods
296
+
297
+ # The inline source for the input config for ImportDocuments method.
298
+ # @!attribute [rw] documents
299
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
300
+ # Required. A list of documents to update/create. Each document must have a
301
+ # valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
302
+ # Recommended max of 100 items.
303
+ class InlineSource
304
+ include ::Google::Protobuf::MessageExts
305
+ extend ::Google::Protobuf::MessageExts::ClassMethods
306
+ end
307
+
308
+ # Indicates how imported documents are reconciled with the existing documents
309
+ # created or imported before.
310
+ module ReconciliationMode
311
+ # Defaults to `INCREMENTAL`.
312
+ RECONCILIATION_MODE_UNSPECIFIED = 0
313
+
314
+ # Inserts new documents or updates existing documents.
315
+ INCREMENTAL = 1
316
+
317
+ # Calculates diff and replaces the entire document dataset. Existing
318
+ # documents may be deleted if they are not present in the source location.
319
+ FULL = 2
320
+ end
321
+ end
322
+
323
+ # Response of the
324
+ # {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest ImportDocumentsRequest}.
325
+ # If the long running operation is done, then this message is returned by the
326
+ # google.longrunning.Operations.response field if the operation was successful.
327
+ # @!attribute [rw] error_samples
328
+ # @return [::Array<::Google::Rpc::Status>]
329
+ # A sample of errors encountered while processing the request.
330
+ # @!attribute [rw] error_config
331
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig]
332
+ # Echoes the destination for the complete errors in the request if set.
333
+ class ImportDocumentsResponse
334
+ include ::Google::Protobuf::MessageExts
335
+ extend ::Google::Protobuf::MessageExts::ClassMethods
336
+ end
337
+ end
338
+ end
339
+ end
340
+ end
@@ -0,0 +1,84 @@
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 V1
24
+ # Request message for
25
+ # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
26
+ # method.
27
+ # @!attribute [rw] parent
28
+ # @return [::String]
29
+ # Required. The parent resource name, such as
30
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
31
+ # @!attribute [rw] filter
32
+ # @return [::String]
33
+ # Required. Filter matching documents to purge. Only currently supported
34
+ # value is
35
+ # `*` (all items).
36
+ # @!attribute [rw] force
37
+ # @return [::Boolean]
38
+ # Actually performs the purge. If `force` is set to false, return the
39
+ # expected purge count without deleting any documents.
40
+ class PurgeDocumentsRequest
41
+ include ::Google::Protobuf::MessageExts
42
+ extend ::Google::Protobuf::MessageExts::ClassMethods
43
+ end
44
+
45
+ # Response message for
46
+ # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
47
+ # method. If the long running operation is successfully done, then this message
48
+ # is returned by the google.longrunning.Operations.response field.
49
+ # @!attribute [rw] purge_count
50
+ # @return [::Integer]
51
+ # The total count of documents purged as a result of the operation.
52
+ # @!attribute [rw] purge_sample
53
+ # @return [::Array<::String>]
54
+ # A sample of document names that will be deleted. Only populated if `force`
55
+ # is set to false. A max of 100 names will be returned and the names are
56
+ # chosen at random.
57
+ class PurgeDocumentsResponse
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
+ end
61
+
62
+ # Metadata related to the progress of the PurgeDocuments operation.
63
+ # This will be returned by the google.longrunning.Operation.metadata field.
64
+ # @!attribute [rw] create_time
65
+ # @return [::Google::Protobuf::Timestamp]
66
+ # Operation create time.
67
+ # @!attribute [rw] update_time
68
+ # @return [::Google::Protobuf::Timestamp]
69
+ # Operation last update time. If the operation is done, this is also the
70
+ # finish time.
71
+ # @!attribute [rw] success_count
72
+ # @return [::Integer]
73
+ # Count of entries that were deleted successfully.
74
+ # @!attribute [rw] failure_count
75
+ # @return [::Integer]
76
+ # Count of entries that encountered errors while processing.
77
+ class PurgeDocumentsMetadata
78
+ include ::Google::Protobuf::MessageExts
79
+ extend ::Google::Protobuf::MessageExts::ClassMethods
80
+ end
81
+ end
82
+ end
83
+ end
84
+ 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 V1
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,177 @@
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 V1
24
+ # Request message for
25
+ # {::Google::Cloud::DiscoveryEngine::V1::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::V1::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::V1::Schema Schema}s to
46
+ # return. The service may return fewer than this value.
47
+ #
48
+ # If unspecified, at most 100
49
+ # {::Google::Cloud::DiscoveryEngine::V1::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::V1::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::V1::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::V1::SchemaService::Client#list_schemas SchemaService.ListSchemas}
68
+ # method.
69
+ # @!attribute [rw] schemas
70
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Schema>]
71
+ # The {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}s.
72
+ # @!attribute [rw] next_page_token
73
+ # @return [::String]
74
+ # A token that can be sent as
75
+ # {::Google::Cloud::DiscoveryEngine::V1::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::V1::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::V1::Schema]
92
+ # Required. The {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} to create.
93
+ # @!attribute [rw] schema_id
94
+ # @return [::String]
95
+ # Required. The ID to use for the
96
+ # {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}, which will become the
97
+ # final component of the
98
+ # {::Google::Cloud::DiscoveryEngine::V1::Schema#name Schema.name}.
99
+ #
100
+ # This field should conform to
101
+ # [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
102
+ # limit of 63 characters.
103
+ class CreateSchemaRequest
104
+ include ::Google::Protobuf::MessageExts
105
+ extend ::Google::Protobuf::MessageExts::ClassMethods
106
+ end
107
+
108
+ # Request message for
109
+ # {::Google::Cloud::DiscoveryEngine::V1::SchemaService::Client#update_schema SchemaService.UpdateSchema}
110
+ # method.
111
+ # @!attribute [rw] schema
112
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Schema]
113
+ # Required. The {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} to update.
114
+ # @!attribute [rw] allow_missing
115
+ # @return [::Boolean]
116
+ # If set to true, and the {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} is
117
+ # not found, a new {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} will be
118
+ # created. In this situation, `update_mask` is ignored.
119
+ class UpdateSchemaRequest
120
+ include ::Google::Protobuf::MessageExts
121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
122
+ end
123
+
124
+ # Request message for
125
+ # {::Google::Cloud::DiscoveryEngine::V1::SchemaService::Client#delete_schema SchemaService.DeleteSchema}
126
+ # method.
127
+ # @!attribute [rw] name
128
+ # @return [::String]
129
+ # Required. The full resource name of the schema, in the format of
130
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
131
+ class DeleteSchemaRequest
132
+ include ::Google::Protobuf::MessageExts
133
+ extend ::Google::Protobuf::MessageExts::ClassMethods
134
+ end
135
+
136
+ # Metadata for Create Schema LRO.
137
+ # @!attribute [rw] create_time
138
+ # @return [::Google::Protobuf::Timestamp]
139
+ # Operation create time.
140
+ # @!attribute [rw] update_time
141
+ # @return [::Google::Protobuf::Timestamp]
142
+ # Operation last update time. If the operation is done, this is also the
143
+ # finish time.
144
+ class CreateSchemaMetadata
145
+ include ::Google::Protobuf::MessageExts
146
+ extend ::Google::Protobuf::MessageExts::ClassMethods
147
+ end
148
+
149
+ # Metadata for UpdateSchema LRO.
150
+ # @!attribute [rw] create_time
151
+ # @return [::Google::Protobuf::Timestamp]
152
+ # Operation create time.
153
+ # @!attribute [rw] update_time
154
+ # @return [::Google::Protobuf::Timestamp]
155
+ # Operation last update time. If the operation is done, this is also the
156
+ # finish time.
157
+ class UpdateSchemaMetadata
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
+ end
161
+
162
+ # Metadata for DeleteSchema LRO.
163
+ # @!attribute [rw] create_time
164
+ # @return [::Google::Protobuf::Timestamp]
165
+ # Operation create time.
166
+ # @!attribute [rw] update_time
167
+ # @return [::Google::Protobuf::Timestamp]
168
+ # Operation last update time. If the operation is done, this is also the
169
+ # finish time.
170
+ class DeleteSchemaMetadata
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+ end
175
+ end
176
+ end
177
+ end