google-apis-discoveryengine_v1beta 0.43.0 → 0.45.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.
@@ -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.43.0"
19
+ GEM_VERSION = "0.45.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.14.0"
22
+ GENERATOR_VERSION = "0.15.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240415"
25
+ REVISION = "20240517"
26
26
  end
27
27
  end
28
28
  end
@@ -466,6 +466,12 @@ module Google
466
466
  include Google::Apis::Core::JsonObjectSupport
467
467
  end
468
468
 
469
+ class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
470
+ class Representation < Google::Apis::Core::JsonRepresentation; end
471
+
472
+ include Google::Apis::Core::JsonObjectSupport
473
+ end
474
+
469
475
  class GoogleCloudDiscoveryengineV1alphaDataStore
470
476
  class Representation < Google::Apis::Core::JsonRepresentation; end
471
477
 
@@ -694,6 +700,12 @@ module Google
694
700
  include Google::Apis::Core::JsonObjectSupport
695
701
  end
696
702
 
703
+ class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
704
+ class Representation < Google::Apis::Core::JsonRepresentation; end
705
+
706
+ include Google::Apis::Core::JsonObjectSupport
707
+ end
708
+
697
709
  class GoogleCloudDiscoveryengineV1alphaProject
698
710
  class Representation < Google::Apis::Core::JsonRepresentation; end
699
711
 
@@ -1240,6 +1252,12 @@ module Google
1240
1252
  include Google::Apis::Core::JsonObjectSupport
1241
1253
  end
1242
1254
 
1255
+ class GoogleCloudDiscoveryengineV1betaCustomTuningModel
1256
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1257
+
1258
+ include Google::Apis::Core::JsonObjectSupport
1259
+ end
1260
+
1243
1261
  class GoogleCloudDiscoveryengineV1betaDataStore
1244
1262
  class Representation < Google::Apis::Core::JsonRepresentation; end
1245
1263
 
@@ -1522,6 +1540,12 @@ module Google
1522
1540
  include Google::Apis::Core::JsonObjectSupport
1523
1541
  end
1524
1542
 
1543
+ class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
1544
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1545
+
1546
+ include Google::Apis::Core::JsonObjectSupport
1547
+ end
1548
+
1525
1549
  class GoogleCloudDiscoveryengineV1betaListDataStoresResponse
1526
1550
  class Representation < Google::Apis::Core::JsonRepresentation; end
1527
1551
 
@@ -2062,6 +2086,12 @@ module Google
2062
2086
  include Google::Apis::Core::JsonObjectSupport
2063
2087
  end
2064
2088
 
2089
+ class GoogleLongrunningCancelOperationRequest
2090
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2091
+
2092
+ include Google::Apis::Core::JsonObjectSupport
2093
+ end
2094
+
2065
2095
  class GoogleLongrunningListOperationsResponse
2066
2096
  class Representation < Google::Apis::Core::JsonRepresentation; end
2067
2097
 
@@ -2513,6 +2543,7 @@ module Google
2513
2543
  property :indexing_status, as: 'indexingStatus'
2514
2544
  property :name, as: 'name'
2515
2545
  property :provided_uri_pattern, as: 'providedUriPattern'
2546
+ property :root_domain_uri, as: 'rootDomainUri'
2516
2547
  property :site_verification_info, as: 'siteVerificationInfo', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1SiteVerificationInfo, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1SiteVerificationInfo::Representation
2517
2548
 
2518
2549
  property :type, as: 'type'
@@ -2778,6 +2809,18 @@ module Google
2778
2809
  end
2779
2810
  end
2780
2811
 
2812
+ class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
2813
+ # @private
2814
+ class Representation < Google::Apis::Core::JsonRepresentation
2815
+ property :create_time, as: 'createTime'
2816
+ property :display_name, as: 'displayName'
2817
+ property :model_state, as: 'modelState'
2818
+ property :model_version, :numeric_string => true, as: 'modelVersion'
2819
+ property :name, as: 'name'
2820
+ property :training_start_time, as: 'trainingStartTime'
2821
+ end
2822
+ end
2823
+
2781
2824
  class GoogleCloudDiscoveryengineV1alphaDataStore
