google-cloud-discovery_engine-v1 0.6.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (139) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +9 -3
  3. data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +13 -5
  4. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +9 -3
  5. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +28 -5
  6. data/lib/google/cloud/discovery_engine/v1/control_service/client.rb +875 -0
  7. data/lib/google/cloud/discovery_engine/v1/control_service/credentials.rb +47 -0
  8. data/lib/google/cloud/discovery_engine/v1/control_service/paths.rb +167 -0
  9. data/lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb +814 -0
  10. data/lib/google/cloud/discovery_engine/v1/control_service/rest/service_stub.rb +440 -0
  11. data/lib/google/cloud/discovery_engine/v1/control_service/rest.rb +55 -0
  12. data/lib/google/cloud/discovery_engine/v1/control_service.rb +58 -0
  13. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +769 -7
  14. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +199 -0
  15. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +720 -7
  16. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +520 -0
  17. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +15 -7
  18. data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +13 -5
  19. data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +94 -0
  20. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +15 -7
  21. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +28 -5
  22. data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +71 -33
  23. data/lib/google/cloud/discovery_engine/v1/document_service/operations.rb +13 -5
  24. data/lib/google/cloud/discovery_engine/v1/document_service/paths.rb +21 -0
  25. data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +71 -33
  26. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +28 -5
  27. data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +13 -5
  28. data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +13 -5
  29. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +13 -5
  30. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +28 -5
  31. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/client.rb +471 -0
  32. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/credentials.rb +47 -0
  33. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/paths.rb +52 -0
  34. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb +438 -0
  35. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/service_stub.rb +129 -0
  36. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest.rb +52 -0
  37. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service.rb +55 -0
  38. data/lib/google/cloud/discovery_engine/v1/project_service/client.rb +485 -0
  39. data/lib/google/cloud/discovery_engine/v1/project_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1/project_service/operations.rb +809 -0
  41. data/lib/google/cloud/discovery_engine/v1/project_service/paths.rb +47 -0
  42. data/lib/google/cloud/discovery_engine/v1/project_service/rest/client.rb +452 -0
  43. data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +1114 -0
  44. data/lib/google/cloud/discovery_engine/v1/project_service/rest/service_stub.rb +129 -0
  45. data/lib/google/cloud/discovery_engine/v1/project_service/rest.rb +54 -0
  46. data/lib/google/cloud/discovery_engine/v1/project_service.rb +57 -0
  47. data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +481 -0
  48. data/lib/google/cloud/discovery_engine/v1/rank_service/credentials.rb +47 -0
  49. data/lib/google/cloud/discovery_engine/v1/rank_service/paths.rb +52 -0
  50. data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +448 -0
  51. data/lib/google/cloud/discovery_engine/v1/rank_service/rest/service_stub.rb +129 -0
  52. data/lib/google/cloud/discovery_engine/v1/rank_service/rest.rb +52 -0
  53. data/lib/google/cloud/discovery_engine/v1/rank_service.rb +55 -0
  54. data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb +558 -0
  55. data/lib/google/cloud/discovery_engine/v1/recommendation_service/credentials.rb +47 -0
  56. data/lib/google/cloud/discovery_engine/v1/recommendation_service/paths.rb +220 -0
  57. data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb +525 -0
  58. data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/service_stub.rb +145 -0
  59. data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest.rb +52 -0
  60. data/lib/google/cloud/discovery_engine/v1/recommendation_service.rb +55 -0
  61. data/lib/google/cloud/discovery_engine/v1/rest.rb +5 -0
  62. data/lib/google/cloud/discovery_engine/v1/schema_service/client.rb +18 -10
  63. data/lib/google/cloud/discovery_engine/v1/schema_service/operations.rb +13 -5
  64. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/client.rb +18 -10
  65. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +28 -5
  66. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +26 -13
  67. data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +45 -0
  68. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +26 -13
  69. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +27 -12
  70. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +13 -5
  71. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +27 -12
  72. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +28 -5
  73. data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +23 -6
  74. data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb +13 -5
  75. data/lib/google/cloud/discovery_engine/v1/user_event_service/paths.rb +21 -0
  76. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +23 -6
  77. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +28 -5
  78. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb +8 -0
  79. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  80. data/lib/google/cloud/discovery_engine/v1.rb +5 -0
  81. data/lib/google/cloud/discoveryengine/v1/answer_pb.rb +69 -0
  82. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +2 -1
  83. data/lib/google/cloud/discoveryengine/v1/control_pb.rb +55 -0
  84. data/lib/google/cloud/discoveryengine/v1/control_service_pb.rb +57 -0
  85. data/lib/google/cloud/discoveryengine/v1/control_service_services_pb.rb +69 -0
  86. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +32 -1
  87. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb +25 -0
  88. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +5 -1
  89. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +3 -1
  90. data/lib/google/cloud/discoveryengine/v1/document_processing_config_pb.rb +48 -0
  91. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +3 -1
  92. data/lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb +1 -1
  93. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +1 -1
  94. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +52 -0
  95. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_services_pb.rb +45 -0
  96. data/lib/google/cloud/discoveryengine/v1/grounding_pb.rb +46 -0
  97. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +13 -1
  98. data/lib/google/cloud/discoveryengine/v1/project_pb.rb +49 -0
  99. data/lib/google/cloud/discoveryengine/v1/project_service_pb.rb +50 -0
  100. data/lib/google/cloud/discoveryengine/v1/project_service_services_pb.rb +51 -0
  101. data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +1 -1
  102. data/lib/google/cloud/discoveryengine/v1/rank_service_pb.rb +49 -0
  103. data/lib/google/cloud/discoveryengine/v1/rank_service_services_pb.rb +45 -0
  104. data/lib/google/cloud/discoveryengine/v1/recommendation_service_pb.rb +55 -0
  105. data/lib/google/cloud/discoveryengine/v1/recommendation_service_services_pb.rb +45 -0
  106. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +4 -1
  107. data/lib/google/cloud/discoveryengine/v1/session_pb.rb +50 -0
  108. data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +1 -1
  109. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
  110. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
  111. data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +1 -1
  112. data/proto_docs/google/api/client.rb +4 -0
  113. data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +362 -0
  114. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +25 -1
  115. data/proto_docs/google/cloud/discoveryengine/v1/control.rb +207 -0
  116. data/proto_docs/google/cloud/discoveryengine/v1/control_service.rb +126 -0
  117. data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +2 -2
  118. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +490 -0
  119. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +19 -0
  120. data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +2 -2
  121. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +7 -0
  122. data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +102 -0
  123. data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +8 -4
  124. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +5 -5
  125. data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +144 -0
  126. data/proto_docs/google/cloud/discoveryengine/v1/grounding.rb +79 -0
  127. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +313 -24
  128. data/proto_docs/google/cloud/discoveryengine/v1/project.rb +106 -0
  129. data/proto_docs/google/cloud/discoveryengine/v1/project_service.rb +57 -0
  130. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +3 -0
  131. data/proto_docs/google/cloud/discoveryengine/v1/rank_service.rb +124 -0
  132. data/proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb +229 -0
  133. data/proto_docs/google/cloud/discoveryengine/v1/schema_service.rb +5 -5
  134. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +150 -37
  135. data/proto_docs/google/cloud/discoveryengine/v1/session.rb +88 -0
  136. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +3 -0
  137. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +40 -14
  138. data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb +13 -1
  139. metadata +66 -2
