google-apis-discoveryengine_v1beta 0.13.0 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fd82e65a2718fe6cf2664b8baf510c457f310f541b0081abf0b5f1efacc88c05
4
- data.tar.gz: 0f11a80e71d3d0e07dc8ff93540c281e9d79857301e29f3ed091c3e9e20ea9f0
3
+ metadata.gz: 689a78e9e8d65ee55fcbca5f095c0bf9acda8a7cd71b2396e8d7a7b780773205
4
+ data.tar.gz: ae867a88eb0278137d054b0f1bdd55daf383e63a44c57bd49248cf10f413b121
5
5
  SHA512:
6
- metadata.gz: daf5b78901c7d9a4c9f62ce6d6b40e7185d0c04c89aadbc9fafcabb7fd9d59a976ce45cb9a65a6c8f228c6c264957eccbf704be06375c14ede267041c0108801
7
- data.tar.gz: 228de354cd75fc3145de63358763e09470763453d2d6ddbd4f6ff15a0f19d9597cca024b01f19f307a8e1122e11f62badcde4fde285d10d52384712c1d39d2c7
6
+ metadata.gz: dd29e682d03323d08275d8b066eabe5c5864fe90627126876e096d0da141bc100b17a9b4588f40eaec7d29a25ac704edd80d1d55a19e3508f02c104bc711f3a5
7
+ data.tar.gz: 28f066b57e66de36a0f104aa80fbfacaddad44fc43390744901fc02c70afa4a6e853ac70cb9b4ad3e3bb748b881de7ab59abd7059822ad6e289ccd4dffb7a7fd
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-discoveryengine_v1beta
2
2
 
3
+ ### v0.15.0 (2023-06-25)
4
+
5
+ * Regenerated from discovery document revision 20230620
6
+
7
+ ### v0.14.0 (2023-05-28)
8
+
9
+ * Regenerated from discovery document revision 20230525
10
+
3
11
  ### v0.13.0 (2023-05-14)
4
12
 
5
13
  * Regenerated from discovery document revision 20230504
@@ -276,6 +276,293 @@ module Google
276
276
  end
277
277
  end
278
278
 