2782
2825
  # @private
2783
2826
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3137,6 +3180,14 @@ module Google
3137
3180
  end
3138
3181
  end
3139
3182
 
3183
+ class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
3184
+ # @private
3185
+ class Representation < Google::Apis::Core::JsonRepresentation
3186
+ collection :models, as: 'models', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCustomTuningModel, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCustomTuningModel::Representation
3187
+
3188
+ end
3189
+ end
3190
+
3140
3191
  class GoogleCloudDiscoveryengineV1alphaProject
3141
3192
  # @private
3142
3193
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3316,6 +3367,7 @@ module Google
3316
3367
  property :indexing_status, as: 'indexingStatus'
3317
3368
  property :name, as: 'name'
3318
3369
  property :provided_uri_pattern, as: 'providedUriPattern'
3370
+ property :root_domain_uri, as: 'rootDomainUri'
3319
3371
  property :site_verification_info, as: 'siteVerificationInfo', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo::Representation
3320
3372
 
3321
3373
  property :type, as: 'type'
@@ -3354,6 +3406,7 @@ module Google
3354
3406
  collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
3355
3407
 
3356
3408
  hash :metrics, as: 'metrics'
3409
+ property :model_name, as: 'modelName'
3357
3410
  property :model_status, as: 'modelStatus'
3358
3411
  end
3359
3412
  end
@@ -3834,6 +3887,7 @@ module Google
3834
3887
 
3835
3888
  property :grounding_spec, as: 'groundingSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingSpec::Representation
3836
3889
 
3890
+ hash :user_labels, as: 'userLabels'
3837
3891
  end
3838
3892
  end
3839
3893
 
@@ -3854,6 +3908,7 @@ module Google
3854
3908
  collection :citation_indices, as: 'citationIndices'
3855
3909
  property :claim_text, as: 'claimText'
3856
3910
  property :end_pos, as: 'endPos'
3911
+ property :grounding_check_required, as: 'groundingCheckRequired'
3857
3912
  property :start_pos, as: 'startPos'
3858
3913
  end
3859
3914
  end
@@ -4014,6 +4069,18 @@ module Google
4014
4069
  end
4015
4070
  end
4016
4071
 
4072
+ class GoogleCloudDiscoveryengineV1betaCustomTuningModel
4073
+ # @private
4074
+ class Representation < Google::Apis::Core::JsonRepresentation
4075
+ property :create_time, as: 'createTime'
4076
+ property :display_name, as: 'displayName'
4077
+ property :model_state, as: 'modelState'
4078
+ property :model_version, :numeric_string => true, as: 'modelVersion'
4079
+ property :name, as: 'name'
4080
+ property :training_start_time, as: 'trainingStartTime'
4081
+ end
4082
+ end
4083
+
4017
4084
  class GoogleCloudDiscoveryengineV1betaDataStore
4018
4085
  # @private
4019
4086
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4254,6 +4321,7 @@ module Google
4254
4321
  # @private
4255
4322
  class Representation < Google::Apis::Core::JsonRepresentation
4256
4323
  property :chunk_text, as: 'chunkText'
4324
+ property :index, as: 'index'
4257
4325
  property :source, as: 'source'
4258
4326
  hash :source_metadata, as: 'sourceMetadata'
4259
4327
  end
@@ -4466,6 +4534,14 @@ module Google
4466
4534
  end
4467
4535
  end
4468
4536
 
4537
+ class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
4538
+ # @private
4539
+ class Representation < Google::Apis::Core::JsonRepresentation
4540
+ collection :models, as: 'models', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCustomTuningModel, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCustomTuningModel::Representation
4541
+
4542
+ end
4543
+ end
4544
+
4469
4545
  class GoogleCloudDiscoveryengineV1betaListDataStoresResponse
4470
4546
  # @private
4471
4547
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5219,6 +5295,7 @@ module Google
5219
5295
  property :indexing_status, as: 'indexingStatus'
5220
5296
  property :name, as: 'name'
5221
5297
  property :provided_uri_pattern, as: 'providedUriPattern'
5298
+ property :root_domain_uri, as: 'rootDomainUri'
5222
5299
  property :site_verification_info, as: 'siteVerificationInfo', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo::Representation