@@ -24,7 +24,7 @@ module Google
24
24
  # Cloud Storage location for input content.
25
25
  # @!attribute [rw] input_uris
26
26
  # @return [::Array<::String>]
27
- # Required. Cloud Storage URIs to input files. URI can be up to
27
+ # Required. Cloud Storage URIs to input files. Each URI can be up to
28
28
  # 2000 characters long. URIs can match the full object path (for example,
29
29
  # `gs://bucket/directory/object.json`) or a pattern matching one or more
30
30
  # files, such as `gs://bucket/directory/*.json`.
@@ -47,13 +47,13 @@ module Google
47
47
  # bits of SHA256(URI) encoded as a hex string.
48
48
  # * `custom`: One custom data JSON per row in arbitrary format that conforms
49
49
  # to the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
50
- # data store. This can only be used by Gen App Builder.
50
+ # data store. This can only be used by the GENERIC Data Store vertical.
51
51
  # * `csv`: A CSV file with header conforming to the defined
52
52
  # {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
53
53
  # data store. Each entry after the header is imported as a Document.
54
- # This can only be used by Gen App Builder.
54
+ # This can only be used by the GENERIC Data Store vertical.
55
55
  #
56
- # Supported values for user even imports:
56
+ # Supported values for user event imports:
57
57
  #