279
+ # Metadata related to the progress of the ImportDocuments operation. This will
280
+ # be returned by the google.longrunning.Operation.metadata field.
281
+ class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
282
+ include Google::Apis::Core::Hashable
283
+
284
+ # Operation create time.
285
+ # Corresponds to the JSON property `createTime`
286
+ # @return [String]
287
+ attr_accessor :create_time
288
+
289
+ # Count of entries that encountered errors while processing.
290
+ # Corresponds to the JSON property `failureCount`
291
+ # @return [Fixnum]
292
+ attr_accessor :failure_count
293
+
294
+ # Count of entries that were processed successfully.
295
+ # Corresponds to the JSON property `successCount`
296
+ # @return [Fixnum]
297
+ attr_accessor :success_count
298
+
299
+ # Operation last update time. If the operation is done, this is also the finish
300
+ # time.
301
+ # Corresponds to the JSON property `updateTime`
302
+ # @return [String]
303
+ attr_accessor :update_time
304
+
305
+ def initialize(**args)
306
+ update!(**args)
307
+ end
308
+
309
+ # Update properties of this object
310
+ def update!(**args)
311
+ @create_time = args[:create_time] if args.key?(:create_time)
312
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
313
+ @success_count = args[:success_count] if args.key?(:success_count)
314
+ @update_time = args[:update_time] if args.key?(:update_time)
315
+ end
316
+ end
317
+
318
+ # Response of the ImportDocumentsRequest. If the long running operation is done,
319
+ # then this message is returned by the google.longrunning.Operations.response
320
+ # field if the operation was successful.
321
+ class GoogleCloudDiscoveryengineV1ImportDocumentsResponse
322
+ include Google::Apis::Core::Hashable
323
+
324
+ # Configuration of destination for Import related errors.
325
+ # Corresponds to the JSON property `errorConfig`
326
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig]
327
+ attr_accessor :error_config
328
+
329
+ # A sample of errors encountered while processing the request.
330
+ # Corresponds to the JSON property `errorSamples`
331
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
332
+ attr_accessor :error_samples
333
+
334
+ def initialize(**args)
335
+ update!(**args)
336
+ end
337
+
338
+ # Update properties of this object
339
+ def update!(**args)
340
+ @error_config = args[:error_config] if args.key?(:error_config)
341
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
342
+ end
343
+ end
344
+
345
+ # Configuration of destination for Import related errors.
346
+ class GoogleCloudDiscoveryengineV1ImportErrorConfig
347
+ include Google::Apis::Core::Hashable
348
+
349
+ # Cloud Storage prefix for import errors. This must be an empty, existing Cloud
350
+ # Storage directory. Import errors will be written to sharded files in this
351
+ # directory, one per line, as a JSON-encoded `google.rpc.Status` message.
352
+ # Corresponds to the JSON property `gcsPrefix`
353
+ # @return [String]
354
+ attr_accessor :gcs_prefix
355
+
356
+ def initialize(**args)
357
+ update!(**args)
358
+ end
359
+
360
+ # Update properties of this object
361
+ def update!(**args)
362
+ @gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
363
+ end
364
+ end
365
+
366
+ # Metadata related to the progress of the Import operation. This will be
367
+ # returned by the google.longrunning.Operation.metadata field.
368
+ class GoogleCloudDiscoveryengineV1ImportUserEventsMetadata
369
+ include Google::Apis::Core::Hashable
370
+
371
+ # Operation create time.
372
+ # Corresponds to the JSON property `createTime`
373
+ # @return [String]
374
+ attr_accessor :create_time
375
+
376
+ # Count of entries that encountered errors while processing.
377
+ # Corresponds to the JSON property `failureCount`
378
+ # @return [Fixnum]
379
+ attr_accessor :failure_count
380
+
381
+ # Count of entries that were processed successfully.
382
+ # Corresponds to the JSON property `successCount`
383
+ # @return [Fixnum]
384
+ attr_accessor :success_count
385
+
386
+ # Operation last update time. If the operation is done, this is also the finish
387
+ # time.
388
+ # Corresponds to the JSON property `updateTime`
389
+ # @return [String]
390
+ attr_accessor :update_time
391
+
392
+ def initialize(**args)
393
+ update!(**args)
394
+ end
395
+
396
+ # Update properties of this object
397
+ def update!(**args)
398
+ @create_time = args[:create_time] if args.key?(:create_time)
399
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
400
+ @success_count = args[:success_count] if args.key?(:success_count)
401
+ @update_time = args[:update_time] if args.key?(:update_time)
402
+ end
403
+ end
404
+
405
+ # Response of the ImportUserEventsRequest. If the long running operation was
406
+ # successful, then this message is returned by the google.longrunning.Operations.
407
+ # response field if the operation was successful.
408
+ class GoogleCloudDiscoveryengineV1ImportUserEventsResponse
409
+ include Google::Apis::Core::Hashable
410
+
411
+ # Configuration of destination for Import related errors.
412
+ # Corresponds to the JSON property `errorConfig`
413
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig]
414
+ attr_accessor :error_config
415
+
416
+ # A sample of errors encountered while processing the request.
417
+ # Corresponds to the JSON property `errorSamples`
418
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
419
+ attr_accessor :error_samples
420
+
421
+ # Count of user events imported with complete existing Documents.
422
+ # Corresponds to the JSON property `joinedEventsCount`
423
+ # @return [Fixnum]
424
+ attr_accessor :joined_events_count
425
+
426
+ # Count of user events imported, but with Document information not found in the
427
+ # existing Branch.
428
+ # Corresponds to the JSON property `unjoinedEventsCount`
429
+ # @return [Fixnum]
430
+ attr_accessor :unjoined_events_count
431
+
432
+ def initialize(**args)
433
+ update!(**args)
434
+ end
435
+
436
+ # Update properties of this object
437
+ def update!(**args)
438
+ @error_config = args[:error_config] if args.key?(:error_config)
439
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
440
+ @joined_events_count = args[:joined_events_count] if args.key?(:joined_events_count)
441
+ @unjoined_events_count = args[:unjoined_events_count] if args.key?(:unjoined_events_count)
442
+ end
443
+ end
444
+
445
+ # Metadata related to the progress of the PurgeDocuments operation. This will be
446
+ # returned by the google.longrunning.Operation.metadata field.
447
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata
448
+ include Google::Apis::Core::Hashable
449
+
450
+ # Operation create time.
451
+ # Corresponds to the JSON property `createTime`
452
+ # @return [String]
453
+ attr_accessor :create_time
454
+
455
+ # Count of entries that encountered errors while processing.
456
+ # Corresponds to the JSON property `failureCount`
457
+ # @return [Fixnum]
458
+ attr_accessor :failure_count
459
+
460
+ # Count of entries that were deleted successfully.
461
+ # Corresponds to the JSON property `successCount`
462
+ # @return [Fixnum]
463
+ attr_accessor :success_count
464
+
465
+ # Operation last update time. If the operation is done, this is also the finish
466
+ # time.
467
+ # Corresponds to the JSON property `updateTime`
468
+ # @return [String]
469
+ attr_accessor :update_time
470
+
471
+ def initialize(**args)
472
+ update!(**args)
473
+ end
474
+
475
+ # Update properties of this object
476
+ def update!(**args)
477
+ @create_time = args[:create_time] if args.key?(:create_time)
478
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
479
+ @success_count = args[:success_count] if args.key?(:success_count)
480
+ @update_time = args[:update_time] if args.key?(:update_time)
481
+ end
482
+ end
483
+
484
+ # Response message for DocumentService.PurgeDocuments method. If the long
485
+ # running operation is successfully done, then this message is returned by the
486
+ # google.longrunning.Operations.response field.
487
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsResponse
488
+ include Google::Apis::Core::Hashable
489
+
490
+ # The total count of documents purged as a result of the operation.
491
+ # Corresponds to the JSON property `purgeCount`
492
+ # @return [Fixnum]
493
+ attr_accessor :purge_count
494
+
495
+ # A sample of document names that will be deleted. Only populated if `force` is
496
+ # set to false. A max of 100 names will be returned and the names are chosen at
497
+ # random.
498
+ # Corresponds to the JSON property `purgeSample`
499
+ # @return [Array<String>]
500
+ attr_accessor :purge_sample
501
+
502
+ def initialize(**args)
503
+ update!(**args)
504
+ end
505
+
506
+ # Update properties of this object
507
+ def update!(**args)
508
+ @purge_count = args[:purge_count] if args.key?(:purge_count)
509
+ @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
510
+ end
511
+ end
512
+
513
+ # Defines the structure and layout of a type of document data.
514
+ class GoogleCloudDiscoveryengineV1Schema
515
+ include Google::Apis::Core::Hashable
516
+
517
+ # The JSON representation of the schema.
518
+ # Corresponds to the JSON property `jsonSchema`
519
+ # @return [String]
520
+ attr_accessor :json_schema
521
+
522
+ # Immutable. The full resource name of the schema, in the format of `projects/`
523
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
524
+ # schemas/`schema``. This field must be a UTF-8 encoded string with a length
525
+ # limit of 1024 characters.
526
+ # Corresponds to the JSON property `name`
527
+ # @return [String]
528
+ attr_accessor :name
529
+
530
+ # The structured representation of the schema.
531
+ # Corresponds to the JSON property `structSchema`
532
+ # @return [Hash<String,Object>]
533
+ attr_accessor :struct_schema
534
+
535
+ def initialize(**args)
536
+ update!(**args)
537
+ end
538
+
539
+ # Update properties of this object
540
+ def update!(**args)
541
+ @json_schema = args[:json_schema] if args.key?(:json_schema)
542
+ @name = args[:name] if args.key?(:name)
543
+ @struct_schema = args[:struct_schema] if args.key?(:struct_schema)
544
+ end
545
+ end
546
+
547
+ # Response message for SiteSearchEngineService.BatchCreateTargetSites method.
548
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
549
+ include Google::Apis::Core::Hashable
550
+
551
+ # TargetSites created.
552
+ # Corresponds to the JSON property `targetSites`
553
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite>]
554
+ attr_accessor :target_sites
555
+
556
+ def initialize(**args)
557
+ update!(**args)
558
+ end
559
+
560
+ # Update properties of this object
561
+ def update!(**args)
562
+ @target_sites = args[:target_sites] if args.key?(:target_sites)
563
+ end
564
+ end
565
+
279
566
  # Metadata related to the progress of the ImportDocuments operation. This will