5223
5300
 
5224
5301
  property :type, as: 'type'
@@ -5265,6 +5342,7 @@ module Google
5265
5342
 
5266
5343
  property :gcs_training_input, as: 'gcsTrainingInput', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput::Representation
5267
5344
 
5345
+ property :model_id, as: 'modelId'
5268
5346
  property :model_type, as: 'modelType'
5269
5347
  end
5270
5348
  end
@@ -5287,6 +5365,7 @@ module Google
5287
5365
  collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
5288
5366
 
5289
5367
  hash :metrics, as: 'metrics'
5368
+ property :model_name, as: 'modelName'
5290
5369
  property :model_status, as: 'modelStatus'
5291
5370
  end
5292
5371
  end
@@ -5379,6 +5458,12 @@ module Google
5379
5458
  end
5380
5459
  end
5381
5460
 
5461
+ class GoogleLongrunningCancelOperationRequest
5462
+ # @private
5463
+ class Representation < Google::Apis::Core::JsonRepresentation
5464
+ end
5465
+ end
5466
+
5382
5467
  class GoogleLongrunningListOperationsResponse
5383
5468
  # @private
5384
5469
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -342,7 +342,7 @@ module Google
342
342
  # permission to list DataStores under this location, regardless of whether or
343
343
  # not this data store exists, a PERMISSION_DENIED error is returned.
344
344
  # @param [String] filter
345
- # Filter by solution type. For example: filter = 'solution_type:
345
+ # Filter by solution type . For example: filter = 'solution_type:
346
346
  # SOLUTION_TYPE_SEARCH'
347
347
  # @param [Fixnum] page_size
348
348
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
@@ -465,14 +465,14 @@ module Google
465
465
  # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
466
466
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
467
467
  # @param [String] document_id
468
- # Required. The ID to use for the Document, which will become the final
469
- # component of the Document.name. If the caller does not have permission to
470
- # create the Document, regardless of whether or not it exists, a `
471
- # PERMISSION_DENIED` error is returned. This field must be unique among all
472
- # Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
473
- # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
474
- # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
475
- # INVALID_ARGUMENT` error is returned.
468
+ # Required. The ID to use for the Document, which becomes the final component of
469
+ # the Document.name. If the caller does not have permission to create the
470
+ # Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
471
+ # is returned. This field must be unique among all Documents with the same
472
+ # parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
473
+ # conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
474
+ # length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
475
+ # returned.
476
476
  # @param [String] fields
477
477
  # Selector specifying which fields to include in a partial response.
478
478
  # @param [String] quota_user
@@ -574,8 +574,8 @@ module Google
574
574
  end
575
575
 
576
576
  # Bulk import of multiple Documents. Request processing may be synchronous. Non-
577
- # existing items will be created. Note: It is possible for a subset of the
578
- # Documents to be successfully updated.
577
+ # existing items are created. Note: It is possible for a subset of the Documents
578
+ # to be successfully updated.
579
579
  # @param [String] parent
580
580
  # Required. The parent branch resource name, such as `projects/`project`/
581
581
  # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
@@ -620,8 +620,8 @@ module Google
620
620
  # PERMISSION_DENIED` error is returned.
621
621
  # @param [Fixnum] page_size
622
622
  # Maximum number of Documents to return. If unspecified, defaults to 100. The
623
- # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
624
- # this field is negative, an `INVALID_ARGUMENT` error is returned.
623
+ # maximum allowed value is 1000. Values above 1000 are set to 1000. If this
624
+ # field is negative, an `INVALID_ARGUMENT` error is returned.
625
625
  # @param [String] page_token
626
626
  # A page token ListDocumentsResponse.next_page_token, received from a previous
627
627
  # DocumentService.ListDocuments call. Provide this to retrieve the subsequent
@@ -665,10 +665,10 @@ module Google
665
665
  # with a length limit of 1024 characters.
666
666
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
667
667
  # @param [Boolean] allow_missing
668
- # If set to true, and the Document is not found, a new Document will be created.
668
+ # If set to `true` and the Document is not found, a new Document is be created.
669
669
  # @param [String] update_mask