58
58
  # * `user_event` (default): One JSON
59
59
  # {::Google::Cloud::DiscoveryEngine::V1::UserEvent UserEvent} per line.
@@ -104,12 +104,267 @@ module Google
104
104
  # {::Google::Cloud::DiscoveryEngine::V1::Document#struct_data Document.struct_data}.
105
105
  # * `custom`: One custom data per row in arbitrary format that conforms to
106
106
  # the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the data
107
- # store. This can only be used by Gen App Builder.
107
+ # store. This can only be used by the GENERIC Data Store vertical.
108
108
  class BigQuerySource
109
109
  include ::Google::Protobuf::MessageExts
110
110
  extend ::Google::Protobuf::MessageExts::ClassMethods
111
111
  end
112
112
 
113
+ # The Spanner source for importing data
114
+ # @!attribute [rw] project_id
115
+ # @return [::String]
116
+ # The project ID that the Spanner source is in with a length limit of 128
117
+ # characters. If not specified, inherits the project ID from the parent
118
+ # request.
119
+ # @!attribute [rw] instance_id
120
+ # @return [::String]
121
+ # Required. The instance ID of the source Spanner table.
122
+ # @!attribute [rw] database_id
123
+ # @return [::String]
124
+ # Required. The database ID of the source Spanner table.
125
+ # @!attribute [rw] table_id
126
+ # @return [::String]
127
+ # Required. The table name of the Spanner database that needs to be imported.
128
+ # @!attribute [rw] enable_data_boost
129
+ # @return [::Boolean]
130
+ # Whether to apply data boost on Spanner export. Enabling this option will
131
+ # incur additional cost. More info can be found
132
+ # [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).
133
+ class SpannerSource
134
+ include ::Google::Protobuf::MessageExts
135
+ extend ::Google::Protobuf::MessageExts::ClassMethods
136
+ end
137
+
138
+ # The Bigtable Options object that contains information to support
139
+ # the import.
140
+ # @!attribute [rw] key_field_name
141
+ # @return [::String]
142
+ # The field name used for saving row key value in the document. The name has
143
+ # to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
144
+ # @!attribute [rw] families
145
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily}]
146
+ # The mapping from family names to an object that contains column families
147
+ # level information for the given column family. If a family is not present
148
+ # in this map it will be ignored.
149
+ class BigtableOptions
150
+ include ::Google::Protobuf::MessageExts
151
+ extend ::Google::Protobuf::MessageExts::ClassMethods
152
+
153
+ # The column family of the Bigtable.
154
+ # @!attribute [rw] field_name
155
+ # @return [::String]
156
+ # The field name to use for this column family in the document. The
157
+ # name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set,
158
+ # it is parsed from the family name with best effort. However, due to
159
+ # different naming patterns, field name collisions could happen, where
160
+ # parsing behavior is undefined.
161
+ # @!attribute [rw] encoding
162
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding]
163
+ # The encoding mode of the values when the type is not STRING.
164
+ # Acceptable encoding values are:
165
+ #
166
+ # * `TEXT`: indicates values are alphanumeric text strings.
167
+ # * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
168
+ # family of functions. This can be overridden for a specific column
169
+ # by listing that column in `columns` and specifying an encoding for it.
170
+ # @!attribute [rw] type
171
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Type]
172
+ # The type of values in this column family.
173
+ # The values are expected to be encoded using `HBase Bytes.toBytes`
174
+ # function when the encoding value is set to `BINARY`.
175
+ # @!attribute [rw] columns
176
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumn>]
177
+ # The list of objects that contains column level information for each
178
+ # column. If a column is not present in this list it will be ignored.
179
+ class BigtableColumnFamily
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # The column of the Bigtable.
185
+ # @!attribute [rw] qualifier
186
+ # @return [::String]
187
+ # Required. Qualifier of the column. If it cannot be decoded with utf-8,
188
+ # use a base-64 encoded string instead.
189
+ # @!attribute [rw] field_name
190
+ # @return [::String]
191
+ # The field name to use for this column in the document. The name has to
192
+ # match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
193
+ # If not set, it is parsed from the qualifier bytes with best effort.
194
+ # However, due to different naming patterns, field name collisions could
195
+ # happen, where parsing behavior is undefined.
196
+ # @!attribute [rw] encoding
197
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding]
198
+ # The encoding mode of the values when the type is not `STRING`.
199
+ # Acceptable encoding values are:
200
+ #
201
+ # * `TEXT`: indicates values are alphanumeric text strings.
202
+ # * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
203
+ # family of functions. This can be overridden for a specific column
204
+ # by listing that column in `columns` and specifying an encoding for it.
205
+ # @!attribute [rw] type
206
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Type]
207
+ # The type of values in this column family.
208
+ # The values are expected to be encoded using `HBase Bytes.toBytes`
209
+ # function when the encoding value is set to `BINARY`.
210
+ class BigtableColumn
211
+ include ::Google::Protobuf::MessageExts
212
+ extend ::Google::Protobuf::MessageExts::ClassMethods
213
+ end
214
+
215
+ # @!attribute [rw] key
216
+ # @return [::String]
217
+ # @!attribute [rw] value
218
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily]
219
+ class FamiliesEntry
220
+ include ::Google::Protobuf::MessageExts
221
+ extend ::Google::Protobuf::MessageExts::ClassMethods
222
+ end
223
+
224
+ # The type of values in a Bigtable column or column family.
225
+ # The values are expected to be encoded using
226
+ # [HBase
227
+ # Bytes.toBytes](https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html)
228
+ # function when the encoding value is set to `BINARY`.
229
+ module Type
230
+ # The type is unspecified.
231
+ TYPE_UNSPECIFIED = 0
232
+
233
+ # String type.
234
+ STRING = 1
235
+
236
+ # Numerical type.
237
+ NUMBER = 2
238
+
239
+ # Integer type.
240
+ INTEGER = 3
241
+
242
+ # Variable length integer type.
243
+ VAR_INTEGER = 4
244
+
245
+ # BigDecimal type.
246
+ BIG_NUMERIC = 5
247
+
248
+ # Boolean type.
249
+ BOOLEAN = 6
250
+
251
+ # JSON type.
252
+ JSON = 7
253
+ end
254
+
255
+ # The encoding mode of a Bigtable column or column family.
256
+ module Encoding
257
+ # The encoding is unspecified.
258
+ ENCODING_UNSPECIFIED = 0
259
+
260
+ # Text encoding.
261
+ TEXT = 1
262
+
263
+ # Binary encoding.
264
+ BINARY = 2
265
+ end
266
+ end
267
+
268
+ # The Cloud Bigtable source for importing data.
269
+ # @!attribute [rw] project_id
270
+ # @return [::String]
271
+ # The project ID that the Bigtable source is in with a length limit of 128
272
+ # characters. If not specified, inherits the project ID from the parent
273
+ # request.
274
+ # @!attribute [rw] instance_id
275
+ # @return [::String]
276
+ # Required. The instance ID of the Cloud Bigtable that needs to be imported.
277
+ # @!attribute [rw] table_id
278
+ # @return [::String]
279
+ # Required. The table ID of the Cloud Bigtable that needs to be imported.
280
+ # @!attribute [rw] bigtable_options
281
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions]
282
+ # Required. Bigtable options that contains information needed when parsing
283
+ # data into typed structures. For example, column type annotations.
284
+ class BigtableSource
285
+ include ::Google::Protobuf::MessageExts
286
+ extend ::Google::Protobuf::MessageExts::ClassMethods
287
+ end
288
+
289
+ # Cloud FhirStore source import data from.
290
+ # @!attribute [rw] fhir_store
291
+ # @return [::String]
292
+ # Required. The full resource name of the FHIR store to import data from, in
293
+ # the format of
294
+ # `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
295
+ # @!attribute [rw] gcs_staging_dir
296
+ # @return [::String]
297
+ # Intermediate Cloud Storage directory used for the import with a length
298
+ # limit of 2,000 characters. Can be specified if one wants to have the
299
+ # FhirStore export to a specific Cloud Storage directory.
300
+ class FhirStoreSource
301
+ include ::Google::Protobuf::MessageExts
302
+ extend ::Google::Protobuf::MessageExts::ClassMethods
303
+ end
304
+
305
+ # Cloud SQL source import data from.
306
+ # @!attribute [rw] project_id
307
+ # @return [::String]
308
+ # The project ID that the Cloud SQL source is in with a length limit of 128
309
+ # characters. If not specified, inherits the project ID from the parent
310
+ # request.
311
+ # @!attribute [rw] instance_id
312
+ # @return [::String]
313
+ # Required. The Cloud SQL instance to copy the data from with a length limit
314
+ # of 256 characters.
315
+ # @!attribute [rw] database_id
316
+ # @return [::String]
317
+ # Required. The Cloud SQL database to copy the data from with a length limit
318
+ # of 256 characters.
319
+ # @!attribute [rw] table_id
320
+ # @return [::String]
321
+ # Required. The Cloud SQL table to copy the data from with a length limit of
322
+ # 256 characters.
323
+ # @!attribute [rw] gcs_staging_dir
324
+ # @return [::String]
325
+ # Intermediate Cloud Storage directory used for the import with a length
326
+ # limit of 2,000 characters. Can be specified if one wants to have the
327
+ # Cloud SQL export to a specific Cloud Storage directory.
328
+ #
329
+ # Ensure that the Cloud SQL service account has the necessary Cloud
330
+ # Storage Admin permissions to access the specified Cloud Storage directory.
331
+ # @!attribute [rw] offload
332
+ # @return [::Boolean]
333
+ # Option for serverless export. Enabling this option will incur additional
334
+ # cost. More info can be found
335
+ # [here](https://cloud.google.com/sql/pricing#serverless).
336
+ class CloudSqlSource
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+ end
340
+
341
+ # Firestore source import data from.
342
+ # @!attribute [rw] project_id
343
+ # @return [::String]
344
+ # The project ID that the Cloud SQL source is in with a length limit of 128
345
+ # characters. If not specified, inherits the project ID from the parent
346
+ # request.
347
+ # @!attribute [rw] database_id
348
+ # @return [::String]
349
+ # Required. The Firestore database to copy the data from with a length limit
350
+ # of 256 characters.
351
+ # @!attribute [rw] collection_id
352
+ # @return [::String]
353
+ # Required. The Firestore collection (or entity) to copy the data from with a
354
+ # length limit of 1,500 characters.
355
+ # @!attribute [rw] gcs_staging_dir
356
+ # @return [::String]
357
+ # Intermediate Cloud Storage directory used for the import with a length
358
+ # limit of 2,000 characters. Can be specified if one wants to have the
359
+ # Firestore export to a specific Cloud Storage directory.
360
+ #
361
+ # Ensure that the Firestore service account has the necessary Cloud
362
+ # Storage Admin permissions to access the specified Cloud Storage directory.
363
+ class FirestoreSource
364
+ include ::Google::Protobuf::MessageExts
365
+ extend ::Google::Protobuf::MessageExts::ClassMethods
366
+ end
367
+
113
368
  # Configuration of destination for Import related errors.
