@googleapis/discoveryengine 26.1.0 → 27.0.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.
package/build/v1beta.d.ts CHANGED
@@ -2480,6 +2480,10 @@ export declare namespace discoveryengine_v1beta {
2480
2480
  * Optional. Configuration for configurable billing approach. See
2481
2481
  */
2482
2482
  configurableBillingApproach?: string | null;
2483
+ /**
2484
+ * Output only. The timestamp when configurable_billing_approach was last updated.
2485
+ */
2486
+ configurableBillingApproachUpdateTime?: string | null;
2483
2487
  /**
2484
2488
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
2485
2489
  */
@@ -2612,6 +2616,19 @@ export declare namespace discoveryengine_v1beta {
2612
2616
  */
2613
2617
  userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
2614
2618
  }
2619
+ /**
2620
+ * Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.
2621
+ */
2622
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata {
2623
+ /**
2624
+ * Operation create time.
2625
+ */
2626
+ createTime?: string | null;
2627
+ /**
2628
+ * Operation last update time. If the operation is done, this is also the finish time.
2629
+ */
2630
+ updateTime?: string | null;
2631
+ }
2615
2632
  /**
2616
2633
  * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.
2617
2634
  */
@@ -2725,6 +2742,19 @@ export declare namespace discoveryengine_v1beta {
2725
2742
  */
2726
2743
  updateTime?: string | null;
2727
2744
  }
2745
+ /**
2746
+ * Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.
2747
+ */
2748
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata {
2749
+ /**
2750
+ * The number of end users under the user store that failed to be deleted.
2751
+ */
2752
+ failureCount?: string | null;
2753
+ /**
2754
+ * The number of end users under the user store that were successfully deleted.
2755
+ */
2756
+ successCount?: string | null;
2757
+ }
2728
2758
  /**
2729
2759
  * Defines target endpoints used to connect to third-party sources.
2730
2760
  */
@@ -3776,6 +3806,10 @@ export declare namespace discoveryengine_v1beta {
3776
3806
  * Metadata and configurations for a Google Cloud project in the service.
3777
3807
  */
3778
3808
  export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
3809
+ /**
3810
+ * Output only. The current status of the project's configurable billing.
3811
+ */
3812
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus;
3779
3813
  /**
3780
3814
  * Output only. The timestamp when this project is created.
3781
3815
  */
@@ -3799,6 +3833,23 @@ export declare namespace discoveryengine_v1beta {
3799
3833
  [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
3800
3834
  } | null;
3801
3835
  }
3836
+ /**
3837
+ * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).
3838
+ */
3839
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus {
3840
+ /**
3841
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
3842
+ */
3843
+ effectiveIndexingCoreThreshold?: string | null;
3844
+ /**
3845
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
3846
+ */
3847
+ effectiveSearchQpmThreshold?: string | null;
3848
+ /**
3849
+ * Optional. The start time of the currently active billing subscription.
3850
+ */
3851
+ startTime?: string | null;
3852
+ }
3802
3853
  /**
3803
3854
  * Customer provided configurations.
3804
3855
  */
@@ -3816,6 +3867,10 @@ export declare namespace discoveryengine_v1beta {
3816
3867
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
3817
3868
  */
3818
3869
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
3870
+ /**
3871
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
3872
+ */
3873
+ optOutNotebookSharing?: boolean | null;
3819
3874
  }
3820
3875
  /**
3821
3876
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -4395,7 +4450,7 @@ export declare namespace discoveryengine_v1beta {
4395
4450
  [key: string]: string;
4396
4451
  } | null;
4397
4452
  /**
4398
- * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
4453
+ * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
4399
4454
  */
4400
4455
  userPseudoId?: string | null;
4401
4456
  }
@@ -5539,7 +5594,7 @@ export declare namespace discoveryengine_v1beta {
5539
5594
  */
5540
5595
  userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo;
5541
5596
  /**
5542
- * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
5597
+ * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
5543
5598
  */
5544
5599
  userPseudoId?: string | null;
5545
5600
  }
@@ -8171,6 +8226,10 @@ export declare namespace discoveryengine_v1beta {
8171
8226
  * Optional. Configuration for configurable billing approach. See
8172
8227
  */
8173
8228
  configurableBillingApproach?: string | null;
8229
+ /**
8230
+ * Output only. The timestamp when configurable_billing_approach was last updated.
8231
+ */
8232
+ configurableBillingApproachUpdateTime?: string | null;
8174
8233
  /**
8175
8234
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
8176
8235
  */
@@ -10061,6 +10120,10 @@ export declare namespace discoveryengine_v1beta {
10061
10120
  * Metadata and configurations for a Google Cloud project in the service.
10062
10121
  */
10063
10122
  export interface Schema$GoogleCloudDiscoveryengineV1betaProject {
10123
+ /**
10124
+ * Output only. The current status of the project's configurable billing.
10125
+ */
10126
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus;
10064
10127
  /**
10065
10128
  * Output only. The timestamp when this project is created.
10066
10129
  */
@@ -10084,6 +10147,23 @@ export declare namespace discoveryengine_v1beta {
10084
10147
  [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
10085
10148
  } | null;
10086
10149
  }
10150
+ /**
10151
+ * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).
10152
+ */
10153
+ export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus {
10154
+ /**
10155
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
10156
+ */
10157
+ effectiveIndexingCoreThreshold?: string | null;
10158
+ /**
10159
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
10160
+ */
10161
+ effectiveSearchQpmThreshold?: string | null;
10162
+ /**
10163
+ * Optional. The start time of the currently active billing subscription.
10164
+ */
10165
+ startTime?: string | null;
10166
+ }
10087
10167
  /**
10088
10168
  * Customer provided configurations.
10089
10169
  */
@@ -10101,6 +10181,10 @@ export declare namespace discoveryengine_v1beta {
10101
10181
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
10102
10182
  */
10103
10183
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
10184
+ /**
10185
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
10186
+ */
10187
+ optOutNotebookSharing?: boolean | null;
10104
10188
  }
10105
10189
  /**
10106
10190
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -10956,7 +11040,7 @@ export declare namespace discoveryengine_v1beta {
10956
11040
  [key: string]: string;
10957
11041
  } | null;
10958
11042
  /**
10959
- * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
11043
+ * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
10960
11044
  */
10961
11045
  userPseudoId?: string | null;
10962
11046
  }
@@ -12758,6 +12842,31 @@ export declare namespace discoveryengine_v1beta {
12758
12842
  */
12759
12843
  userProfile?: string | null;
12760
12844
  }
12845
+ /**
12846
+ * Configures metadata that is used for End User entities.
12847
+ */
12848
+ export interface Schema$GoogleCloudDiscoveryengineV1betaUserStore {
12849
+ /**
12850
+ * Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
12851
+ */
12852
+ defaultLicenseConfig?: string | null;
12853
+ /**
12854
+ * The display name of the User Store.
12855
+ */
12856
+ displayName?: string | null;
12857
+ /**
12858
+ * Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
12859
+ */
12860
+ enableExpiredLicenseAutoUpdate?: boolean | null;
12861
+ /**
12862
+ * Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
12863
+ */
12864
+ enableLicenseAutoRegister?: boolean | null;
12865
+ /**
12866
+ * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
12867
+ */
12868
+ name?: string | null;
12869
+ }
12761
12870
  /**
12762
12871
  * Config to store data store type configuration for workspace data
12763
12872
  */
@@ -13393,6 +13502,10 @@ export declare namespace discoveryengine_v1beta {
13393
13502
  * Optional. Configuration for configurable billing approach. See
13394
13503
  */
13395
13504
  configurableBillingApproach?: string | null;
13505
+ /**
13506
+ * Output only. The timestamp when configurable_billing_approach was last updated.
13507
+ */
13508
+ configurableBillingApproachUpdateTime?: string | null;
13396
13509
  /**
13397
13510
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
13398
13511
  */
@@ -14266,6 +14379,10 @@ export declare namespace discoveryengine_v1beta {
14266
14379
  * Metadata and configurations for a Google Cloud project in the service.
14267
14380
  */
14268
14381
  export interface Schema$GoogleCloudDiscoveryengineV1Project {
14382
+ /**
14383
+ * Output only. The current status of the project's configurable billing.
14384
+ */
14385
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus;
14269
14386
  /**
14270
14387
  * Output only. The timestamp when this project is created.
14271
14388
  */
@@ -14289,6 +14406,23 @@ export declare namespace discoveryengine_v1beta {
14289
14406
  [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms;
14290
14407
  } | null;
14291
14408
  }
14409
+ /**
14410
+ * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).
14411
+ */
14412
+ export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus {
14413
+ /**
14414
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
14415
+ */
14416
+ effectiveIndexingCoreThreshold?: string | null;
14417
+ /**
14418
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
14419
+ */
14420
+ effectiveSearchQpmThreshold?: string | null;
14421
+ /**
14422
+ * Optional. The start time of the currently active billing subscription.
14423
+ */
14424
+ startTime?: string | null;
14425
+ }
14292
14426
  /**
14293
14427
  * Customer provided configurations.
14294
14428
  */
@@ -14306,6 +14440,10 @@ export declare namespace discoveryengine_v1beta {
14306
14440
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
14307
14441
  */
14308
14442
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
14443
+ /**
14444
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
14445
+ */
14446
+ optOutNotebookSharing?: boolean | null;
14309
14447
  }
14310
14448
  /**
14311
14449
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -14986,6 +15124,31 @@ export declare namespace discoveryengine_v1beta {
14986
15124
  */
14987
15125
  userProfile?: string | null;
14988
15126
  }
15127
+ /**
15128
+ * Configures metadata that is used for End User entities.
15129
+ */
15130
+ export interface Schema$GoogleCloudDiscoveryengineV1UserStore {
15131
+ /**
15132
+ * Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
15133
+ */
15134
+ defaultLicenseConfig?: string | null;
15135
+ /**
15136
+ * The display name of the User Store.
15137
+ */
15138
+ displayName?: string | null;
15139
+ /**
15140
+ * Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
15141
+ */
15142
+ enableExpiredLicenseAutoUpdate?: boolean | null;
15143
+ /**
15144
+ * Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
15145
+ */
15146
+ enableLicenseAutoRegister?: boolean | null;
15147
+ /**
15148
+ * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
15149
+ */
15150
+ name?: string | null;
15151
+ }
14989
15152
  /**
14990
15153
  * Config to store data store type configuration for workspace data
14991
15154
  */
@@ -16626,7 +16789,7 @@ export declare namespace discoveryengine_v1beta {
16626
16789
  * query: 'placeholder-value',
16627
16790
  * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
16628
16791
  * queryModel: 'placeholder-value',
16629
- * // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
16792
+ * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
16630
16793
  * userPseudoId: 'placeholder-value',
16631
16794
  * },
16632
16795
  * );
@@ -16715,6 +16878,7 @@ export declare namespace discoveryengine_v1beta {
16715
16878
  * // "billingEstimation": {},
16716
16879
  * // "cmekConfig": {},
16717
16880
  * // "configurableBillingApproach": "my_configurableBillingApproach",
16881
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
16718
16882
  * // "contentConfig": "my_contentConfig",
16719
16883
  * // "createTime": "my_createTime",
16720
16884
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -16880,6 +17044,7 @@ export declare namespace discoveryengine_v1beta {
16880
17044
  * // "billingEstimation": {},
16881
17045
  * // "cmekConfig": {},
16882
17046
  * // "configurableBillingApproach": "my_configurableBillingApproach",
17047
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
16883
17048
  * // "contentConfig": "my_contentConfig",
16884
17049
  * // "createTime": "my_createTime",
16885
17050
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -17105,6 +17270,7 @@ export declare namespace discoveryengine_v1beta {
17105
17270
  * // "billingEstimation": {},
17106
17271
  * // "cmekConfig": {},
17107
17272
  * // "configurableBillingApproach": "my_configurableBillingApproach",
17273
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
17108
17274
  * // "contentConfig": "my_contentConfig",
17109
17275
  * // "createTime": "my_createTime",
17110
17276
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -17134,6 +17300,7 @@ export declare namespace discoveryengine_v1beta {
17134
17300
  * // "billingEstimation": {},
17135
17301
  * // "cmekConfig": {},
17136
17302
  * // "configurableBillingApproach": "my_configurableBillingApproach",
17303
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
17137
17304
  * // "contentConfig": "my_contentConfig",
17138
17305
  * // "createTime": "my_createTime",
17139
17306
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -17273,7 +17440,7 @@ export declare namespace discoveryengine_v1beta {
17273
17440
  */
17274
17441
  queryModel?: string;
17275
17442
  /**
17276
- * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
17443
+ * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
17277
17444
  */
17278
17445
  userPseudoId?: string;
17279
17446
  }
@@ -28422,7 +28589,7 @@ export declare namespace discoveryengine_v1beta {
28422
28589
  * query: 'placeholder-value',
28423
28590
  * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
28424
28591
  * queryModel: 'placeholder-value',
28425
- * // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
28592
+ * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
28426
28593
  * userPseudoId: 'placeholder-value',
28427
28594
  * },
28428
28595
  * );
@@ -28509,6 +28676,7 @@ export declare namespace discoveryengine_v1beta {
28509
28676
  * // "billingEstimation": {},
28510
28677
  * // "cmekConfig": {},
28511
28678
  * // "configurableBillingApproach": "my_configurableBillingApproach",
28679
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
28512
28680
  * // "contentConfig": "my_contentConfig",
28513
28681
  * // "createTime": "my_createTime",
28514
28682
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -28672,6 +28840,7 @@ export declare namespace discoveryengine_v1beta {
28672
28840
  * // "billingEstimation": {},
28673
28841
  * // "cmekConfig": {},
28674
28842
  * // "configurableBillingApproach": "my_configurableBillingApproach",
28843
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
28675
28844
  * // "contentConfig": "my_contentConfig",
28676
28845
  * // "createTime": "my_createTime",
28677
28846
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -28892,6 +29061,7 @@ export declare namespace discoveryengine_v1beta {
28892
29061
  * // "billingEstimation": {},
28893
29062
  * // "cmekConfig": {},
28894
29063
  * // "configurableBillingApproach": "my_configurableBillingApproach",
29064
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
28895
29065
  * // "contentConfig": "my_contentConfig",
28896
29066
  * // "createTime": "my_createTime",
28897
29067
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -28921,6 +29091,7 @@ export declare namespace discoveryengine_v1beta {
28921
29091
  * // "billingEstimation": {},
28922
29092
  * // "cmekConfig": {},
28923
29093
  * // "configurableBillingApproach": "my_configurableBillingApproach",
29094
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
28924
29095
  * // "contentConfig": "my_contentConfig",
28925
29096
  * // "createTime": "my_createTime",
28926
29097
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -28978,7 +29149,7 @@ export declare namespace discoveryengine_v1beta {
28978
29149
  */
28979
29150
  queryModel?: string;
28980
29151
  /**
28981
- * A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
29152
+ * Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
28982
29153
  */
28983
29154
  userPseudoId?: string;
28984
29155
  }
@@ -38508,6 +38679,302 @@ export declare namespace discoveryengine_v1beta {
38508
38679
  batchUpdateUserLicenses(params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38509
38680
  batchUpdateUserLicenses(params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38510
38681
  batchUpdateUserLicenses(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38682
+ /**
38683
+ * Creates a new User Store.
38684
+ * @example
38685
+ * ```js
38686
+ * // Before running the sample:
38687
+ * // - Enable the API at:
38688
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38689
+ * // - Login into gcloud by running:
38690
+ * // ```sh
38691
+ * // $ gcloud auth application-default login
38692
+ * // ```
38693
+ * // - Install the npm module by running:
38694
+ * // ```sh
38695
+ * // $ npm install googleapis
38696
+ * // ```
38697
+ *
38698
+ * const {google} = require('googleapis');
38699
+ * const discoveryengine = google.discoveryengine('v1beta');
38700
+ *
38701
+ * async function main() {
38702
+ * const auth = new google.auth.GoogleAuth({
38703
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38704
+ * scopes: [
38705
+ * 'https://www.googleapis.com/auth/cloud-platform',
38706
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38707
+ * ],
38708
+ * });
38709
+ *
38710
+ * // Acquire an auth client, and bind it to all future calls
38711
+ * const authClient = await auth.getClient();
38712
+ * google.options({auth: authClient});
38713
+ *
38714
+ * // Do the magic
38715
+ * const res = await discoveryengine.projects.locations.userStores.create({
38716
+ * // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
38717
+ * parent: 'projects/my-project/locations/my-location',
38718
+ * // Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
38719
+ * userStoreId: 'placeholder-value',
38720
+ *
38721
+ * // Request body metadata
38722
+ * requestBody: {
38723
+ * // request body parameters
38724
+ * // {
38725
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
38726
+ * // "displayName": "my_displayName",
38727
+ * // "enableExpiredLicenseAutoUpdate": false,
38728
+ * // "enableLicenseAutoRegister": false,
38729
+ * // "name": "my_name"
38730
+ * // }
38731
+ * },
38732
+ * });
38733
+ * console.log(res.data);
38734
+ *
38735
+ * // Example response
38736
+ * // {
38737
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
38738
+ * // "displayName": "my_displayName",
38739
+ * // "enableExpiredLicenseAutoUpdate": false,
38740
+ * // "enableLicenseAutoRegister": false,
38741
+ * // "name": "my_name"
38742
+ * // }
38743
+ * }
38744
+ *
38745
+ * main().catch(e => {
38746
+ * console.error(e);
38747
+ * throw e;
38748
+ * });
38749
+ *
38750
+ * ```
38751
+ *
38752
+ * @param params - Parameters for request
38753
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38754
+ * @param callback - Optional callback that handles the response.
38755
+ * @returns A promise if used with async/await, or void if used with a callback.
38756
+ */
38757
+ create(params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38758
+ create(params?: Params$Resource$Projects$Locations$Userstores$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>>;
38759
+ create(params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38760
+ create(params: Params$Resource$Projects$Locations$Userstores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38761
+ create(params: Params$Resource$Projects$Locations$Userstores$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38762
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38763
+ /**
38764
+ * Deletes the User Store.
38765
+ * @example
38766
+ * ```js
38767
+ * // Before running the sample:
38768
+ * // - Enable the API at:
38769
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38770
+ * // - Login into gcloud by running:
38771
+ * // ```sh
38772
+ * // $ gcloud auth application-default login
38773
+ * // ```
38774
+ * // - Install the npm module by running:
38775
+ * // ```sh
38776
+ * // $ npm install googleapis
38777
+ * // ```
38778
+ *
38779
+ * const {google} = require('googleapis');
38780
+ * const discoveryengine = google.discoveryengine('v1beta');
38781
+ *
38782
+ * async function main() {
38783
+ * const auth = new google.auth.GoogleAuth({
38784
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38785
+ * scopes: [
38786
+ * 'https://www.googleapis.com/auth/cloud-platform',
38787
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38788
+ * ],
38789
+ * });
38790
+ *
38791
+ * // Acquire an auth client, and bind it to all future calls
38792
+ * const authClient = await auth.getClient();
38793
+ * google.options({auth: authClient});
38794
+ *
38795
+ * // Do the magic
38796
+ * const res = await discoveryengine.projects.locations.userStores.delete({
38797
+ * // Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
38798
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
38799
+ * });
38800
+ * console.log(res.data);
38801
+ *
38802
+ * // Example response
38803
+ * // {
38804
+ * // "done": false,
38805
+ * // "error": {},
38806
+ * // "metadata": {},
38807
+ * // "name": "my_name",
38808
+ * // "response": {}
38809
+ * // }
38810
+ * }
38811
+ *
38812
+ * main().catch(e => {
38813
+ * console.error(e);
38814
+ * throw e;
38815
+ * });
38816
+ *
38817
+ * ```
38818
+ *
38819
+ * @param params - Parameters for request
38820
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38821
+ * @param callback - Optional callback that handles the response.
38822
+ * @returns A promise if used with async/await, or void if used with a callback.
38823
+ */
38824
+ delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38825
+ delete(params?: Params$Resource$Projects$Locations$Userstores$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
38826
+ delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38827
+ delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38828
+ delete(params: Params$Resource$Projects$Locations$Userstores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38829
+ delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38830
+ /**
38831
+ * Gets the User Store.
38832
+ * @example
38833
+ * ```js
38834
+ * // Before running the sample:
38835
+ * // - Enable the API at:
38836
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38837
+ * // - Login into gcloud by running:
38838
+ * // ```sh
38839
+ * // $ gcloud auth application-default login
38840
+ * // ```
38841
+ * // - Install the npm module by running:
38842
+ * // ```sh
38843
+ * // $ npm install googleapis
38844
+ * // ```
38845
+ *
38846
+ * const {google} = require('googleapis');
38847
+ * const discoveryengine = google.discoveryengine('v1beta');
38848
+ *
38849
+ * async function main() {
38850
+ * const auth = new google.auth.GoogleAuth({
38851
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38852
+ * scopes: [
38853
+ * 'https://www.googleapis.com/auth/cloud-platform',
38854
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38855
+ * ],
38856
+ * });
38857
+ *
38858
+ * // Acquire an auth client, and bind it to all future calls
38859
+ * const authClient = await auth.getClient();
38860
+ * google.options({auth: authClient});
38861
+ *
38862
+ * // Do the magic
38863
+ * const res = await discoveryengine.projects.locations.userStores.get({
38864
+ * // Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
38865
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
38866
+ * });
38867
+ * console.log(res.data);
38868
+ *
38869
+ * // Example response
38870
+ * // {
38871
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
38872
+ * // "displayName": "my_displayName",
38873
+ * // "enableExpiredLicenseAutoUpdate": false,
38874
+ * // "enableLicenseAutoRegister": false,
38875
+ * // "name": "my_name"
38876
+ * // }
38877
+ * }
38878
+ *
38879
+ * main().catch(e => {
38880
+ * console.error(e);
38881
+ * throw e;
38882
+ * });
38883
+ *
38884
+ * ```
38885
+ *
38886
+ * @param params - Parameters for request
38887
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38888
+ * @param callback - Optional callback that handles the response.
38889
+ * @returns A promise if used with async/await, or void if used with a callback.
38890
+ */
38891
+ get(params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38892
+ get(params?: Params$Resource$Projects$Locations$Userstores$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>>;
38893
+ get(params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38894
+ get(params: Params$Resource$Projects$Locations$Userstores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38895
+ get(params: Params$Resource$Projects$Locations$Userstores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38896
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38897
+ /**
38898
+ * Updates the User Store.
38899
+ * @example
38900
+ * ```js
38901
+ * // Before running the sample:
38902
+ * // - Enable the API at:
38903
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38904
+ * // - Login into gcloud by running:
38905
+ * // ```sh
38906
+ * // $ gcloud auth application-default login
38907
+ * // ```
38908
+ * // - Install the npm module by running:
38909
+ * // ```sh
38910
+ * // $ npm install googleapis
38911
+ * // ```
38912
+ *
38913
+ * const {google} = require('googleapis');
38914
+ * const discoveryengine = google.discoveryengine('v1beta');
38915
+ *
38916
+ * async function main() {
38917
+ * const auth = new google.auth.GoogleAuth({
38918
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38919
+ * scopes: [
38920
+ * 'https://www.googleapis.com/auth/cloud-platform',
38921
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38922
+ * ],
38923
+ * });
38924
+ *
38925
+ * // Acquire an auth client, and bind it to all future calls
38926
+ * const authClient = await auth.getClient();
38927
+ * google.options({auth: authClient});
38928
+ *
38929
+ * // Do the magic
38930
+ * const res = await discoveryengine.projects.locations.userStores.patch({
38931
+ * // Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
38932
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
38933
+ * // Optional. The list of fields to update.
38934
+ * updateMask: 'placeholder-value',
38935
+ *
38936
+ * // Request body metadata
38937
+ * requestBody: {
38938
+ * // request body parameters
38939
+ * // {
38940
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
38941
+ * // "displayName": "my_displayName",
38942
+ * // "enableExpiredLicenseAutoUpdate": false,
38943
+ * // "enableLicenseAutoRegister": false,
38944
+ * // "name": "my_name"
38945
+ * // }
38946
+ * },
38947
+ * });
38948
+ * console.log(res.data);
38949
+ *
38950
+ * // Example response
38951
+ * // {
38952
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
38953
+ * // "displayName": "my_displayName",
38954
+ * // "enableExpiredLicenseAutoUpdate": false,
38955
+ * // "enableLicenseAutoRegister": false,
38956
+ * // "name": "my_name"
38957
+ * // }
38958
+ * }
38959
+ *
38960
+ * main().catch(e => {
38961
+ * console.error(e);
38962
+ * throw e;
38963
+ * });
38964
+ *
38965
+ * ```
38966
+ *
38967
+ * @param params - Parameters for request
38968
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38969
+ * @param callback - Optional callback that handles the response.
38970
+ * @returns A promise if used with async/await, or void if used with a callback.
38971
+ */
38972
+ patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38973
+ patch(params?: Params$Resource$Projects$Locations$Userstores$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>>;
38974
+ patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38975
+ patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38976
+ patch(params: Params$Resource$Projects$Locations$Userstores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38977
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38511
38978
  }
38512
38979
  export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses extends StandardParameters {
38513
38980
  /**
@@ -38519,6 +38986,46 @@ export declare namespace discoveryengine_v1beta {
38519
38986
  */
38520
38987
  requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest;
38521
38988
  }
38989
+ export interface Params$Resource$Projects$Locations$Userstores$Create extends StandardParameters {
38990
+ /**
38991
+ * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
38992
+ */
38993
+ parent?: string;
38994
+ /**
38995
+ * Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
38996
+ */
38997
+ userStoreId?: string;
38998
+ /**
38999
+ * Request body metadata
39000
+ */
39001
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore;
39002
+ }
39003
+ export interface Params$Resource$Projects$Locations$Userstores$Delete extends StandardParameters {
39004
+ /**
39005
+ * Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
39006
+ */
39007
+ name?: string;
39008
+ }
39009
+ export interface Params$Resource$Projects$Locations$Userstores$Get extends StandardParameters {
39010
+ /**
39011
+ * Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
39012
+ */
39013
+ name?: string;
39014
+ }
39015
+ export interface Params$Resource$Projects$Locations$Userstores$Patch extends StandardParameters {
39016
+ /**
39017
+ * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
39018
+ */
39019
+ name?: string;
39020
+ /**
39021
+ * Optional. The list of fields to update.
39022
+ */
39023
+ updateMask?: string;
39024
+ /**
39025
+ * Request body metadata
39026
+ */
39027
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore;
39028
+ }
38522
39029
  export class Resource$Projects$Locations$Userstores$Userlicenses {
38523
39030
  context: APIRequestContext;
38524
39031
  constructor(context: APIRequestContext);