670
670
  # Indicates which fields in the provided imported 'document' to update. If not
671
- # set, will by default update all fields.
671
+ # set, by default updates all fields.
672
672
  # @param [String] fields
673
673
  # Selector specifying which fields to include in a partial response.
674
674
  # @param [String] quota_user
@@ -739,6 +739,46 @@ module Google
739
739
  execute_or_queue_command(command, &block)
740
740
  end
741
741
 
742
+ # Starts asynchronous cancellation on a long-running operation. The server makes
743
+ # a best effort to cancel the operation, but success is not guaranteed. If the
744
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
745
+ # Clients can use Operations.GetOperation or other methods to check whether the
746
+ # cancellation succeeded or whether the operation completed despite cancellation.
747
+ # On successful cancellation, the operation is not deleted; instead, it becomes
748
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
749
+ # corresponding to `Code.CANCELLED`.
750
+ # @param [String] name
751
+ # The name of the operation resource to be cancelled.
752
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
753
+ # @param [String] fields
754
+ # Selector specifying which fields to include in a partial response.
755
+ # @param [String] quota_user
756
+ # Available to use for quota purposes for server-side applications. Can be any
757
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
758
+ # @param [Google::Apis::RequestOptions] options
759
+ # Request-specific options
760
+ #
761
+ # @yield [result, err] Result & error if block supplied
762
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
763
+ # @yieldparam err [StandardError] error object if request failed
764
+ #
765
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
766
+ #
767
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
768
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
769
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
770
+ def cancel_project_location_collection_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
771
+ command = make_simple_command(:post, 'v1beta/{+name}:cancel', options)
772
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest::Representation
773
+ command.request_object = google_longrunning_cancel_operation_request_object
774
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
775
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
776
+ command.params['name'] = name unless name.nil?
777
+ command.query['fields'] = fields unless fields.nil?
778
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
779
+ execute_or_queue_command(command, &block)
780
+ end
781
+
742
782
  # Gets the latest state of a long-running operation. Clients can use this method
743
783
  # to poll the operation result at intervals as recommended by the API service.
744
784
  # @param [String] name
@@ -1038,6 +1078,38 @@ module Google
1038
1078
  execute_or_queue_command(command, &block)
1039
1079
  end
1040
1080
 
1081
+ # Gets a list of all the custom models.
1082
+ # @param [String] data_store
1083
+ # Required. The resource name of the parent Data Store, such as `projects/*/
1084
+ # locations/global/collections/default_collection/dataStores/default_data_store`.
1085
+ # This field is used to identify the data store where to fetch the models from.
1086
+ # @param [String] fields
1087
+ # Selector specifying which fields to include in a partial response.
1088
+ # @param [String] quota_user
1089
+ # Available to use for quota purposes for server-side applications. Can be any
1090
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1091
+ # @param [Google::Apis::RequestOptions] options
1092
+ # Request-specific options
1093
+ #
1094
+ # @yield [result, err] Result & error if block supplied
1095
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListCustomModelsResponse] parsed result object
1096
+ # @yieldparam err [StandardError] error object if request failed
1097
+ #
1098
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListCustomModelsResponse]
1099
+ #
1100
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1101
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1102
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1103
+ def list_project_location_collection_data_store_custom_models(data_store, fields: nil, quota_user: nil, options: nil, &block)
1104
+ command = make_simple_command(:get, 'v1beta/{+dataStore}/customModels', options)
1105
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListCustomModelsResponse::Representation
1106
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
1107
+ command.params['dataStore'] = data_store unless data_store.nil?
1108
+ command.query['fields'] = fields unless fields.nil?
1109
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1110
+ execute_or_queue_command(command, &block)
1111
+ end
1112
+
1041
1113
  # Gets the latest state of a long-running operation. Clients can use this method
1042
1114
  # to poll the operation result at intervals as recommended by the API service.
1043
1115
  # @param [String] name
@@ -1187,8 +1259,8 @@ module Google
1187
1259
  # .
1188
1260
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
1189
1261
  # @param [String] schema_id