114
369
  # @!attribute [rw] gcs_prefix
115
370
  # @return [::String]
@@ -211,6 +466,9 @@ module Google
211
466
  # @!attribute [rw] failure_count
212
467
  # @return [::Integer]
213
468
  # Count of entries that encountered errors while processing.
469
+ # @!attribute [rw] total_count
470
+ # @return [::Integer]
471
+ # Total count of entries that were processed.
214
472
  class ImportDocumentsMetadata
215
473
  include ::Google::Protobuf::MessageExts
216
474
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -226,6 +484,21 @@ module Google
226
484
  # @!attribute [rw] bigquery_source
227
485
  # @return [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource]
228
486
  # BigQuery input source.
487
+ # @!attribute [rw] fhir_store_source
488
+ # @return [::Google::Cloud::DiscoveryEngine::V1::FhirStoreSource]
489
+ # FhirStore input source.
490
+ # @!attribute [rw] spanner_source
491
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SpannerSource]
492
+ # Spanner input source.
493
+ # @!attribute [rw] cloud_sql_source
494
+ # @return [::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource]
495
+ # Cloud SQL input source.
496
+ # @!attribute [rw] firestore_source
497
+ # @return [::Google::Cloud::DiscoveryEngine::V1::FirestoreSource]
498
+ # Firestore input source.
499
+ # @!attribute [rw] bigtable_source
500
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BigtableSource]
501
+ # Cloud Bigtable input source.
229
502
  # @!attribute [rw] parent