280
567
  # be returned by the google.longrunning.Operation.metadata field.
281
568
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
@@ -510,6 +797,66 @@ module Google
510
797
  end
511
798
  end
512
799
 
800
+ # Metadata related to the progress of the PurgeUserEvents operation. This will
801
+ # be returned by the google.longrunning.Operation.metadata field.
802
+ class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata
803
+ include Google::Apis::Core::Hashable
804
+
805
+ # Operation create time.
806
+ # Corresponds to the JSON property `createTime`
807
+ # @return [String]
808
+ attr_accessor :create_time
809
+
810
+ # Count of entries that encountered errors while processing.
811
+ # Corresponds to the JSON property `failureCount`
812
+ # @return [Fixnum]
813
+ attr_accessor :failure_count
814
+
815
+ # Count of entries that were deleted successfully.
816
+ # Corresponds to the JSON property `successCount`
817
+ # @return [Fixnum]
818
+ attr_accessor :success_count
819
+
820
+ # Operation last update time. If the operation is done, this is also the finish
821
+ # time.
822
+ # Corresponds to the JSON property `updateTime`
823
+ # @return [String]
824
+ attr_accessor :update_time
825
+
826
+ def initialize(**args)
827
+ update!(**args)
828
+ end
829
+
830
+ # Update properties of this object
831
+ def update!(**args)
832
+ @create_time = args[:create_time] if args.key?(:create_time)
833
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
834
+ @success_count = args[:success_count] if args.key?(:success_count)
835
+ @update_time = args[:update_time] if args.key?(:update_time)
836
+ end
837
+ end
838
+
839
+ # Response of the PurgeUserEventsRequest. If the long running operation is
840
+ # successfully done, then this message is returned by the google.longrunning.
841
+ # Operations.response field.
842
+ class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse
843
+ include Google::Apis::Core::Hashable
844
+
845
+ # The total count of events purged as a result of the operation.
846
+ # Corresponds to the JSON property `purgeCount`
847
+ # @return [Fixnum]
848
+ attr_accessor :purge_count
849
+
850
+ def initialize(**args)
851
+ update!(**args)
852
+ end
853
+
854
+ # Update properties of this object
855
+ def update!(**args)
856
+ @purge_count = args[:purge_count] if args.key?(:purge_count)
857
+ end
858
+ end
859
+
513
860
  # Defines the structure and layout of a type of document data.