1190
- # Required. The ID to use for the Schema, which will become the final component
1191
- # of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
1262
+ # Required. The ID to use for the Schema, which becomes the final component of
1263
+ # the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
1192
1264
  # org/html/rfc1034) standard with a length limit of 63 characters.
1193
1265
  # @param [String] fields
1194
1266
  # Selector specifying which fields to include in a partial response.
@@ -1291,8 +1363,8 @@ module Google
1291
1363
  # .
1292
1364
  # @param [Fixnum] page_size
1293
1365
  # The maximum number of Schemas to return. The service may return fewer than
1294
- # this value. If unspecified, at most 100 Schemas will be returned. The maximum
1295
- # value is 1000; values above 1000 will be coerced to 1000.
1366
+ # this value. If unspecified, at most 100 Schemas are returned. The maximum
1367
+ # value is 1000; values above 1000 are set to 1000.
1296
1368
  # @param [String] page_token
1297
1369
  # A page token, received from a previous SchemaService.ListSchemas call. Provide
1298
1370
  # this to retrieve the subsequent page. When paginating, all other parameters
@@ -1335,8 +1407,8 @@ module Google
1335
1407
  # limit of 1024 characters.
1336
1408
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
1337
1409
  # @param [Boolean] allow_missing
1338
- # If set to true, and the Schema is not found, a new Schema will be created. In
1339
- # this situation, `update_mask` is ignored.
1410
+ # If set to true, and the Schema is not found, a new Schema is created. In this
1411
+ # situation, `update_mask` is ignored.
1340
1412
  # @param [String] fields
1341
1413
  # Selector specifying which fields to include in a partial response.
1342
1414
  # @param [String] quota_user
@@ -1594,11 +1666,11 @@ module Google
1594
1666
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
1595
1667
  # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
1596
1668
  # collections/*/dataStores/*/servingConfigs/*` One default serving config is
1597
- # created along with your recommendation engine creation. The engine ID will be
1598
- # used as the ID of the default serving config. For example, for Engine `
1599
- # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
1600
- # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
1601
- # engine` for your RecommendationService.Recommend requests.
1669
+ # created along with your recommendation engine creation. The engine ID is used
1670
+ # as the ID of the default serving config. For example, for Engine `projects/*/
1671
+ # locations/global/collections/*/engines/my-engine`, you can use `projects/*/
1672
+ # locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
1673
+ # your RecommendationService.Recommend requests.
1602
1674
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
1603
1675
  # @param [String] fields
1604
1676
  # Selector specifying which fields to include in a partial response.
@@ -2551,7 +2623,7 @@ module Google
2551
2623
  execute_or_queue_command(command, &block)
2552
2624
  end
2553
2625
 
2554
- # Bulk import of User events. Request processing might be synchronous. Events
2626
+ # Bulk import of user events. Request processing might be synchronous. Events
2555
2627
  # that already exist are skipped. Use this method for backfilling historical
2556
2628
  # user events. Operation.response is of type ImportResponse. Note that it is
2557
2629
  # possible for a subset of the items to be successfully inserted. Operation.
@@ -3375,11 +3447,11 @@ module Google
3375
3447
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
3376
3448
  # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
3377
3449
  # collections/*/dataStores/*/servingConfigs/*` One default serving config is
3378
- # created along with your recommendation engine creation. The engine ID will be
3379
- # used as the ID of the default serving config. For example, for Engine `
3380
- # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
3381
- # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
3382
- # engine` for your RecommendationService.Recommend requests.
3450
+ # created along with your recommendation engine creation. The engine ID is used
3451
+ # as the ID of the default serving config. For example, for Engine `projects/*/
3452
+ # locations/global/collections/*/engines/my-engine`, you can use `projects/*/
3453
+ # locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
3454
+ # your RecommendationService.Recommend requests.
3383
3455
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
3384
3456
  # @param [String] fields
3385
3457
  # Selector specifying which fields to include in a partial response.
@@ -3960,7 +4032,7 @@ module Google
3960
4032
  # permission to list DataStores under this location, regardless of whether or
3961
4033
  # not this data store exists, a PERMISSION_DENIED error is returned.
3962
4034
  # @param [String] filter