230
503
  # @return [::String]
231
504
  # Required. The parent branch resource name, such as
@@ -239,6 +512,10 @@ module Google
239
512
  # The mode of reconciliation between existing documents and the documents to
240
513
  # be imported. Defaults to
241
514
  # {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
515
+ # @!attribute [rw] update_mask
516
+ # @return [::Google::Protobuf::FieldMask]
517
+ # Indicates which fields in the provided imported documents to update. If
518
+ # not set, the default is to update all fields.
242
519
  # @!attribute [rw] auto_generate_ids
243
520
  # @return [::Boolean]
244
521
  # Whether to automatically generate IDs for the documents if absent.
@@ -254,42 +531,54 @@ module Google
254
531
  # {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#id_field id_field},
255
532
  # otherwise, documents without IDs fail to be imported.
256
533
  #
257
- # Only set this field when using
258
- # {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
259
- # {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}, and when
534
+ # Supported data sources:
535
+ #
536
+ # * {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource}.
260
537
  # {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
261
- # or
538
+ # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
539
+ # * {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}.
262
540
  # {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
263
- # is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
541
+ # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
542
+ # * {::Google::Cloud::DiscoveryEngine::V1::SpannerSource SpannerSource}.
543
+ # * {::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource CloudSqlSource}.
544
+ # * {::Google::Cloud::DiscoveryEngine::V1::FirestoreSource FirestoreSource}.
545
+ # * {::Google::Cloud::DiscoveryEngine::V1::BigtableSource BigtableSource}.
264
546
  # @!attribute [rw] id_field