514
861
  class GoogleCloudDiscoveryengineV1alphaSchema
515
862
  include Google::Apis::Core::Hashable
@@ -544,6 +891,66 @@ module Google
544
891
  end
545
892
  end
546
893
 
894
+ # A target site for the SiteSearchEngine.
895
+ class GoogleCloudDiscoveryengineV1alphaTargetSite
896
+ include Google::Apis::Core::Hashable
897
+
898
+ # Input only. If set to false, an uri_pattern will be generated to include all
899
+ # pages whose address contains the provided_uri_pattern. If set to true, an
900
+ # uri_pattern will be generated to try to be an exact match of the
901
+ # provided_uri_pattern or just the specific page if the provided_uri_pattern is
902
+ # a specific one. provided_uri_pattern will always be normalized to generate the
903
+ # uri pattern to be used by the search engine.
904
+ # Corresponds to the JSON property `exactMatch`
905
+ # @return [Boolean]
906
+ attr_accessor :exact_match
907
+ alias_method :exact_match?, :exact_match
908
+
909
+ # Output only. This is system-generated based on the provided_uri_pattern.
910
+ # Corresponds to the JSON property `generatedUriPattern`
911
+ # @return [String]
912
+ attr_accessor :generated_uri_pattern
913
+
914
+ # Output only. The fully qualified resource name of the target site. `projects/`
915
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
916
+ # siteSearchEngine/targetSites/`target_site`` The `target_site_id` is system-
917
+ # generated.
918
+ # Corresponds to the JSON property `name`
919
+ # @return [String]
920
+ attr_accessor :name
921
+
922
+ # Required. Input only. The user provided uri pattern from which the `
923
+ # generated_uri_pattern` is generated.
924
+ # Corresponds to the JSON property `providedUriPattern`
925
+ # @return [String]
926
+ attr_accessor :provided_uri_pattern
927
+
928
+ # The type of the target site, e.g. whether the site is to be included or
929
+ # excluded.
930
+ # Corresponds to the JSON property `type`
931
+ # @return [String]
932
+ attr_accessor :type
933
+
934
+ # Output only. The target site's last updated time.
935
+ # Corresponds to the JSON property `updateTime`
936
+ # @return [String]
937
+ attr_accessor :update_time
938
+
939
+ def initialize(**args)
940
+ update!(**args)
941
+ end
942
+
943
+ # Update properties of this object
944
+ def update!(**args)
945
+ @exact_match = args[:exact_match] if args.key?(:exact_match)
946
+ @generated_uri_pattern = args[:generated_uri_pattern] if args.key?(:generated_uri_pattern)
947
+ @name = args[:name] if args.key?(:name)
948
+ @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
949
+ @type = args[:type] if args.key?(:type)
950
+ @update_time = args[:update_time] if args.key?(:update_time)
951
+ end
952
+ end
953
+
547
954
  # BigQuery source import data from.
