google-apis-discoveryengine_v1alpha 0.79.0 → 0.81.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.
@@ -51,6 +51,77 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
+ # Distributes a LicenseConfig from billing account level to project level.
55
+ # @param [String] billing_account_license_config
56
+ # Required. Full resource name of BillingAccountLicenseConfig. Format: `
57
+ # billingAccounts/`billing_account`/billingAccountLicenseConfigs/`
58
+ # billing_account_license_config_id``.
59
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest] google_cloud_discoveryengine_v1alpha_distribute_license_config_request_object
60
+ # @param [String] fields
61
+ # Selector specifying which fields to include in a partial response.
62
+ # @param [String] quota_user
63
+ # Available to use for quota purposes for server-side applications. Can be any
64
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
65
+ # @param [Google::Apis::RequestOptions] options
66
+ # Request-specific options
67
+ #
68
+ # @yield [result, err] Result & error if block supplied
69
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse] parsed result object
70
+ # @yieldparam err [StandardError] error object if request failed
71
+ #
72
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse]
73
+ #
74
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
75
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
76
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
77
+ def distribute_billing_account_billing_account_license_config_license_config(billing_account_license_config, google_cloud_discoveryengine_v1alpha_distribute_license_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
78
+ command = make_simple_command(:post, 'v1alpha/{+billingAccountLicenseConfig}:distributeLicenseConfig', options)
79
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest::Representation
80
+ command.request_object = google_cloud_discoveryengine_v1alpha_distribute_license_config_request_object
81
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse::Representation
82
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse
83
+ command.params['billingAccountLicenseConfig'] = billing_account_license_config unless billing_account_license_config.nil?
84
+ command.query['fields'] = fields unless fields.nil?
85
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
86
+ execute_or_queue_command(command, &block)
87
+ end
88
+
89
+ # This method is called from the billing account side to retract the
90
+ # LicenseConfig from the given project back to the billing account.
91
+ # @param [String] billing_account_license_config
92
+ # Required. Full resource name of BillingAccountLicenseConfig. Format: `
93
+ # billingAccounts/`billing_account`/billingAccountLicenseConfigs/`
94
+ # billing_account_license_config_id``.
95
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest] google_cloud_discoveryengine_v1alpha_retract_license_config_request_object
96
+ # @param [String] fields
97
+ # Selector specifying which fields to include in a partial response.
98
+ # @param [String] quota_user
99
+ # Available to use for quota purposes for server-side applications. Can be any
100
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
101
+ # @param [Google::Apis::RequestOptions] options
102
+ # Request-specific options
103
+ #
104
+ # @yield [result, err] Result & error if block supplied
105
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse] parsed result object
106
+ # @yieldparam err [StandardError] error object if request failed
107
+ #
108
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse]
109
+ #
110
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
111
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
112
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
113
+ def retract_billing_account_billing_account_license_config_license_config(billing_account_license_config, google_cloud_discoveryengine_v1alpha_retract_license_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
114
+ command = make_simple_command(:post, 'v1alpha/{+billingAccountLicenseConfig}:retractLicenseConfig', options)
115
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest::Representation
116
+ command.request_object = google_cloud_discoveryengine_v1alpha_retract_license_config_request_object
117
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse::Representation
118
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse
119
+ command.params['billingAccountLicenseConfig'] = billing_account_license_config unless billing_account_license_config.nil?
120
+ command.query['fields'] = fields unless fields.nil?
121
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
122
+ execute_or_queue_command(command, &block)
123
+ end
124
+
54
125
  # Downloads a file from the session.
55
126
  # @param [String] name
56
127
  # Required. The resource name of the Session. Format: `projects/`project`/
@@ -338,6 +409,64 @@ module Google
338
409
  execute_or_queue_command(command, &block)
339
410
  end
340
411
 
412
+ # Gets configurable pricing usage stats.
413
+ # @param [String] name
414
+ # Required. The name of the ConfigurablePricingUsageStats to retrieve. Format:
415
+ # projects/`project`/locations/`location`/configurablePricingUsageStats
416
+ # @param [Array<String>, String] metric_types
417
+ # Optional. The metric types to return usage for.
418
+ # @param [Fixnum] time_range_end_date_day
419
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
420
+ # specify a year by itself or a year and month where the day isn't significant.
421
+ # @param [Fixnum] time_range_end_date_month
422
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
423
+ # and day.
424
+ # @param [Fixnum] time_range_end_date_year
425
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
426
+ # year.
427
+ # @param [Fixnum] time_range_start_date_day
428
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
429
+ # specify a year by itself or a year and month where the day isn't significant.
430
+ # @param [Fixnum] time_range_start_date_month
431
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
432
+ # and day.
433
+ # @param [Fixnum] time_range_start_date_year
434
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
435
+ # year.
436
+ # @param [String] fields
437
+ # Selector specifying which fields to include in a partial response.
438
+ # @param [String] quota_user
439
+ # Available to use for quota purposes for server-side applications. Can be any
440
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
441
+ # @param [Google::Apis::RequestOptions] options
442
+ # Request-specific options
443
+ #
444
+ # @yield [result, err] Result & error if block supplied
445
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats] parsed result object
446
+ # @yieldparam err [StandardError] error object if request failed
447
+ #
448
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats]
449
+ #
450
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
451
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
452
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
453
+ def get_project_location_configurable_pricing_usage_stats(name, metric_types: nil, time_range_end_date_day: nil, time_range_end_date_month: nil, time_range_end_date_year: nil, time_range_start_date_day: nil, time_range_start_date_month: nil, time_range_start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
454
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
455
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats::Representation
456
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats
457
+ command.params['name'] = name unless name.nil?
458
+ command.query['metricTypes'] = metric_types unless metric_types.nil?
459
+ command.query['timeRange.endDate.day'] = time_range_end_date_day unless time_range_end_date_day.nil?
460
+ command.query['timeRange.endDate.month'] = time_range_end_date_month unless time_range_end_date_month.nil?
461
+ command.query['timeRange.endDate.year'] = time_range_end_date_year unless time_range_end_date_year.nil?
462
+ command.query['timeRange.startDate.day'] = time_range_start_date_day unless time_range_start_date_day.nil?
463
+ command.query['timeRange.startDate.month'] = time_range_start_date_month unless time_range_start_date_month.nil?
464
+ command.query['timeRange.startDate.year'] = time_range_start_date_year unless time_range_start_date_year.nil?
465
+ command.query['fields'] = fields unless fields.nil?
466
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
467
+ execute_or_queue_command(command, &block)
468
+ end
469
+
341
470
  # Obtains the time series data of organic or dedicated crawl rate for monitoring.
342
471
  # When dedicated crawl rate is not set, it will return vertex AI's organic
343
472
  # crawl rate time series. Organic crawl means Google automatically crawl the
@@ -1015,6 +1144,40 @@ module Google
1015
1144
  execute_or_queue_command(command, &block)
1016
1145
  end
1017
1146
 
1147
+ # Deprecated: Checks the existence of a refresh token for the EUC user for a
1148
+ # given connection and returns its details. Use AcquireAccessToken instead and
1149
+ # then check the validity of the returned token by asking the 3rd party system.
1150
+ # There's no way to know for sure if a refresh token is valid without asking the
1151
+ # 3rd party system.
1152
+ # @param [String] name
1153
+ # Required. The resource name of the connector for which a token is queried.
1154
+ # @param [String] fields
1155
+ # Selector specifying which fields to include in a partial response.
1156
+ # @param [String] quota_user
1157
+ # Available to use for quota purposes for server-side applications. Can be any
1158
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1159
+ # @param [Google::Apis::RequestOptions] options
1160
+ # Request-specific options
1161
+ #
1162
+ # @yield [result, err] Result & error if block supplied
1163
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRefreshTokenResponse] parsed result object
1164
+ # @yieldparam err [StandardError] error object if request failed
1165
+ #
1166
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRefreshTokenResponse]
1167
+ #
1168
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1169
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1170
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1171
+ def check_project_location_collection_data_connector_refresh_token(name, fields: nil, quota_user: nil, options: nil, &block)
1172
+ command = make_simple_command(:get, 'v1alpha/{+name}:checkRefreshToken', options)
1173
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRefreshTokenResponse::Representation
1174
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckRefreshTokenResponse
1175
+ command.params['name'] = name unless name.nil?
1176
+ command.query['fields'] = fields unless fields.nil?
1177
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1178
+ execute_or_queue_command(command, &block)
1179
+ end
1180
+
1018
1181
  # Get the secret for the associated connector.