265
547
  # @return [::String]
266
- # The field in the Cloud Storage and BigQuery sources that indicates the
267
- # unique IDs of the documents.
548
+ # The field indicates the ID field or column to be used as unique IDs of
549
+ # the documents.
268
550
  #
269
551
  # For {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} it is the key of
270
552
  # 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.
553
+ # For others, it may be the column name of the table where the unique ids are
554
+ # stored.
273
555
  #
274
- # The values of the JSON field or the BigQuery column are used as the
556
+ # The values of the JSON field or the table column are used as the
275
557
  # {::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)
558
+ # or the table column must be of string type, and the values must be set as
559
+ # valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
278
560
  # with 1-63 characters. Otherwise, documents without valid IDs fail to be
279
561
  # imported.
280
562
  #
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
563
+ # Only set this field when
288
564
  # {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#auto_generate_ids auto_generate_ids}
289
565
  # is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
290
566
  #
291
567
  # If it is unset, a default value `_id` is used when importing from the
292
568
  # allowed data sources.
569
+ #
570
+ # Supported data sources:
571
+ #
572
+ # * {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource}.
573
+ # {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
574
+ # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
575
+ # * {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}.
576
+ # {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
577
+ # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
578
+ # * {::Google::Cloud::DiscoveryEngine::V1::SpannerSource SpannerSource}.
579
+ # * {::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource CloudSqlSource}.
580
+ # * {::Google::Cloud::DiscoveryEngine::V1::FirestoreSource FirestoreSource}.
581
+ # * {::Google::Cloud::DiscoveryEngine::V1::BigtableSource BigtableSource}.
293
582
  class ImportDocumentsRequest
294
583
  include ::Google::Protobuf::MessageExts
