google-cloud-discovery_engine-v1beta 0.10.0 → 0.12.0

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