3963
- # Filter by solution type. For example: filter = 'solution_type:
4035
+ # Filter by solution type . For example: filter = 'solution_type:
3964
4036
  # SOLUTION_TYPE_SEARCH'
3965
4037
  # @param [Fixnum] page_size
3966
4038
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
@@ -4048,14 +4120,14 @@ module Google
4048
4120
  # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
4049
4121
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
4050
4122
  # @param [String] document_id
4051
- # Required. The ID to use for the Document, which will become the final
4052
- # component of the Document.name. If the caller does not have permission to
4053
- # create the Document, regardless of whether or not it exists, a `
4054
- # PERMISSION_DENIED` error is returned. This field must be unique among all
4055
- # Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
4056
- # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
4057
- # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
4058
- # INVALID_ARGUMENT` error is returned.
4123
+ # Required. The ID to use for the Document, which becomes the final component of
4124
+ # the Document.name. If the caller does not have permission to create the
4125
+ # Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
4126
+ # is returned. This field must be unique among all Documents with the same
4127
+ # parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
4128
+ # conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
4129
+ # length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
4130
+ # returned.
4059
4131
  # @param [String] fields
4060
4132
  # Selector specifying which fields to include in a partial response.
4061
4133
  # @param [String] quota_user
@@ -4157,8 +4229,8 @@ module Google
4157
4229
  end
4158
4230
 
4159
4231
  # Bulk import of multiple Documents. Request processing may be synchronous. Non-
4160
- # existing items will be created. Note: It is possible for a subset of the
4161
- # Documents to be successfully updated.
4232
+ # existing items are created. Note: It is possible for a subset of the Documents
4233
+ # to be successfully updated.
4162
4234
  # @param [String] parent
4163
4235
  # Required. The parent branch resource name, such as `projects/`project`/
4164
4236
  # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
@@ -4203,8 +4275,8 @@ module Google
4203
4275
  # PERMISSION_DENIED` error is returned.
4204
4276
  # @param [Fixnum] page_size
4205
4277
  # Maximum number of Documents to return. If unspecified, defaults to 100. The
4206
- # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
4207
- # this field is negative, an `INVALID_ARGUMENT` error is returned.
4278
+ # maximum allowed value is 1000. Values above 1000 are set to 1000. If this
4279
+ # field is negative, an `INVALID_ARGUMENT` error is returned.
4208
4280
  # @param [String] page_token
4209
4281
  # A page token ListDocumentsResponse.next_page_token, received from a previous
4210
4282
  # DocumentService.ListDocuments call. Provide this to retrieve the subsequent
@@ -4248,10 +4320,10 @@ module Google
4248
4320
  # with a length limit of 1024 characters.
4249
4321
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
4250
4322
  # @param [Boolean] allow_missing
4251
- # If set to true, and the Document is not found, a new Document will be created.
4323
+ # If set to `true` and the Document is not found, a new Document is be created.
4252
4324
  # @param [String] update_mask
4253
4325
  # Indicates which fields in the provided imported 'document' to update. If not
4254
- # set, will by default update all fields.
4326
+ # set, by default updates all fields.
4255
4327
  # @param [String] fields
4256
4328
  # Selector specifying which fields to include in a partial response.
4257
4329
  # @param [String] quota_user
@@ -4322,6 +4394,46 @@ module Google
4322
4394
  execute_or_queue_command(command, &block)
4323
4395
  end
4324
4396
 
4397
+ # Starts asynchronous cancellation on a long-running operation. The server makes
4398
+ # a best effort to cancel the operation, but success is not guaranteed. If the
4399
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
4400
+ # Clients can use Operations.GetOperation or other methods to check whether the
4401
+ # cancellation succeeded or whether the operation completed despite cancellation.
4402
+ # On successful cancellation, the operation is not deleted; instead, it becomes
4403
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
4404
+ # corresponding to `Code.CANCELLED`.
4405
+ # @param [String] name
4406
+ # The name of the operation resource to be cancelled.
4407
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
4408
+ # @param [String] fields
4409
+ # Selector specifying which fields to include in a partial response.
4410
+ # @param [String] quota_user
4411
+ # Available to use for quota purposes for server-side applications. Can be any
4412
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4413
+ # @param [Google::Apis::RequestOptions] options
4414
+ # Request-specific options
4415
+ #
4416
+ # @yield [result, err] Result & error if block supplied
4417
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
4418
+ # @yieldparam err [StandardError] error object if request failed
4419
+ #
4420
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
4421
+ #
4422
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4423
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4424
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4425
+ def cancel_project_location_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4426
+ command = make_simple_command(:post, 'v1beta/{+name}:cancel', options)
4427
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest::Representation
4428
+ command.request_object = google_longrunning_cancel_operation_request_object
4429
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
4430
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
4431
+ command.params['name'] = name unless name.nil?
4432
+ command.query['fields'] = fields unless fields.nil?
4433
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4434
+ execute_or_queue_command(command, &block)
4435
+ end
4436
+
4325
4437
  # Gets the latest state of a long-running operation. Clients can use this method