295
584
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -0,0 +1,106 @@
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
+ # Metadata and configurations for a Google Cloud project in the service.
25
+ # @!attribute [r] name
26
+ # @return [::String]
27
+ # Output only. Full resource name of the project, for example
28
+ # `projects/{project_number}`.
29
+ # Note that when making requests, project number and project id are both
30
+ # acceptable, but the server will always respond in project number.
31
+ # @!attribute [r] create_time
32
+ # @return [::Google::Protobuf::Timestamp]
33
+ # Output only. The timestamp when this project is created.
34
+ # @!attribute [r] provision_completion_time
35
+ # @return [::Google::Protobuf::Timestamp]
36
+ # Output only. The timestamp when this project is successfully provisioned.
37
+ # Empty value means this project is still provisioning and is not ready for
38
+ # use.
39
+ # @!attribute [r] service_terms_map
40
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms}]
41
+ # Output only. A map of terms of services. The key is the `id` of
42
+ # {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms ServiceTerms}.
43
+ class Project
44
+ include ::Google::Protobuf::MessageExts
45
+ extend ::Google::Protobuf::MessageExts::ClassMethods
46
+
47
+ # Metadata about the terms of service.
48
+ # @!attribute [rw] id
49
+ # @return [::String]
50
+ # The unique identifier of this terms of service.
51
+ # Available terms:
52
+ #
53
+ # * `GA_DATA_USE_TERMS`: [Terms for data
54
+ # use](https://cloud.google.com/retail/data-use-terms). When using this as
55
+ # `id`, the acceptable
56
+ # {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#version version}
57
+ # to provide is `2022-11-23`.
58
+ # @!attribute [rw] version
59
+ # @return [::String]
60
+ # The version string of the terms of service.
61
+ # For acceptable values, see the comments for
62
+ # {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#id id} above.
63
+ # @!attribute [rw] state
64
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms::State]
65
+ # Whether the project has accepted/rejected the service terms or it is
66
+ # still pending.
67
+ # @!attribute [rw] accept_time
68
+ # @return [::Google::Protobuf::Timestamp]
69
+ # The last time when the project agreed to the terms of service.
70
+ # @!attribute [rw] decline_time
71
+ # @return [::Google::Protobuf::Timestamp]
72
+ # The last time when the project declined or revoked the agreement to terms
73
+ # of service.
74
+ class ServiceTerms
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+
78
+ # The agreement states this terms of service.
79
+ module State
80
+ # The default value of the enum. This value is not actually used.
81
+ STATE_UNSPECIFIED = 0
82
+
83
+ # The project has given consent to the terms of service.
84
+ TERMS_ACCEPTED = 1
85
+
86
+ # The project is pending to review and accept the terms of service.
87
+ TERMS_PENDING = 2
88
+
89
+ # The project has declined or revoked the agreement to terms of service.
90
+ TERMS_DECLINED = 3
91
+ end
92
+ end
93
+
94
+ # @!attribute [rw] key
95
+ # @return [::String]
96
+ # @!attribute [rw] value
97
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms]
98
+ class ServiceTermsMapEntry
99
+ include ::Google::Protobuf::MessageExts
100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
101
+ end
102
+ end
103
+ end
104
+ end
105
+ end
106
+ end
@@ -0,0 +1,57 @@
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
25
+ # {::Google::Cloud::DiscoveryEngine::V1::ProjectService::Client#provision_project ProjectService.ProvisionProject}
26
+ # method.
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # Required. Full resource name of a
30
+ # {::Google::Cloud::DiscoveryEngine::V1::Project Project}, such as
31
+ # `projects/{project_id_or_number}`.
32
+ # @!attribute [rw] accept_data_use_terms
33
+ # @return [::Boolean]
34
+ # Required. Set to `true` to specify that caller has read and would like to
35
+ # give consent to the [Terms for data
36
+ # use](https://cloud.google.com/retail/data-use-terms).
37
+ # @!attribute [rw] data_use_terms_version
38
+ # @return [::String]
39
+ # Required. The version of the [Terms for data
40
+ # use](https://cloud.google.com/retail/data-use-terms) that caller has read
41
+ # and would like to give consent to.
42
+ #
43
+ # Acceptable version is `2022-11-23`, and this may change over time.
44
+ class ProvisionProjectRequest
45
+ include ::Google::Protobuf::MessageExts
46
+ extend ::Google::Protobuf::MessageExts::ClassMethods
47
+ end
48
+
49
+ # Metadata associated with a project provision operation.
50
+ class ProvisionProjectMetadata
51
+ include ::Google::Protobuf::MessageExts
52
+ extend ::Google::Protobuf::MessageExts::ClassMethods
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -74,6 +74,9 @@ module Google
74
74
  # @!attribute [rw] failure_count
75
75
  # @return [::Integer]
76
76
  # Count of entries that encountered errors while processing.
77
+ # @!attribute [rw] ignored_count
78
+ # @return [::Integer]
79
+ # Count of entries that were ignored as entries were not found.
77
80
  class PurgeDocumentsMetadata
78
81
  include ::Google::Protobuf::MessageExts
79
82
  extend ::Google::Protobuf::MessageExts::ClassMethods