548
955
  class GoogleCloudDiscoveryengineV1betaBigQuerySource
549
956
  include Google::Apis::Core::Hashable
@@ -735,14 +1142,14 @@ module Google
735
1142
  class GoogleCloudDiscoveryengineV1betaDocumentInfo
736
1143
  include Google::Apis::Core::Hashable
737
1144
 
738
- # Required. The Document resource ID.
1145
+ # The Document resource ID.
739
1146
  # Corresponds to the JSON property `id`
740
1147
  # @return [String]
741
1148
  attr_accessor :id
742
1149
 
743
- # Required. The Document resource full name, of the form: `projects/`project_id`/
744
- # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
745
- # branches/`branch_id`/documents/`document_id``
1150
+ # The Document resource full name, of the form: `projects/`project_id`/locations/
1151
+ # `location`/collections/`collection_id`/dataStores/`data_store_id`/branches/`
1152
+ # branch_id`/documents/`document_id``
746
1153
  # Corresponds to the JSON property `name`
747
1154
  # @return [String]
748
1155
  attr_accessor :name
@@ -761,7 +1168,7 @@ module Google
761
1168
  # @return [Fixnum]
762
1169
  attr_accessor :quantity
763
1170
 
764
- # Required. The Document url - only allowed for DataStores with content_config
1171
+ # The Document url - only allowed for DataStores with content_config
765
1172
  # PUBLIC_WEBSITE.
766
1173
  # Corresponds to the JSON property `uri`
767
1174
  # @return [String]
@@ -792,8 +1199,10 @@ module Google
792
1199
  # ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`
793
1200
  # : One custom data JSON per row in arbitrary format that conforms the defined
794
1201
  # Schema of the data store. This can only be used by the GENERIC Data Store
795
- # vertical. Supported values for user even imports: * `user_event` (default):
796
- # One JSON UserEvent per line.
1202
+ # vertical. * `csv`: A CSV file with header conforming the defined Schema of the
1203
+ # data store. Each entry after the header will be imported as a Document. This
1204
+ # can only be used by the GENERIC Data Store vertical. Supported values for user
1205
+ # even imports: * `user_event` (default): One JSON UserEvent per line.
797
1206
  # Corresponds to the JSON property `dataSchema`
798
1207
  # @return [String]
799
1208
  attr_accessor :data_schema
@@ -862,6 +1271,20 @@ module Google
862
1271
  class GoogleCloudDiscoveryengineV1betaImportDocumentsRequest
863
1272
  include Google::Apis::Core::Hashable
864
1273
 
1274
+ # Whether to automatically generate IDs for the documents if absent. If set to `
1275
+ # true`, Document.ids are automatically generated based on the hash of the
1276
+ # payload, where IDs may not be consistent during multiple imports. In which
1277
+ # case ReconciliationMode.FULL is highly recommended to avoid duplicate contents.
1278
+ # If unset or set to `false`, Document.ids have to be specified using id_field,
1279
+ # otherwises, documents without IDs will fail to be imported. Only set this
1280
+ # field when using GcsSource or BigQuerySource, and when GcsSource.data_schema
1281
+ # or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an
1282
+ # INVALID_ARGUMENT error is thrown.
1283
+ # Corresponds to the JSON property `autoGenerateIds`
1284
+ # @return [Boolean]
1285
+ attr_accessor :auto_generate_ids
1286
+ alias_method :auto_generate_ids?, :auto_generate_ids
1287
+
865
1288
  # BigQuery source import data from.
866
1289
  # Corresponds to the JSON property `bigquerySource`
867
1290
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource]
@@ -877,6 +1300,23 @@ module Google
877
1300
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource]
878
1301
  attr_accessor :gcs_source
879
1302
 
1303
+ # The field in the Cloud Storage and BigQuery sources that indicates the unique
1304
+ # IDs of the documents. For GcsSource it is the key of the JSON field. For
1305
+ # instance, `my_id` for JSON ``"my_id": "some_uuid"``. For BigQuerySource it is
1306
+ # the column name of the BigQuery table where the unique ids are stored. The
1307
+ # values of the JSON field or the BigQuery column will be used as the Document.
1308
+ # ids. The JSON field or the BigQuery column must be of string type, and the
1309
+ # values must be set as valid strings conform to [RFC-1034](https://tools.ietf.
1310
+ # org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs
1311
+ # will fail to be imported. Only set this field when using GcsSource or
1312
+ # BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema
1313
+ # is `custom`. And only set this field when auto_generate_ids is unset or set as
1314
+ # `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a
1315
+ # default value `_id` is used when importing from the allowed data sources.
1316
+ # Corresponds to the JSON property `idField`
1317
+ # @return [String]
1318
+ attr_accessor :id_field
1319
+
880
1320
  # The inline source for the input config for ImportDocuments method.
881
1321
  # Corresponds to the JSON property `inlineSource`
882
1322
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource]
@@ -894,9 +1334,11 @@ module Google
894
1334
 
895
1335
  # Update properties of this object
896
1336
  def update!(**args)
1337
+ @auto_generate_ids = args[:auto_generate_ids] if args.key?(:auto_generate_ids)
897
1338
  @bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
898
1339
  @error_config = args[:error_config] if args.key?(:error_config)
899
1340
  @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
1341
+ @id_field = args[:id_field] if args.key?(:id_field)
900
1342
  @inline_source = args[:inline_source] if args.key?(:inline_source)
901
1343
  @reconciliation_mode = args[:reconciliation_mode] if args.key?(:reconciliation_mode)
902
1344
  end
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1beta
18
18
  # Version of the google-apis-discoveryengine_v1beta gem
19
- GEM_VERSION = "0.13.0"
19
+ GEM_VERSION = "0.15.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230504"
25
+ REVISION = "20230620"
26
26
  end
27
27
  end
28
28
  end
@@ -64,6 +64,60 @@ module Google
64
64
  include Google::Apis::Core::JsonObjectSupport
65
65
  end
66
66
 
67
+ class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
68
+ class Representation < Google::Apis::Core::JsonRepresentation; end
69
+
70
+ include Google::Apis::Core::JsonObjectSupport
71
+ end
72
+
73
+ class GoogleCloudDiscoveryengineV1ImportDocumentsResponse
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
79
+ class GoogleCloudDiscoveryengineV1ImportErrorConfig
80
+ class Representation < Google::Apis::Core::JsonRepresentation; end
81
+
82
+ include Google::Apis::Core::JsonObjectSupport
83
+ end
84
+
85
+ class GoogleCloudDiscoveryengineV1ImportUserEventsMetadata
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
91
+ class GoogleCloudDiscoveryengineV1ImportUserEventsResponse
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
97
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+
100
+ include Google::Apis::Core::JsonObjectSupport
101
+ end
102
+
103
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsResponse
104
+ class Representation < Google::Apis::Core::JsonRepresentation; end
105
+
106
+ include Google::Apis::Core::JsonObjectSupport
107
+ end
108
+
109
+ class GoogleCloudDiscoveryengineV1Schema
110
+ class Representation < Google::Apis::Core::JsonRepresentation; end
111
+
112
+ include Google::Apis::Core::JsonObjectSupport
113
+ end
114
+
115
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
116
+ class Representation < Google::Apis::Core::JsonRepresentation; end
117
+
118
+ include Google::Apis::Core::JsonObjectSupport
119
+ end
120
+
67
121
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
68
122
  class Representation < Google::Apis::Core::JsonRepresentation; end
69
123
 
@@ -106,12 +160,30 @@ module Google
106
160
  include Google::Apis::Core::JsonObjectSupport
107
161
  end
108
162
 
163
+ class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata
164
+ class Representation < Google::Apis::Core::JsonRepresentation; end
165
+
166
+ include Google::Apis::Core::JsonObjectSupport
167
+ end
168
+
169
+ class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse
170
+ class Representation < Google::Apis::Core::JsonRepresentation; end
171
+
172
+ include Google::Apis::Core::JsonObjectSupport
173
+ end
174
+
109
175
  class GoogleCloudDiscoveryengineV1alphaSchema
110
176
  class Representation < Google::Apis::Core::JsonRepresentation; end
111
177
 
112
178
  include Google::Apis::Core::JsonObjectSupport
113
179
  end
114
180
 