1019
1182
  # @param [String] name
1020
1183
  # Required. The full resource name of the associated data connector.
@@ -4910,6 +5073,37 @@ module Google
4910
5073
  execute_or_queue_command(command, &block)
4911
5074
  end
4912
5075
 
5076
+ # Get Workspace settings for the end user.
5077
+ # @param [String] name
5078
+ # Required. Full Engine resource name. Format: `projects/`project`/locations/`
5079
+ # location`/collections/`collection_id`/engines/`engine_id``
5080
+ # @param [String] fields
5081
+ # Selector specifying which fields to include in a partial response.
5082
+ # @param [String] quota_user
5083
+ # Available to use for quota purposes for server-side applications. Can be any
5084
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5085
+ # @param [Google::Apis::RequestOptions] options
5086
+ # Request-specific options
5087
+ #
5088
+ # @yield [result, err] Result & error if block supplied
5089
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWorkspaceSettings] parsed result object
5090
+ # @yieldparam err [StandardError] error object if request failed
5091
+ #
5092
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWorkspaceSettings]
5093
+ #
5094
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5095
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5096
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5097
+ def get_project_location_collection_engine_workspace_settings(name, fields: nil, quota_user: nil, options: nil, &block)
5098
+ command = make_simple_command(:get, 'v1alpha/{+name}:getWorkspaceSettings', options)
5099
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWorkspaceSettings::Representation
5100
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWorkspaceSettings
5101
+ command.params['name'] = name unless name.nil?
5102
+ command.query['fields'] = fields unless fields.nil?
5103
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5104
+ execute_or_queue_command(command, &block)
5105
+ end
5106
+
4913
5107
  # Lists all the Engines associated with the project.