4326
4438
  # to poll the operation result at intervals as recommended by the API service.
4327
4439
  # @param [String] name
@@ -4770,8 +4882,8 @@ module Google
4770
4882
  # .
4771
4883
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
4772
4884
  # @param [String] schema_id
4773
- # Required. The ID to use for the Schema, which will become the final component
4774
- # of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
4885
+ # Required. The ID to use for the Schema, which becomes the final component of
4886
+ # the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
4775
4887
  # org/html/rfc1034) standard with a length limit of 63 characters.
4776
4888
  # @param [String] fields
4777
4889
  # Selector specifying which fields to include in a partial response.
@@ -4874,8 +4986,8 @@ module Google
4874
4986
  # .
4875
4987
  # @param [Fixnum] page_size
4876
4988
  # The maximum number of Schemas to return. The service may return fewer than
4877
- # this value. If unspecified, at most 100 Schemas will be returned. The maximum
4878
- # value is 1000; values above 1000 will be coerced to 1000.
4989
+ # this value. If unspecified, at most 100 Schemas are returned. The maximum
4990
+ # value is 1000; values above 1000 are set to 1000.
4879
4991
  # @param [String] page_token
4880
4992
  # A page token, received from a previous SchemaService.ListSchemas call. Provide
4881
4993
  # this to retrieve the subsequent page. When paginating, all other parameters
@@ -4918,8 +5030,8 @@ module Google
4918
5030
  # limit of 1024 characters.
4919
5031
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
4920
5032
  # @param [Boolean] allow_missing
4921
- # If set to true, and the Schema is not found, a new Schema will be created. In
4922
- # this situation, `update_mask` is ignored.
5033
+ # If set to true, and the Schema is not found, a new Schema is created. In this
5034
+ # situation, `update_mask` is ignored.
4923
5035
  # @param [String] fields
4924
5036
  # Selector specifying which fields to include in a partial response.
4925
5037
  # @param [String] quota_user
@@ -5106,11 +5218,11 @@ module Google
5106
5218
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
5107
5219
  # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
5108
5220
  # collections/*/dataStores/*/servingConfigs/*` One default serving config is
5109
- # created along with your recommendation engine creation. The engine ID will be
5110
- # used as the ID of the default serving config. For example, for Engine `
5111
- # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
5112
- # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
5113
- # engine` for your RecommendationService.Recommend requests.
5221
+ # created along with your recommendation engine creation. The engine ID is used
5222
+ # as the ID of the default serving config. For example, for Engine `projects/*/
5223
+ # locations/global/collections/*/engines/my-engine`, you can use `projects/*/
5224
+ # locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
5225
+ # your RecommendationService.Recommend requests.
5114
5226
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
5115
5227
  # @param [String] fields
5116
5228
  # Selector specifying which fields to include in a partial response.
@@ -5840,7 +5952,7 @@ module Google
5840
5952
  execute_or_queue_command(command, &block)
5841
5953
  end
5842
5954
 
5843
- # Bulk import of User events. Request processing might be synchronous. Events
5955
+ # Bulk import of user events. Request processing might be synchronous. Events
5844
5956
  # that already exist are skipped. Use this method for backfilling historical
5845
5957
  # user events. Operation.response is of type ImportResponse. Note that it is
5846
5958
  # possible for a subset of the items to be successfully inserted. Operation.