181
+ class GoogleCloudDiscoveryengineV1alphaTargetSite
182
+ class Representation < Google::Apis::Core::JsonRepresentation; end
183
+
184
+ include Google::Apis::Core::JsonObjectSupport
185
+ end
186
+
115
187
  class GoogleCloudDiscoveryengineV1betaBigQuerySource
116
188
  class Representation < Google::Apis::Core::JsonRepresentation; end
117
189
 
@@ -390,6 +462,90 @@ module Google
390
462
  end
391
463
  end
392
464
 
465
+ class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
466
+ # @private
467
+ class Representation < Google::Apis::Core::JsonRepresentation
468
+ property :create_time, as: 'createTime'
469
+ property :failure_count, :numeric_string => true, as: 'failureCount'
470
+ property :success_count, :numeric_string => true, as: 'successCount'
471
+ property :update_time, as: 'updateTime'
472
+ end
473
+ end
474
+
475
+ class GoogleCloudDiscoveryengineV1ImportDocumentsResponse
476
+ # @private
477
+ class Representation < Google::Apis::Core::JsonRepresentation
478
+ property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig::Representation
479
+
480
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
481
+
482
+ end
483
+ end
484
+
485
+ class GoogleCloudDiscoveryengineV1ImportErrorConfig
486
+ # @private
487
+ class Representation < Google::Apis::Core::JsonRepresentation
488
+ property :gcs_prefix, as: 'gcsPrefix'
489
+ end
490
+ end
491
+
492
+ class GoogleCloudDiscoveryengineV1ImportUserEventsMetadata
493
+ # @private
494
+ class Representation < Google::Apis::Core::JsonRepresentation
495
+ property :create_time, as: 'createTime'
496
+ property :failure_count, :numeric_string => true, as: 'failureCount'
497
+ property :success_count, :numeric_string => true, as: 'successCount'
498
+ property :update_time, as: 'updateTime'
499
+ end
500
+ end
501
+
502
+ class GoogleCloudDiscoveryengineV1ImportUserEventsResponse
503
+ # @private
504
+ class Representation < Google::Apis::Core::JsonRepresentation
505
+ property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig::Representation
506
+
507
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
508
+
509
+ property :joined_events_count, :numeric_string => true, as: 'joinedEventsCount'
510
+ property :unjoined_events_count, :numeric_string => true, as: 'unjoinedEventsCount'
511
+ end
512
+ end
513
+
514
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata
515
+ # @private
516
+ class Representation < Google::Apis::Core::JsonRepresentation
517
+ property :create_time, as: 'createTime'
518
+ property :failure_count, :numeric_string => true, as: 'failureCount'
519
+ property :success_count, :numeric_string => true, as: 'successCount'
520
+ property :update_time, as: 'updateTime'
521
+ end
522
+ end
523
+
524
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsResponse
525
+ # @private
526
+ class Representation < Google::Apis::Core::JsonRepresentation
527
+ property :purge_count, :numeric_string => true, as: 'purgeCount'
528
+ collection :purge_sample, as: 'purgeSample'
529
+ end
530
+ end
531
+
532
+ class GoogleCloudDiscoveryengineV1Schema
533
+ # @private
534
+ class Representation < Google::Apis::Core::JsonRepresentation
535
+ property :json_schema, as: 'jsonSchema'
536
+ property :name, as: 'name'
537
+ hash :struct_schema, as: 'structSchema'
538
+ end
539
+ end
540
+
541
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
542
+ # @private
543
+ class Representation < Google::Apis::Core::JsonRepresentation
544
+ collection :target_sites, as: 'targetSites', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
545
+
546
+ end
547
+ end
548
+
393
549
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
394
550
  # @private
395
551
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -457,6 +613,23 @@ module Google
457
613
  end
458
614
  end
459
615
 
616
+ class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata
617
+ # @private
618
+ class Representation < Google::Apis::Core::JsonRepresentation
619
+ property :create_time, as: 'createTime'
620
+ property :failure_count, :numeric_string => true, as: 'failureCount'
621
+ property :success_count, :numeric_string => true, as: 'successCount'
622
+ property :update_time, as: 'updateTime'
623
+ end
624
+ end
625
+
626
+ class GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse
627
+ # @private
628
+ class Representation < Google::Apis::Core::JsonRepresentation
629
+ property :purge_count, :numeric_string => true, as: 'purgeCount'
630
+ end
631
+ end
632
+
460
633
  class GoogleCloudDiscoveryengineV1alphaSchema
461
634
  # @private