4914
5108
  # @param [String] parent
4915
5109
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -5237,6 +5431,199 @@ module Google
5237
5431
  execute_or_queue_command(command, &block)
5238
5432
  end
5239
5433
 
5434
+ # Creates a CannedQuery.
5435
+ # @param [String] parent
5436
+ # Required. The parent resource name. Format: `projects/`project`/locations/`
5437
+ # location`/collections/`collection`/engines/`engine`/assistants/`assistant``
5438
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] google_cloud_discoveryengine_v1alpha_canned_query_object
5439
+ # @param [String] canned_query_id
5440
+ # Required. The ID to use for the canned query, which will become the final
5441
+ # component of the canned query's resource name. This field must conform to [RFC-
5442
+ # 1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63
5443
+ # characters.
5444
+ # @param [String] fields
5445
+ # Selector specifying which fields to include in a partial response.
5446
+ # @param [String] quota_user
5447
+ # Available to use for quota purposes for server-side applications. Can be any
5448
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5449
+ # @param [Google::Apis::RequestOptions] options
5450
+ # Request-specific options
5451
+ #
5452
+ # @yield [result, err] Result & error if block supplied
5453
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] parsed result object
5454
+ # @yieldparam err [StandardError] error object if request failed
5455
+ #
5456
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery]
5457
+ #
5458
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5459
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5460
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5461
+ def create_project_location_collection_engine_assistant_canned_query(parent, google_cloud_discoveryengine_v1alpha_canned_query_object = nil, canned_query_id: nil, fields: nil, quota_user: nil, options: nil, &block)
5462
+ command = make_simple_command(:post, 'v1alpha/{+parent}/cannedQueries', options)
5463
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
5464
+ command.request_object = google_cloud_discoveryengine_v1alpha_canned_query_object
5465
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
5466
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery
5467
+ command.params['parent'] = parent unless parent.nil?
5468
+ command.query['cannedQueryId'] = canned_query_id unless canned_query_id.nil?
5469
+ command.query['fields'] = fields unless fields.nil?
5470
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5471
+ execute_or_queue_command(command, &block)
5472
+ end
5473
+
5474
+ # Deletes a CannedQuery.
5475
+ # @param [String] name
5476
+ # Required. Resource name of CannedQuery. Format: `projects/`project`/locations/`
5477
+ # location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
5478
+ # cannedQueries/`canned_query`` If the caller does not have permission to delete
5479
+ # the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED`
5480
+ # error is returned. If the canned query to delete does not exist, a `NOT_FOUND`
5481
+ # error is returned.
5482
+ # @param [String] fields
5483
+ # Selector specifying which fields to include in a partial response.
5484
+ # @param [String] quota_user
5485
+ # Available to use for quota purposes for server-side applications. Can be any
5486
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5487
+ # @param [Google::Apis::RequestOptions] options
5488
+ # Request-specific options
5489
+ #
5490
+ # @yield [result, err] Result & error if block supplied
5491
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
5492
+ # @yieldparam err [StandardError] error object if request failed
5493
+ #
5494
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
5495
+ #
5496
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5497
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5498
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5499
+ def delete_project_location_collection_engine_assistant_canned_query(name, fields: nil, quota_user: nil, options: nil, &block)
5500
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
5501
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
5502
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
5503
+ command.params['name'] = name unless name.nil?
5504
+ command.query['fields'] = fields unless fields.nil?
5505
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5506
+ execute_or_queue_command(command, &block)
5507
+ end
5508
+
5509
+ # Gets a CannedQuery.
5510
+ # @param [String] name
5511
+ # Required. Resource name of CannedQuery. Format: `projects/`project`/locations/`
5512
+ # location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
5513
+ # cannedQueries/`canned_query``
5514
+ # @param [String] fields
5515
+ # Selector specifying which fields to include in a partial response.
5516
+ # @param [String] quota_user
5517
+ # Available to use for quota purposes for server-side applications. Can be any
5518
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5519
+ # @param [Google::Apis::RequestOptions] options
5520
+ # Request-specific options
5521
+ #
5522
+ # @yield [result, err] Result & error if block supplied
5523
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] parsed result object
5524
+ # @yieldparam err [StandardError] error object if request failed
5525
+ #
5526
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery]
5527
+ #
5528
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5529
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5530
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5531
+ def get_project_location_collection_engine_assistant_canned_query(name, fields: nil, quota_user: nil, options: nil, &block)
5532
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
5533
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
5534
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery
5535
+ command.params['name'] = name unless name.nil?
5536
+ command.query['fields'] = fields unless fields.nil?
5537
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5538
+ execute_or_queue_command(command, &block)
5539
+ end
5540
+
5541
+ # Lists all CannedQuerys under an Assistant.
5542
+ # @param [String] parent
5543
+ # Required. The parent resource name. Format: `projects/`project`/locations/`
5544
+ # location`/collections/`collection`/engines/`engine`/assistants/`assistant``
5545
+ # @param [String] filter
5546
+ # Optional. The filter expression. Supported fields: * `enabled` * `
5547
+ # google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=
5548
+ # true AND google_defined=true`
5549
+ # @param [Fixnum] page_size
5550
+ # Maximum number of canned queries to return. If unspecified, defaults to 100.
5551
+ # The maximum allowed value is 1000; anything above that will be coerced down to
5552
+ # 1000.
5553
+ # @param [String] page_token
5554
+ # A page token received from a previous CannedQueryService.ListCannedQueries
5555
+ # call. Provide this to retrieve the subsequent page. When paginating, all other
5556
+ # parameters provided to CannedQueryService.ListCannedQueries must match the
5557
+ # call that provided the page token.
5558
+ # @param [String] fields
5559
+ # Selector specifying which fields to include in a partial response.
5560
+ # @param [String] quota_user
5561
+ # Available to use for quota purposes for server-side applications. Can be any
5562
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5563
+ # @param [Google::Apis::RequestOptions] options
5564
+ # Request-specific options
5565
+ #
5566
+ # @yield [result, err] Result & error if block supplied
5567
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse] parsed result object
5568
+ # @yieldparam err [StandardError] error object if request failed
5569
+ #
5570
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse]
5571
+ #
5572
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5573
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5574
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5575
+ def list_project_location_collection_engine_assistant_canned_queries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
5576
+ command = make_simple_command(:get, 'v1alpha/{+parent}/cannedQueries', options)
5577
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse::Representation
5578
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse
5579
+ command.params['parent'] = parent unless parent.nil?
5580
+ command.query['filter'] = filter unless filter.nil?
5581
+ command.query['pageSize'] = page_size unless page_size.nil?
5582
+ command.query['pageToken'] = page_token unless page_token.nil?
5583
+ command.query['fields'] = fields unless fields.nil?
5584
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5585
+ execute_or_queue_command(command, &block)
5586
+ end
5587
+
5588
+ # Updates a CannedQuery.
5589
+ # @param [String] name
5590
+ # Immutable. Resource name of the canned query. Format: `projects/`project`/
5591
+ # locations/`location`/collections/`collection`/engines/`engine`/assistants/`
5592
+ # assistant`/cannedQueries/`canned_query`` It must be a UTF-8 encoded string
5593
+ # with a length limit of 1024 characters.
5594
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] google_cloud_discoveryengine_v1alpha_canned_query_object
5595
+ # @param [String] update_mask
5596
+ # The list of fields to update.
5597
+ # @param [String] fields
5598
+ # Selector specifying which fields to include in a partial response.
5599
+ # @param [String] quota_user
5600
+ # Available to use for quota purposes for server-side applications. Can be any
5601
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5602
+ # @param [Google::Apis::RequestOptions] options
5603
+ # Request-specific options
5604
+ #
5605
+ # @yield [result, err] Result & error if block supplied
5606
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] parsed result object
5607
+ # @yieldparam err [StandardError] error object if request failed
5608
+ #
5609
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery]
5610
+ #
5611
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5612
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5613
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5614
+ def patch_project_location_collection_engine_assistant_canned_query(name, google_cloud_discoveryengine_v1alpha_canned_query_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
5615
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
5616
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
5617
+ command.request_object = google_cloud_discoveryengine_v1alpha_canned_query_object
5618
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
5619
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery
5620
+ command.params['name'] = name unless name.nil?
5621
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5622
+ command.query['fields'] = fields unless fields.nil?
5623
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5624
+ execute_or_queue_command(command, &block)
5625
+ end
5626
+
5240
5627
  # Completes the user input with advanced keyword suggestions.
5241
5628
  # @param [String] completion_config
5242
5629
  # Required. The completion_config of the parent dataStore or engine resource
@@ -11564,6 +11951,145 @@ module Google
11564
11951
  execute_or_queue_command(command, &block)
11565
11952
  end
11566
11953
 
11954
+ # Creates a new User Store.
11955
+ # @param [String] parent
11956
+ # Required. The parent collection resource name, such as `projects/`project`/
11957
+ # locations/`location``.
11958
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] google_cloud_discoveryengine_v1alpha_user_store_object
11959
+ # @param [String] user_store_id
11960
+ # Required. The ID of the User Store to create. The ID must contain only letters
11961
+ # (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum
11962
+ # length is 63 characters.
11963
+ # @param [String] fields
11964
+ # Selector specifying which fields to include in a partial response.
11965
+ # @param [String] quota_user
11966
+ # Available to use for quota purposes for server-side applications. Can be any
11967
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
11968
+ # @param [Google::Apis::RequestOptions] options
11969
+ # Request-specific options
11970
+ #
11971
+ # @yield [result, err] Result & error if block supplied
11972
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] parsed result object
11973
+ # @yieldparam err [StandardError] error object if request failed
11974
+ #
11975
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore]
11976
+ #
11977
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
11978
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
11979
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
11980
+ def create_project_location_user_store(parent, google_cloud_discoveryengine_v1alpha_user_store_object = nil, user_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
11981
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userStores', options)
11982
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
11983
+ command.request_object = google_cloud_discoveryengine_v1alpha_user_store_object
11984
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
11985
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore
11986
+ command.params['parent'] = parent unless parent.nil?
11987
+ command.query['userStoreId'] = user_store_id unless user_store_id.nil?
11988
+ command.query['fields'] = fields unless fields.nil?
11989
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
11990
+ execute_or_queue_command(command, &block)
11991
+ end
11992
+
11993
+ # Deletes the User Store.
11994
+ # @param [String] name
11995
+ # Required. The name of the User Store to delete. Format: `projects/`project`/
11996
+ # locations/`location`/userStores/`user_store_id``
11997
+ # @param [String] fields
11998
+ # Selector specifying which fields to include in a partial response.
11999
+ # @param [String] quota_user
12000
+ # Available to use for quota purposes for server-side applications. Can be any
12001
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
12002
+ # @param [Google::Apis::RequestOptions] options
12003
+ # Request-specific options
12004
+ #
12005
+ # @yield [result, err] Result & error if block supplied
12006
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
12007
+ # @yieldparam err [StandardError] error object if request failed
12008
+ #
12009
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
12010
+ #
12011
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
12012
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
12013
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
12014
+ def delete_project_location_user_store(name, fields: nil, quota_user: nil, options: nil, &block)
12015
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
12016
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
12017
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
12018
+ command.params['name'] = name unless name.nil?
12019
+ command.query['fields'] = fields unless fields.nil?
12020
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
12021
+ execute_or_queue_command(command, &block)
12022
+ end
12023
+
12024
+ # Gets the User Store.
12025
+ # @param [String] name
12026
+ # Required. The name of the User Store to get. Format: `projects/`project`/
12027
+ # locations/`location`/userStores/`user_store_id``
12028
+ # @param [String] fields
12029
+ # Selector specifying which fields to include in a partial response.
12030
+ # @param [String] quota_user
12031
+ # Available to use for quota purposes for server-side applications. Can be any
12032
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
12033
+ # @param [Google::Apis::RequestOptions] options
12034
+ # Request-specific options
12035
+ #
12036
+ # @yield [result, err] Result & error if block supplied
12037
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] parsed result object
12038
+ # @yieldparam err [StandardError] error object if request failed
12039
+ #
12040
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore]
12041
+ #
12042
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
12043
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
12044
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
12045
+ def get_project_location_user_store(name, fields: nil, quota_user: nil, options: nil, &block)
12046
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
12047
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
12048
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore
12049
+ command.params['name'] = name unless name.nil?
12050
+ command.query['fields'] = fields unless fields.nil?
12051
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
12052
+ execute_or_queue_command(command, &block)
12053
+ end
12054
+
12055
+ # Updates the User Store.
12056
+ # @param [String] name
12057
+ # Immutable. The full resource name of the User Store, in the format of `
12058
+ # projects/`project`/locations/`location`/userStores/`user_store``. This field
12059
+ # must be a UTF-8 encoded string with a length limit of 1024 characters.
12060
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] google_cloud_discoveryengine_v1alpha_user_store_object
12061
+ # @param [String] update_mask
12062
+ # Optional. The list of fields to update.
12063
+ # @param [String] fields
12064
+ # Selector specifying which fields to include in a partial response.
12065
+ # @param [String] quota_user
12066
+ # Available to use for quota purposes for server-side applications. Can be any
12067
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
12068
+ # @param [Google::Apis::RequestOptions] options
12069
+ # Request-specific options
12070
+ #
12071
+ # @yield [result, err] Result & error if block supplied
12072
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] parsed result object
12073
+ # @yieldparam err [StandardError] error object if request failed
12074
+ #
12075
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore]
12076
+ #
12077
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
12078
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
12079
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
12080
+ def patch_project_location_user_store(name, google_cloud_discoveryengine_v1alpha_user_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
12081
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
12082
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
12083
+ command.request_object = google_cloud_discoveryengine_v1alpha_user_store_object
12084
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
12085
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore
12086
+ command.params['name'] = name unless name.nil?
12087
+ command.query['updateMask'] = update_mask unless update_mask.nil?
12088
+ command.query['fields'] = fields unless fields.nil?
12089
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
12090
+ execute_or_queue_command(command, &block)
12091
+ end
12092
+
11567
12093
  # Gets the latest state of a long-running operation. Clients can use this method
11568
12094
  # to poll the operation result at intervals as recommended by the API service.
11569
12095
  # @param [String] name
@@ -34,6 +34,12 @@ module Google
34
34
 
35
35
  # Search your organization's data in the Cloud Search index
36
36
  AUTH_CLOUD_SEARCH_QUERY = 'https://www.googleapis.com/auth/cloud_search.query'
37
+
38
+ # View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf.
39
+ AUTH_DISCOVERYENGINE_ASSIST_READWRITE = 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite'
40
+
41
+ # View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data.
42
+ AUTH_DISCOVERYENGINE_READWRITE = 'https://www.googleapis.com/auth/discoveryengine.readwrite'
37
43
  end
38
44
  end
39
45
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.79.0
4
+ version: 0.81.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.79.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.81.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
62
62
  rdoc_options: []
63
63
  require_paths: