google-apis-discoveryengine_v1beta 0.13.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +380 -0
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +158 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +71 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a7f3c93038726236e4377a66c4f897f04b7ae8ed18aa20d8d60c57f2aeb684b8
|
|
4
|
+
data.tar.gz: a04f088ed0b96f3b246010798757e79217c6a0f3730f590eaa17586e0f56664f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9db79f4efe387a0b96295b565e514c2e6ba410b5b4f4a152dfc0f81b9a81f5731381ca3f594fced9c97864bc0c60b8431edf369a8112664c5ddae95e6981d109
|
|
7
|
+
data.tar.gz: 2a816742ca01cda3e4159a5c0c9a971152ae23771d92216fdc40d14c4eed3a7136c07b8fa4253f060e192cd61d2c0bce90566de9362dee1466999b6ae3b9f872
|
data/CHANGELOG.md
CHANGED
|
@@ -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
|
|
@@ -544,6 +831,66 @@ module Google
|
|
|
544
831
|
end
|
|
545
832
|
end
|
|
546
833
|
|
|
834
|
+
# A target site for the SiteSearchEngine.
|
|
835
|
+
class GoogleCloudDiscoveryengineV1alphaTargetSite
|
|
836
|
+
include Google::Apis::Core::Hashable
|
|
837
|
+
|
|
838
|
+
# Input only. If set to false, an uri_pattern will be generated to include all
|
|
839
|
+
# pages whose address contains the provided_uri_pattern. If set to true, an
|
|
840
|
+
# uri_pattern will be generated to try to be an exact match of the
|
|
841
|
+
# provided_uri_pattern or just the specific page if the provided_uri_pattern is
|
|
842
|
+
# a specific one. provided_uri_pattern will always be normalized to generate the
|
|
843
|
+
# uri pattern to be used by the search engine.
|
|
844
|
+
# Corresponds to the JSON property `exactMatch`
|
|
845
|
+
# @return [Boolean]
|
|
846
|
+
attr_accessor :exact_match
|
|
847
|
+
alias_method :exact_match?, :exact_match
|
|
848
|
+
|
|
849
|
+
# Output only. This is system-generated based on the provided_uri_pattern.
|
|
850
|
+
# Corresponds to the JSON property `generatedUriPattern`
|
|
851
|
+
# @return [String]
|
|
852
|
+
attr_accessor :generated_uri_pattern
|
|
853
|
+
|
|
854
|
+
# Output only. The fully qualified resource name of the target site. `projects/`
|
|
855
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
|
|
856
|
+
# siteSearchEngine/targetSites/`target_site`` The `target_site_id` is system-
|
|
857
|
+
# generated.
|
|
858
|
+
# Corresponds to the JSON property `name`
|
|
859
|
+
# @return [String]
|
|
860
|
+
attr_accessor :name
|
|
861
|
+
|
|
862
|
+
# Required. Input only. The user provided uri pattern from which the `
|
|
863
|
+
# generated_uri_pattern` is generated.
|
|
864
|
+
# Corresponds to the JSON property `providedUriPattern`
|
|
865
|
+
# @return [String]
|
|
866
|
+
attr_accessor :provided_uri_pattern
|
|
867
|
+
|
|
868
|
+
# The type of the target site, e.g. whether the site is to be included or
|
|
869
|
+
# excluded.
|
|
870
|
+
# Corresponds to the JSON property `type`
|
|
871
|
+
# @return [String]
|
|
872
|
+
attr_accessor :type
|
|
873
|
+
|
|
874
|
+
# Output only. The target site's last updated time.
|
|
875
|
+
# Corresponds to the JSON property `updateTime`
|
|
876
|
+
# @return [String]
|
|
877
|
+
attr_accessor :update_time
|
|
878
|
+
|
|
879
|
+
def initialize(**args)
|
|
880
|
+
update!(**args)
|
|
881
|
+
end
|
|
882
|
+
|
|
883
|
+
# Update properties of this object
|
|
884
|
+
def update!(**args)
|
|
885
|
+
@exact_match = args[:exact_match] if args.key?(:exact_match)
|
|
886
|
+
@generated_uri_pattern = args[:generated_uri_pattern] if args.key?(:generated_uri_pattern)
|
|
887
|
+
@name = args[:name] if args.key?(:name)
|
|
888
|
+
@provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
|
|
889
|
+
@type = args[:type] if args.key?(:type)
|
|
890
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
|
891
|
+
end
|
|
892
|
+
end
|
|
893
|
+
|
|
547
894
|
# BigQuery source import data from.
|
|
548
895
|
class GoogleCloudDiscoveryengineV1betaBigQuerySource
|
|
549
896
|
include Google::Apis::Core::Hashable
|
|
@@ -862,6 +1209,20 @@ module Google
|
|
|
862
1209
|
class GoogleCloudDiscoveryengineV1betaImportDocumentsRequest
|
|
863
1210
|
include Google::Apis::Core::Hashable
|
|
864
1211
|
|
|
1212
|
+
# Whether to automatically generate IDs for the documents if absent. If set to `
|
|
1213
|
+
# true`, Document.ids are automatically generated based on the hash of the
|
|
1214
|
+
# payload, where IDs may not be consistent during multiple imports. In which
|
|
1215
|
+
# case ReconciliationMode.FULL is highly recommended to avoid duplicate contents.
|
|
1216
|
+
# If unset or set to `false`, Document.ids have to be specified using id_field,
|
|
1217
|
+
# otherwises, documents without IDs will fail to be imported. Only set this
|
|
1218
|
+
# field when using GcsSource or BigQuerySource, and when GcsSource.data_schema
|
|
1219
|
+
# or BigQuerySource.data_schema is `custom`. Otherwise, an INVALID_ARGUMENT
|
|
1220
|
+
# error is thrown.
|
|
1221
|
+
# Corresponds to the JSON property `autoGenerateIds`
|
|
1222
|
+
# @return [Boolean]
|
|
1223
|
+
attr_accessor :auto_generate_ids
|
|
1224
|
+
alias_method :auto_generate_ids?, :auto_generate_ids
|
|
1225
|
+
|
|
865
1226
|
# BigQuery source import data from.
|
|
866
1227
|
# Corresponds to the JSON property `bigquerySource`
|
|
867
1228
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource]
|
|
@@ -877,6 +1238,23 @@ module Google
|
|
|
877
1238
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource]
|
|
878
1239
|
attr_accessor :gcs_source
|
|
879
1240
|
|
|
1241
|
+
# The field in the Cloud Storage and BigQuery sources that indicates the unique
|
|
1242
|
+
# IDs of the documents. For GcsSource it is the key of the JSON field. For
|
|
1243
|
+
# instance, `my_id` for JSON ``"my_id": "some_uuid"``. For BigQuerySource it is
|
|
1244
|
+
# the column name of the BigQuery table where the unique ids are stored. The
|
|
1245
|
+
# values of the JSON field or the BigQuery column will be used as the Document.
|
|
1246
|
+
# ids. The JSON field or the BigQuery column must be of string type, and the
|
|
1247
|
+
# values must be set as valid strings conform to [RFC-1034](https://tools.ietf.
|
|
1248
|
+
# org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs
|
|
1249
|
+
# will fail to be imported. Only set this field when using GcsSource or
|
|
1250
|
+
# BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema
|
|
1251
|
+
# is `custom`. And only set this field when auto_generate_ids is unset or set as
|
|
1252
|
+
# `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a
|
|
1253
|
+
# default value `_id` is used when importing from the allowed data sources.
|
|
1254
|
+
# Corresponds to the JSON property `idField`
|
|
1255
|
+
# @return [String]
|
|
1256
|
+
attr_accessor :id_field
|
|
1257
|
+
|
|
880
1258
|
# The inline source for the input config for ImportDocuments method.
|
|
881
1259
|
# Corresponds to the JSON property `inlineSource`
|
|
882
1260
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource]
|
|
@@ -894,9 +1272,11 @@ module Google
|
|
|
894
1272
|
|
|
895
1273
|
# Update properties of this object
|
|
896
1274
|
def update!(**args)
|
|
1275
|
+
@auto_generate_ids = args[:auto_generate_ids] if args.key?(:auto_generate_ids)
|
|
897
1276
|
@bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
|
|
898
1277
|
@error_config = args[:error_config] if args.key?(:error_config)
|
|
899
1278
|
@gcs_source = args[:gcs_source] if args.key?(:gcs_source)
|
|
1279
|
+
@id_field = args[:id_field] if args.key?(:id_field)
|
|
900
1280
|
@inline_source = args[:inline_source] if args.key?(:inline_source)
|
|
901
1281
|
@reconciliation_mode = args[:reconciliation_mode] if args.key?(:reconciliation_mode)
|
|
902
1282
|
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.
|
|
19
|
+
GEM_VERSION = "0.14.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 = "
|
|
25
|
+
REVISION = "20230525"
|
|
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
|
|
|
@@ -112,6 +166,12 @@ module Google
|
|
|
112
166
|
include Google::Apis::Core::JsonObjectSupport
|
|
113
167
|
end
|
|
114
168
|
|
|
169
|
+
class GoogleCloudDiscoveryengineV1alphaTargetSite
|
|
170
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
171
|
+
|
|
172
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
173
|
+
end
|
|
174
|
+
|
|
115
175
|
class GoogleCloudDiscoveryengineV1betaBigQuerySource
|
|
116
176
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
117
177
|
|
|
@@ -390,6 +450,90 @@ module Google
|
|
|
390
450
|
end
|
|
391
451
|
end
|
|
392
452
|
|
|
453
|
+
class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
|
|
454
|
+
# @private
|
|
455
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
456
|
+
property :create_time, as: 'createTime'
|
|
457
|
+
property :failure_count, :numeric_string => true, as: 'failureCount'
|
|
458
|
+
property :success_count, :numeric_string => true, as: 'successCount'
|
|
459
|
+
property :update_time, as: 'updateTime'
|
|
460
|
+
end
|
|
461
|
+
end
|
|
462
|
+
|
|
463
|
+
class GoogleCloudDiscoveryengineV1ImportDocumentsResponse
|
|
464
|
+
# @private
|
|
465
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
466
|
+
property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig::Representation
|
|
467
|
+
|
|
468
|
+
collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
|
|
469
|
+
|
|
470
|
+
end
|
|
471
|
+
end
|
|
472
|
+
|
|
473
|
+
class GoogleCloudDiscoveryengineV1ImportErrorConfig
|
|
474
|
+
# @private
|
|
475
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
476
|
+
property :gcs_prefix, as: 'gcsPrefix'
|
|
477
|
+
end
|
|
478
|
+
end
|
|
479
|
+
|
|
480
|
+
class GoogleCloudDiscoveryengineV1ImportUserEventsMetadata
|
|
481
|
+
# @private
|
|
482
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
483
|
+
property :create_time, as: 'createTime'
|
|
484
|
+
property :failure_count, :numeric_string => true, as: 'failureCount'
|
|
485
|
+
property :success_count, :numeric_string => true, as: 'successCount'
|
|
486
|
+
property :update_time, as: 'updateTime'
|
|
487
|
+
end
|
|
488
|
+
end
|
|
489
|
+
|
|
490
|
+
class GoogleCloudDiscoveryengineV1ImportUserEventsResponse
|
|
491
|
+
# @private
|
|
492
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
493
|
+
property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ImportErrorConfig::Representation
|
|
494
|
+
|
|
495
|
+
collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
|
|
496
|
+
|
|
497
|
+
property :joined_events_count, :numeric_string => true, as: 'joinedEventsCount'
|
|
498
|
+
property :unjoined_events_count, :numeric_string => true, as: 'unjoinedEventsCount'
|
|
499
|
+
end
|
|
500
|
+
end
|
|
501
|
+
|
|
502
|
+
class GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata
|
|
503
|
+
# @private
|
|
504
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
505
|
+
property :create_time, as: 'createTime'
|
|
506
|
+
property :failure_count, :numeric_string => true, as: 'failureCount'
|
|
507
|
+
property :success_count, :numeric_string => true, as: 'successCount'
|
|
508
|
+
property :update_time, as: 'updateTime'
|
|
509
|
+
end
|
|
510
|
+
end
|
|
511
|
+
|
|
512
|
+
class GoogleCloudDiscoveryengineV1PurgeDocumentsResponse
|
|
513
|
+
# @private
|
|
514
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
515
|
+
property :purge_count, :numeric_string => true, as: 'purgeCount'
|
|
516
|
+
collection :purge_sample, as: 'purgeSample'
|
|
517
|
+
end
|
|
518
|
+
end
|
|
519
|
+
|
|
520
|
+
class GoogleCloudDiscoveryengineV1Schema
|
|
521
|
+
# @private
|
|
522
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
523
|
+
property :json_schema, as: 'jsonSchema'
|
|
524
|
+
property :name, as: 'name'
|
|
525
|
+
hash :struct_schema, as: 'structSchema'
|
|
526
|
+
end
|
|
527
|
+
end
|
|
528
|
+
|
|
529
|
+
class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
|
|
530
|
+
# @private
|
|
531
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
532
|
+
collection :target_sites, as: 'targetSites', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
|
|
533
|
+
|
|
534
|
+
end
|
|
535
|
+
end
|
|
536
|
+
|
|
393
537
|
class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
|
|
394
538
|
# @private
|
|
395
539
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -466,6 +610,18 @@ module Google
|
|
|
466
610
|
end
|
|
467
611
|
end
|
|
468
612
|
|
|
613
|
+
class GoogleCloudDiscoveryengineV1alphaTargetSite
|
|
614
|
+
# @private
|
|
615
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
616
|
+
property :exact_match, as: 'exactMatch'
|
|
617
|
+
property :generated_uri_pattern, as: 'generatedUriPattern'
|
|
618
|
+
property :name, as: 'name'
|
|
619
|
+
property :provided_uri_pattern, as: 'providedUriPattern'
|
|
620
|
+
property :type, as: 'type'
|
|
621
|
+
property :update_time, as: 'updateTime'
|
|
622
|
+
end
|
|
623
|
+
end
|
|
624
|
+
|
|
469
625
|
class GoogleCloudDiscoveryengineV1betaBigQuerySource
|
|
470
626
|
# @private
|
|
471
627
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -539,12 +695,14 @@ module Google
|
|
|
539
695
|
class GoogleCloudDiscoveryengineV1betaImportDocumentsRequest
|
|
540
696
|
# @private
|
|
541
697
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
698
|
+
property :auto_generate_ids, as: 'autoGenerateIds'
|
|
542
699
|
property :bigquery_source, as: 'bigquerySource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource::Representation
|
|
543
700
|
|
|
544
701
|
property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportErrorConfig::Representation
|
|
545
702
|
|
|
546
703
|
property :gcs_source, as: 'gcsSource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource::Representation
|
|
547
704
|
|
|
705
|
+
property :id_field, as: 'idField'
|
|
548
706
|
property :inline_source, as: 'inlineSource', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource::Representation
|
|
549
707
|
|
|
550
708
|
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.
|
|
4
|
+
version: 0.14.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-
|
|
11
|
+
date: 2023-05-28 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.
|
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.14.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: []
|