462
635
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -466,6 +639,18 @@ module Google
466
639
  end
467
640
  end
468
641
 
642
+ class GoogleCloudDiscoveryengineV1alphaTargetSite
643
+ # @private
644
+ class Representation < Google::Apis::Core::JsonRepresentation
645
+ property :exact_match, as: 'exactMatch'
646
+ property :generated_uri_pattern, as: 'generatedUriPattern'
647
+ property :name, as: 'name'
648
+ property :provided_uri_pattern, as: 'providedUriPattern'
649
+ property :type, as: 'type'
650
+ property :update_time, as: 'updateTime'
651
+ end
652
+ end
653
+
469
654
  class GoogleCloudDiscoveryengineV1betaBigQuerySource
470
655
  # @private
471
656
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -539,12 +724,14 @@ module Google
539
724
  class GoogleCloudDiscoveryengineV1betaImportDocumentsRequest
540
725
  # @private
541
726
  class Representation < Google::Apis::Core::JsonRepresentation
727
+ property :auto_generate_ids, as: 'autoGenerateIds'
542
728
  property :bigquery_source, as: 'bigquerySource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource::Representation
543
729
 
544
730
  property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportErrorConfig::Representation
545
731
 
546
732
  property :gcs_source, as: 'gcsSource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource::Representation
547
733
 
734
+ property :id_field, as: 'idField'
548
735
  property :inline_source, as: 'inlineSource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource::Representation
549
736
 
550
737
  property :reconciliation_mode, as: 'reconciliationMode'
@@ -538,6 +538,77 @@ module Google
538
538
  execute_or_queue_command(command, &block)
539
539
  end
540
540
 
541
+ # Gets the latest state of a long-running operation. Clients can use this method
542
+ # to poll the operation result at intervals as recommended by the API service.
543
+ # @param [String] name
544
+ # The name of the operation resource.
545
+ # @param [String] fields
546
+ # Selector specifying which fields to include in a partial response.
547
+ # @param [String] quota_user
548
+ # Available to use for quota purposes for server-side applications. Can be any
549
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
550
+ # @param [Google::Apis::RequestOptions] options
551
+ # Request-specific options
552
+ #
553
+ # @yield [result, err] Result & error if block supplied
554
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
555
+ # @yieldparam err [StandardError] error object if request failed
556
+ #
557
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
558
+ #
559
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
560
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
561
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
562
+ def get_project_location_collection_data_store_schema_operation(name, fields: nil, quota_user: nil, options: nil, &block)
563
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
564
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
565
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
566
+ command.params['name'] = name unless name.nil?
567
+ command.query['fields'] = fields unless fields.nil?
568
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
569
+ execute_or_queue_command(command, &block)
570
+ end
571
+
572
+ # Lists operations that match the specified filter in the request. If the server
573
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
574
+ # @param [String] name
575
+ # The name of the operation's parent resource.
576
+ # @param [String] filter
577
+ # The standard list filter.
578
+ # @param [Fixnum] page_size
579
+ # The standard list page size.
580
+ # @param [String] page_token
581
+ # The standard list page token.
582
+ # @param [String] fields
583
+ # Selector specifying which fields to include in a partial response.
584
+ # @param [String] quota_user
585
+ # Available to use for quota purposes for server-side applications. Can be any
586
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
587
+ # @param [Google::Apis::RequestOptions] options
588
+ # Request-specific options
589
+ #
590
+ # @yield [result, err] Result & error if block supplied
591
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
592
+ # @yieldparam err [StandardError] error object if request failed
593
+ #
594
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
595
+ #
596
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
597
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
598
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
599
+ def list_project_location_collection_data_store_schema_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
600
+ command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
601
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
602
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
603
+ command.params['name'] = name unless name.nil?
604
+ command.query['filter'] = filter unless filter.nil?
605
+ command.query['pageSize'] = page_size unless page_size.nil?
606
+ command.query['pageToken'] = page_token unless page_token.nil?
607
+ command.query['fields'] = fields unless fields.nil?
608
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
609
+ execute_or_queue_command(command, &block)
610
+ end
611
+
541
612
  # Makes a recommendation, which requires a contextual user event.
542
613
  # @param [String] serving_config
543
614
  # Required. Full resource name of the format: `projects/*/locations/global/
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.13.0
4
+ version: 0.15.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-05-14 00:00:00.000000000 Z
11
+ date: 2023-06-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.13.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.15.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []