@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/v1beta.ts CHANGED
@@ -2490,6 +2490,10 @@ export namespace discoveryengine_v1beta {
2490
2490
  * Optional. Configuration for configurable billing approach. See
2491
2491
  */
2492
2492
  configurableBillingApproach?: string | null;
2493
+ /**
2494
+ * Output only. The timestamp when configurable_billing_approach was last updated.
2495
+ */
2496
+ configurableBillingApproachUpdateTime?: string | null;
2493
2497
  /**
2494
2498
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
2495
2499
  */
@@ -2622,6 +2626,19 @@ export namespace discoveryengine_v1beta {
2622
2626
  */
2623
2627
  userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
2624
2628
  }
2629
+ /**
2630
+ * Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.
2631
+ */
2632
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata {
2633
+ /**
2634
+ * Operation create time.
2635
+ */
2636
+ createTime?: string | null;
2637
+ /**
2638
+ * Operation last update time. If the operation is done, this is also the finish time.
2639
+ */
2640
+ updateTime?: string | null;
2641
+ }
2625
2642
  /**
2626
2643
  * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.
2627
2644
  */
@@ -2735,6 +2752,19 @@ export namespace discoveryengine_v1beta {
2735
2752
  */
2736
2753
  updateTime?: string | null;
2737
2754
  }
2755
+ /**
2756
+ * 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.
2757
+ */
2758
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata {
2759
+ /**
2760
+ * The number of end users under the user store that failed to be deleted.
2761
+ */
2762
+ failureCount?: string | null;
2763
+ /**
2764
+ * The number of end users under the user store that were successfully deleted.
2765
+ */
2766
+ successCount?: string | null;
2767
+ }
2738
2768
  /**
2739
2769
  * Defines target endpoints used to connect to third-party sources.
2740
2770
  */
@@ -3775,6 +3805,10 @@ export namespace discoveryengine_v1beta {
3775
3805
  * Metadata and configurations for a Google Cloud project in the service.
3776
3806
  */
3777
3807
  export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
3808
+ /**
3809
+ * Output only. The current status of the project's configurable billing.
3810
+ */
3811
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus;
3778
3812
  /**
3779
3813
  * Output only. The timestamp when this project is created.
3780
3814
  */
@@ -3800,6 +3834,23 @@ export namespace discoveryengine_v1beta {
3800
3834
  ]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
3801
3835
  } | null;
3802
3836
  }
3837
+ /**
3838
+ * 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).
3839
+ */
3840
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus {
3841
+ /**
3842
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
3843
+ */
3844
+ effectiveIndexingCoreThreshold?: string | null;
3845
+ /**
3846
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
3847
+ */
3848
+ effectiveSearchQpmThreshold?: string | null;
3849
+ /**
3850
+ * Optional. The start time of the currently active billing subscription.
3851
+ */
3852
+ startTime?: string | null;
3853
+ }
3803
3854
  /**
3804
3855
  * Customer provided configurations.
3805
3856
  */
@@ -3817,6 +3868,10 @@ export namespace discoveryengine_v1beta {
3817
3868
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
3818
3869
  */
3819
3870
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
3871
+ /**
3872
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
3873
+ */
3874
+ optOutNotebookSharing?: boolean | null;
3820
3875
  }
3821
3876
  /**
3822
3877
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -4389,7 +4444,7 @@ export namespace discoveryengine_v1beta {
4389
4444
  */
4390
4445
  userLabels?: {[key: string]: string} | null;
4391
4446
  /**
4392
- * 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.
4447
+ * 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.
4393
4448
  */
4394
4449
  userPseudoId?: string | null;
4395
4450
  }
@@ -5526,7 +5581,7 @@ export namespace discoveryengine_v1beta {
5526
5581
  */
5527
5582
  userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo;
5528
5583
  /**
5529
- * 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
5584
+ * 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
5530
5585
  */
5531
5586
  userPseudoId?: string | null;
5532
5587
  }
@@ -8138,6 +8193,10 @@ export namespace discoveryengine_v1beta {
8138
8193
  * Optional. Configuration for configurable billing approach. See
8139
8194
  */
8140
8195
  configurableBillingApproach?: string | null;
8196
+ /**
8197
+ * Output only. The timestamp when configurable_billing_approach was last updated.
8198
+ */
8199
+ configurableBillingApproachUpdateTime?: string | null;
8141
8200
  /**
8142
8201
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
8143
8202
  */
@@ -10014,6 +10073,10 @@ export namespace discoveryengine_v1beta {
10014
10073
  * Metadata and configurations for a Google Cloud project in the service.
10015
10074
  */
10016
10075
  export interface Schema$GoogleCloudDiscoveryengineV1betaProject {
10076
+ /**
10077
+ * Output only. The current status of the project's configurable billing.
10078
+ */
10079
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus;
10017
10080
  /**
10018
10081
  * Output only. The timestamp when this project is created.
10019
10082
  */
@@ -10037,6 +10100,23 @@ export namespace discoveryengine_v1beta {
10037
10100
  [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
10038
10101
  } | null;
10039
10102
  }
10103
+ /**
10104
+ * 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).
10105
+ */
10106
+ export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus {
10107
+ /**
10108
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
10109
+ */
10110
+ effectiveIndexingCoreThreshold?: string | null;
10111
+ /**
10112
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
10113
+ */
10114
+ effectiveSearchQpmThreshold?: string | null;
10115
+ /**
10116
+ * Optional. The start time of the currently active billing subscription.
10117
+ */
10118
+ startTime?: string | null;
10119
+ }
10040
10120
  /**
10041
10121
  * Customer provided configurations.
10042
10122
  */
@@ -10054,6 +10134,10 @@ export namespace discoveryengine_v1beta {
10054
10134
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
10055
10135
  */
10056
10136
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
10137
+ /**
10138
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
10139
+ */
10140
+ optOutNotebookSharing?: boolean | null;
10057
10141
  }
10058
10142
  /**
10059
10143
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -10890,7 +10974,7 @@ export namespace discoveryengine_v1beta {
10890
10974
  */
10891
10975
  userLabels?: {[key: string]: string} | null;
10892
10976
  /**
10893
- * 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.
10977
+ * 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.
10894
10978
  */
10895
10979
  userPseudoId?: string | null;
10896
10980
  }
@@ -12683,6 +12767,31 @@ export namespace discoveryengine_v1beta {
12683
12767
  */
12684
12768
  userProfile?: string | null;
12685
12769
  }
12770
+ /**
12771
+ * Configures metadata that is used for End User entities.
12772
+ */
12773
+ export interface Schema$GoogleCloudDiscoveryengineV1betaUserStore {
12774
+ /**
12775
+ * 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.
12776
+ */
12777
+ defaultLicenseConfig?: string | null;
12778
+ /**
12779
+ * The display name of the User Store.
12780
+ */
12781
+ displayName?: string | null;
12782
+ /**
12783
+ * 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.
12784
+ */
12785
+ enableExpiredLicenseAutoUpdate?: boolean | null;
12786
+ /**
12787
+ * 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.
12788
+ */
12789
+ enableLicenseAutoRegister?: boolean | null;
12790
+ /**
12791
+ * 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.
12792
+ */
12793
+ name?: string | null;
12794
+ }
12686
12795
  /**
12687
12796
  * Config to store data store type configuration for workspace data
12688
12797
  */
@@ -13304,6 +13413,10 @@ export namespace discoveryengine_v1beta {
13304
13413
  * Optional. Configuration for configurable billing approach. See
13305
13414
  */
13306
13415
  configurableBillingApproach?: string | null;
13416
+ /**
13417
+ * Output only. The timestamp when configurable_billing_approach was last updated.
13418
+ */
13419
+ configurableBillingApproachUpdateTime?: string | null;
13307
13420
  /**
13308
13421
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
13309
13422
  */
@@ -14172,6 +14285,10 @@ export namespace discoveryengine_v1beta {
14172
14285
  * Metadata and configurations for a Google Cloud project in the service.
14173
14286
  */
14174
14287
  export interface Schema$GoogleCloudDiscoveryengineV1Project {
14288
+ /**
14289
+ * Output only. The current status of the project's configurable billing.
14290
+ */
14291
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus;
14175
14292
  /**
14176
14293
  * Output only. The timestamp when this project is created.
14177
14294
  */
@@ -14195,6 +14312,23 @@ export namespace discoveryengine_v1beta {
14195
14312
  [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms;
14196
14313
  } | null;
14197
14314
  }
14315
+ /**
14316
+ * 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).
14317
+ */
14318
+ export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus {
14319
+ /**
14320
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
14321
+ */
14322
+ effectiveIndexingCoreThreshold?: string | null;
14323
+ /**
14324
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
14325
+ */
14326
+ effectiveSearchQpmThreshold?: string | null;
14327
+ /**
14328
+ * Optional. The start time of the currently active billing subscription.
14329
+ */
14330
+ startTime?: string | null;
14331
+ }
14198
14332
  /**
14199
14333
  * Customer provided configurations.
14200
14334
  */
@@ -14212,6 +14346,10 @@ export namespace discoveryengine_v1beta {
14212
14346
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
14213
14347
  */
14214
14348
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
14349
+ /**
14350
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
14351
+ */
14352
+ optOutNotebookSharing?: boolean | null;
14215
14353
  }
14216
14354
  /**
14217
14355
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -14886,6 +15024,31 @@ export namespace discoveryengine_v1beta {
14886
15024
  */
14887
15025
  userProfile?: string | null;
14888
15026
  }
15027
+ /**
15028
+ * Configures metadata that is used for End User entities.
15029
+ */
15030
+ export interface Schema$GoogleCloudDiscoveryengineV1UserStore {
15031
+ /**
15032
+ * 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.
15033
+ */
15034
+ defaultLicenseConfig?: string | null;
15035
+ /**
15036
+ * The display name of the User Store.
15037
+ */
15038
+ displayName?: string | null;
15039
+ /**
15040
+ * 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.
15041
+ */
15042
+ enableExpiredLicenseAutoUpdate?: boolean | null;
15043
+ /**
15044
+ * 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.
15045
+ */
15046
+ enableLicenseAutoRegister?: boolean | null;
15047
+ /**
15048
+ * 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.
15049
+ */
15050
+ name?: string | null;
15051
+ }
14889
15052
  /**
14890
15053
  * Config to store data store type configuration for workspace data
14891
15054
  */
@@ -17922,7 +18085,7 @@ export namespace discoveryengine_v1beta {
17922
18085
  * query: 'placeholder-value',
17923
18086
  * // 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.
17924
18087
  * queryModel: 'placeholder-value',
17925
- * // 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.
18088
+ * // 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.
17926
18089
  * userPseudoId: 'placeholder-value',
17927
18090
  * },
17928
18091
  * );
@@ -18100,6 +18263,7 @@ export namespace discoveryengine_v1beta {
18100
18263
  * // "billingEstimation": {},
18101
18264
  * // "cmekConfig": {},
18102
18265
  * // "configurableBillingApproach": "my_configurableBillingApproach",
18266
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
18103
18267
  * // "contentConfig": "my_contentConfig",
18104
18268
  * // "createTime": "my_createTime",
18105
18269
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -18428,6 +18592,7 @@ export namespace discoveryengine_v1beta {
18428
18592
  * // "billingEstimation": {},
18429
18593
  * // "cmekConfig": {},
18430
18594
  * // "configurableBillingApproach": "my_configurableBillingApproach",
18595
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
18431
18596
  * // "contentConfig": "my_contentConfig",
18432
18597
  * // "createTime": "my_createTime",
18433
18598
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -18914,6 +19079,7 @@ export namespace discoveryengine_v1beta {
18914
19079
  * // "billingEstimation": {},
18915
19080
  * // "cmekConfig": {},
18916
19081
  * // "configurableBillingApproach": "my_configurableBillingApproach",
19082
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
18917
19083
  * // "contentConfig": "my_contentConfig",
18918
19084
  * // "createTime": "my_createTime",
18919
19085
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -18943,6 +19109,7 @@ export namespace discoveryengine_v1beta {
18943
19109
  * // "billingEstimation": {},
18944
19110
  * // "cmekConfig": {},
18945
19111
  * // "configurableBillingApproach": "my_configurableBillingApproach",
19112
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
18946
19113
  * // "contentConfig": "my_contentConfig",
18947
19114
  * // "createTime": "my_createTime",
18948
19115
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -19252,7 +19419,7 @@ export namespace discoveryengine_v1beta {
19252
19419
  */
19253
19420
  queryModel?: string;
19254
19421
  /**
19255
- * 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.
19422
+ * 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.
19256
19423
  */
19257
19424
  userPseudoId?: string;
19258
19425
  }
@@ -40809,7 +40976,7 @@ export namespace discoveryengine_v1beta {
40809
40976
  * query: 'placeholder-value',
40810
40977
  * // 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.
40811
40978
  * queryModel: 'placeholder-value',
40812
- * // 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.
40979
+ * // 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.
40813
40980
  * userPseudoId: 'placeholder-value',
40814
40981
  * },
40815
40982
  * );
@@ -40985,6 +41152,7 @@ export namespace discoveryengine_v1beta {
40985
41152
  * // "billingEstimation": {},
40986
41153
  * // "cmekConfig": {},
40987
41154
  * // "configurableBillingApproach": "my_configurableBillingApproach",
41155
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
40988
41156
  * // "contentConfig": "my_contentConfig",
40989
41157
  * // "createTime": "my_createTime",
40990
41158
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -41309,6 +41477,7 @@ export namespace discoveryengine_v1beta {
41309
41477
  * // "billingEstimation": {},
41310
41478
  * // "cmekConfig": {},
41311
41479
  * // "configurableBillingApproach": "my_configurableBillingApproach",
41480
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
41312
41481
  * // "contentConfig": "my_contentConfig",
41313
41482
  * // "createTime": "my_createTime",
41314
41483
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -41788,6 +41957,7 @@ export namespace discoveryengine_v1beta {
41788
41957
  * // "billingEstimation": {},
41789
41958
  * // "cmekConfig": {},
41790
41959
  * // "configurableBillingApproach": "my_configurableBillingApproach",
41960
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
41791
41961
  * // "contentConfig": "my_contentConfig",
41792
41962
  * // "createTime": "my_createTime",
41793
41963
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -41817,6 +41987,7 @@ export namespace discoveryengine_v1beta {
41817
41987
  * // "billingEstimation": {},
41818
41988
  * // "cmekConfig": {},
41819
41989
  * // "configurableBillingApproach": "my_configurableBillingApproach",
41990
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
41820
41991
  * // "contentConfig": "my_contentConfig",
41821
41992
  * // "createTime": "my_createTime",
41822
41993
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -41960,7 +42131,7 @@ export namespace discoveryengine_v1beta {
41960
42131
  */
41961
42132
  queryModel?: string;
41962
42133
  /**
41963
- * 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.
42134
+ * 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.
41964
42135
  */
41965
42136
  userPseudoId?: string;
41966
42137
  }
@@ -60633,6 +60804,639 @@ export namespace discoveryengine_v1beta {
60633
60804
  return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
60634
60805
  }
60635
60806
  }
60807
+
60808
+ /**
60809
+ * Creates a new User Store.
60810
+ * @example
60811
+ * ```js
60812
+ * // Before running the sample:
60813
+ * // - Enable the API at:
60814
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
60815
+ * // - Login into gcloud by running:
60816
+ * // ```sh
60817
+ * // $ gcloud auth application-default login
60818
+ * // ```
60819
+ * // - Install the npm module by running:
60820
+ * // ```sh
60821
+ * // $ npm install googleapis
60822
+ * // ```
60823
+ *
60824
+ * const {google} = require('googleapis');
60825
+ * const discoveryengine = google.discoveryengine('v1beta');
60826
+ *
60827
+ * async function main() {
60828
+ * const auth = new google.auth.GoogleAuth({
60829
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
60830
+ * scopes: [
60831
+ * 'https://www.googleapis.com/auth/cloud-platform',
60832
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
60833
+ * ],
60834
+ * });
60835
+ *
60836
+ * // Acquire an auth client, and bind it to all future calls
60837
+ * const authClient = await auth.getClient();
60838
+ * google.options({auth: authClient});
60839
+ *
60840
+ * // Do the magic
60841
+ * const res = await discoveryengine.projects.locations.userStores.create({
60842
+ * // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
60843
+ * parent: 'projects/my-project/locations/my-location',
60844
+ * // 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.
60845
+ * userStoreId: 'placeholder-value',
60846
+ *
60847
+ * // Request body metadata
60848
+ * requestBody: {
60849
+ * // request body parameters
60850
+ * // {
60851
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
60852
+ * // "displayName": "my_displayName",
60853
+ * // "enableExpiredLicenseAutoUpdate": false,
60854
+ * // "enableLicenseAutoRegister": false,
60855
+ * // "name": "my_name"
60856
+ * // }
60857
+ * },
60858
+ * });
60859
+ * console.log(res.data);
60860
+ *
60861
+ * // Example response
60862
+ * // {
60863
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
60864
+ * // "displayName": "my_displayName",
60865
+ * // "enableExpiredLicenseAutoUpdate": false,
60866
+ * // "enableLicenseAutoRegister": false,
60867
+ * // "name": "my_name"
60868
+ * // }
60869
+ * }
60870
+ *
60871
+ * main().catch(e => {
60872
+ * console.error(e);
60873
+ * throw e;
60874
+ * });
60875
+ *
60876
+ * ```
60877
+ *
60878
+ * @param params - Parameters for request
60879
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
60880
+ * @param callback - Optional callback that handles the response.
60881
+ * @returns A promise if used with async/await, or void if used with a callback.
60882
+ */
60883
+ create(
60884
+ params: Params$Resource$Projects$Locations$Userstores$Create,
60885
+ options: StreamMethodOptions
60886
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
60887
+ create(
60888
+ params?: Params$Resource$Projects$Locations$Userstores$Create,
60889
+ options?: MethodOptions
60890
+ ): Promise<
60891
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60892
+ >;
60893
+ create(
60894
+ params: Params$Resource$Projects$Locations$Userstores$Create,
60895
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
60896
+ callback: BodyResponseCallback<Readable>
60897
+ ): void;
60898
+ create(
60899
+ params: Params$Resource$Projects$Locations$Userstores$Create,
60900
+ options:
60901
+ | MethodOptions
60902
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>,
60903
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60904
+ ): void;
60905
+ create(
60906
+ params: Params$Resource$Projects$Locations$Userstores$Create,
60907
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60908
+ ): void;
60909
+ create(
60910
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60911
+ ): void;
60912
+ create(
60913
+ paramsOrCallback?:
60914
+ | Params$Resource$Projects$Locations$Userstores$Create
60915
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60916
+ | BodyResponseCallback<Readable>,
60917
+ optionsOrCallback?:
60918
+ | MethodOptions
60919
+ | StreamMethodOptions
60920
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60921
+ | BodyResponseCallback<Readable>,
60922
+ callback?:
60923
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60924
+ | BodyResponseCallback<Readable>
60925
+ ):
60926
+ | void
60927
+ | Promise<
60928
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60929
+ >
60930
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
60931
+ let params = (paramsOrCallback ||
60932
+ {}) as Params$Resource$Projects$Locations$Userstores$Create;
60933
+ let options = (optionsOrCallback || {}) as MethodOptions;
60934
+
60935
+ if (typeof paramsOrCallback === 'function') {
60936
+ callback = paramsOrCallback;
60937
+ params = {} as Params$Resource$Projects$Locations$Userstores$Create;
60938
+ options = {};
60939
+ }
60940
+
60941
+ if (typeof optionsOrCallback === 'function') {
60942
+ callback = optionsOrCallback;
60943
+ options = {};
60944
+ }
60945
+
60946
+ const rootUrl =
60947
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
60948
+ const parameters = {
60949
+ options: Object.assign(
60950
+ {
60951
+ url: (rootUrl + '/v1beta/{+parent}/userStores').replace(
60952
+ /([^:]\/)\/+/g,
60953
+ '$1'
60954
+ ),
60955
+ method: 'POST',
60956
+ apiVersion: '',
60957
+ },
60958
+ options
60959
+ ),
60960
+ params,
60961
+ requiredParams: ['parent'],
60962
+ pathParams: ['parent'],
60963
+ context: this.context,
60964
+ };
60965
+ if (callback) {
60966
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
60967
+ parameters,
60968
+ callback as BodyResponseCallback<unknown>
60969
+ );
60970
+ } else {
60971
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
60972
+ parameters
60973
+ );
60974
+ }
60975
+ }
60976
+
60977
+ /**
60978
+ * Deletes the User Store.
60979
+ * @example
60980
+ * ```js
60981
+ * // Before running the sample:
60982
+ * // - Enable the API at:
60983
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
60984
+ * // - Login into gcloud by running:
60985
+ * // ```sh
60986
+ * // $ gcloud auth application-default login
60987
+ * // ```
60988
+ * // - Install the npm module by running:
60989
+ * // ```sh
60990
+ * // $ npm install googleapis
60991
+ * // ```
60992
+ *
60993
+ * const {google} = require('googleapis');
60994
+ * const discoveryengine = google.discoveryengine('v1beta');
60995
+ *
60996
+ * async function main() {
60997
+ * const auth = new google.auth.GoogleAuth({
60998
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
60999
+ * scopes: [
61000
+ * 'https://www.googleapis.com/auth/cloud-platform',
61001
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
61002
+ * ],
61003
+ * });
61004
+ *
61005
+ * // Acquire an auth client, and bind it to all future calls
61006
+ * const authClient = await auth.getClient();
61007
+ * google.options({auth: authClient});
61008
+ *
61009
+ * // Do the magic
61010
+ * const res = await discoveryengine.projects.locations.userStores.delete({
61011
+ * // Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
61012
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
61013
+ * });
61014
+ * console.log(res.data);
61015
+ *
61016
+ * // Example response
61017
+ * // {
61018
+ * // "done": false,
61019
+ * // "error": {},
61020
+ * // "metadata": {},
61021
+ * // "name": "my_name",
61022
+ * // "response": {}
61023
+ * // }
61024
+ * }
61025
+ *
61026
+ * main().catch(e => {
61027
+ * console.error(e);
61028
+ * throw e;
61029
+ * });
61030
+ *
61031
+ * ```
61032
+ *
61033
+ * @param params - Parameters for request
61034
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
61035
+ * @param callback - Optional callback that handles the response.
61036
+ * @returns A promise if used with async/await, or void if used with a callback.
61037
+ */
61038
+ delete(
61039
+ params: Params$Resource$Projects$Locations$Userstores$Delete,
61040
+ options: StreamMethodOptions
61041
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
61042
+ delete(
61043
+ params?: Params$Resource$Projects$Locations$Userstores$Delete,
61044
+ options?: MethodOptions
61045
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
61046
+ delete(
61047
+ params: Params$Resource$Projects$Locations$Userstores$Delete,
61048
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
61049
+ callback: BodyResponseCallback<Readable>
61050
+ ): void;
61051
+ delete(
61052
+ params: Params$Resource$Projects$Locations$Userstores$Delete,
61053
+ options:
61054
+ | MethodOptions
61055
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
61056
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
61057
+ ): void;
61058
+ delete(
61059
+ params: Params$Resource$Projects$Locations$Userstores$Delete,
61060
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
61061
+ ): void;
61062
+ delete(
61063
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
61064
+ ): void;
61065
+ delete(
61066
+ paramsOrCallback?:
61067
+ | Params$Resource$Projects$Locations$Userstores$Delete
61068
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
61069
+ | BodyResponseCallback<Readable>,
61070
+ optionsOrCallback?:
61071
+ | MethodOptions
61072
+ | StreamMethodOptions
61073
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
61074
+ | BodyResponseCallback<Readable>,
61075
+ callback?:
61076
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
61077
+ | BodyResponseCallback<Readable>
61078
+ ):
61079
+ | void
61080
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
61081
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
61082
+ let params = (paramsOrCallback ||
61083
+ {}) as Params$Resource$Projects$Locations$Userstores$Delete;
61084
+ let options = (optionsOrCallback || {}) as MethodOptions;
61085
+
61086
+ if (typeof paramsOrCallback === 'function') {
61087
+ callback = paramsOrCallback;
61088
+ params = {} as Params$Resource$Projects$Locations$Userstores$Delete;
61089
+ options = {};
61090
+ }
61091
+
61092
+ if (typeof optionsOrCallback === 'function') {
61093
+ callback = optionsOrCallback;
61094
+ options = {};
61095
+ }
61096
+
61097
+ const rootUrl =
61098
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
61099
+ const parameters = {
61100
+ options: Object.assign(
61101
+ {
61102
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
61103
+ method: 'DELETE',
61104
+ apiVersion: '',
61105
+ },
61106
+ options
61107
+ ),
61108
+ params,
61109
+ requiredParams: ['name'],
61110
+ pathParams: ['name'],
61111
+ context: this.context,
61112
+ };
61113
+ if (callback) {
61114
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
61115
+ parameters,
61116
+ callback as BodyResponseCallback<unknown>
61117
+ );
61118
+ } else {
61119
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
61120
+ }
61121
+ }
61122
+
61123
+ /**
61124
+ * Gets the User Store.
61125
+ * @example
61126
+ * ```js
61127
+ * // Before running the sample:
61128
+ * // - Enable the API at:
61129
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
61130
+ * // - Login into gcloud by running:
61131
+ * // ```sh
61132
+ * // $ gcloud auth application-default login
61133
+ * // ```
61134
+ * // - Install the npm module by running:
61135
+ * // ```sh
61136
+ * // $ npm install googleapis
61137
+ * // ```
61138
+ *
61139
+ * const {google} = require('googleapis');
61140
+ * const discoveryengine = google.discoveryengine('v1beta');
61141
+ *
61142
+ * async function main() {
61143
+ * const auth = new google.auth.GoogleAuth({
61144
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
61145
+ * scopes: [
61146
+ * 'https://www.googleapis.com/auth/cloud-platform',
61147
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
61148
+ * ],
61149
+ * });
61150
+ *
61151
+ * // Acquire an auth client, and bind it to all future calls
61152
+ * const authClient = await auth.getClient();
61153
+ * google.options({auth: authClient});
61154
+ *
61155
+ * // Do the magic
61156
+ * const res = await discoveryengine.projects.locations.userStores.get({
61157
+ * // Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
61158
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
61159
+ * });
61160
+ * console.log(res.data);
61161
+ *
61162
+ * // Example response
61163
+ * // {
61164
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
61165
+ * // "displayName": "my_displayName",
61166
+ * // "enableExpiredLicenseAutoUpdate": false,
61167
+ * // "enableLicenseAutoRegister": false,
61168
+ * // "name": "my_name"
61169
+ * // }
61170
+ * }
61171
+ *
61172
+ * main().catch(e => {
61173
+ * console.error(e);
61174
+ * throw e;
61175
+ * });
61176
+ *
61177
+ * ```
61178
+ *
61179
+ * @param params - Parameters for request
61180
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
61181
+ * @param callback - Optional callback that handles the response.
61182
+ * @returns A promise if used with async/await, or void if used with a callback.
61183
+ */
61184
+ get(
61185
+ params: Params$Resource$Projects$Locations$Userstores$Get,
61186
+ options: StreamMethodOptions
61187
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
61188
+ get(
61189
+ params?: Params$Resource$Projects$Locations$Userstores$Get,
61190
+ options?: MethodOptions
61191
+ ): Promise<
61192
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61193
+ >;
61194
+ get(
61195
+ params: Params$Resource$Projects$Locations$Userstores$Get,
61196
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
61197
+ callback: BodyResponseCallback<Readable>
61198
+ ): void;
61199
+ get(
61200
+ params: Params$Resource$Projects$Locations$Userstores$Get,
61201
+ options:
61202
+ | MethodOptions
61203
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>,
61204
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61205
+ ): void;
61206
+ get(
61207
+ params: Params$Resource$Projects$Locations$Userstores$Get,
61208
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61209
+ ): void;
61210
+ get(
61211
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61212
+ ): void;
61213
+ get(
61214
+ paramsOrCallback?:
61215
+ | Params$Resource$Projects$Locations$Userstores$Get
61216
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61217
+ | BodyResponseCallback<Readable>,
61218
+ optionsOrCallback?:
61219
+ | MethodOptions
61220
+ | StreamMethodOptions
61221
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61222
+ | BodyResponseCallback<Readable>,
61223
+ callback?:
61224
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61225
+ | BodyResponseCallback<Readable>
61226
+ ):
61227
+ | void
61228
+ | Promise<
61229
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61230
+ >
61231
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
61232
+ let params = (paramsOrCallback ||
61233
+ {}) as Params$Resource$Projects$Locations$Userstores$Get;
61234
+ let options = (optionsOrCallback || {}) as MethodOptions;
61235
+
61236
+ if (typeof paramsOrCallback === 'function') {
61237
+ callback = paramsOrCallback;
61238
+ params = {} as Params$Resource$Projects$Locations$Userstores$Get;
61239
+ options = {};
61240
+ }
61241
+
61242
+ if (typeof optionsOrCallback === 'function') {
61243
+ callback = optionsOrCallback;
61244
+ options = {};
61245
+ }
61246
+
61247
+ const rootUrl =
61248
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
61249
+ const parameters = {
61250
+ options: Object.assign(
61251
+ {
61252
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
61253
+ method: 'GET',
61254
+ apiVersion: '',
61255
+ },
61256
+ options
61257
+ ),
61258
+ params,
61259
+ requiredParams: ['name'],
61260
+ pathParams: ['name'],
61261
+ context: this.context,
61262
+ };
61263
+ if (callback) {
61264
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61265
+ parameters,
61266
+ callback as BodyResponseCallback<unknown>
61267
+ );
61268
+ } else {
61269
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61270
+ parameters
61271
+ );
61272
+ }
61273
+ }
61274
+
61275
+ /**
61276
+ * Updates the User Store.
61277
+ * @example
61278
+ * ```js
61279
+ * // Before running the sample:
61280
+ * // - Enable the API at:
61281
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
61282
+ * // - Login into gcloud by running:
61283
+ * // ```sh
61284
+ * // $ gcloud auth application-default login
61285
+ * // ```
61286
+ * // - Install the npm module by running:
61287
+ * // ```sh
61288
+ * // $ npm install googleapis
61289
+ * // ```
61290
+ *
61291
+ * const {google} = require('googleapis');
61292
+ * const discoveryengine = google.discoveryengine('v1beta');
61293
+ *
61294
+ * async function main() {
61295
+ * const auth = new google.auth.GoogleAuth({
61296
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
61297
+ * scopes: [
61298
+ * 'https://www.googleapis.com/auth/cloud-platform',
61299
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
61300
+ * ],
61301
+ * });
61302
+ *
61303
+ * // Acquire an auth client, and bind it to all future calls
61304
+ * const authClient = await auth.getClient();
61305
+ * google.options({auth: authClient});
61306
+ *
61307
+ * // Do the magic
61308
+ * const res = await discoveryengine.projects.locations.userStores.patch({
61309
+ * // 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.
61310
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
61311
+ * // Optional. The list of fields to update.
61312
+ * updateMask: 'placeholder-value',
61313
+ *
61314
+ * // Request body metadata
61315
+ * requestBody: {
61316
+ * // request body parameters
61317
+ * // {
61318
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
61319
+ * // "displayName": "my_displayName",
61320
+ * // "enableExpiredLicenseAutoUpdate": false,
61321
+ * // "enableLicenseAutoRegister": false,
61322
+ * // "name": "my_name"
61323
+ * // }
61324
+ * },
61325
+ * });
61326
+ * console.log(res.data);
61327
+ *
61328
+ * // Example response
61329
+ * // {
61330
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
61331
+ * // "displayName": "my_displayName",
61332
+ * // "enableExpiredLicenseAutoUpdate": false,
61333
+ * // "enableLicenseAutoRegister": false,
61334
+ * // "name": "my_name"
61335
+ * // }
61336
+ * }
61337
+ *
61338
+ * main().catch(e => {
61339
+ * console.error(e);
61340
+ * throw e;
61341
+ * });
61342
+ *
61343
+ * ```
61344
+ *
61345
+ * @param params - Parameters for request
61346
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
61347
+ * @param callback - Optional callback that handles the response.
61348
+ * @returns A promise if used with async/await, or void if used with a callback.
61349
+ */
61350
+ patch(
61351
+ params: Params$Resource$Projects$Locations$Userstores$Patch,
61352
+ options: StreamMethodOptions
61353
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
61354
+ patch(
61355
+ params?: Params$Resource$Projects$Locations$Userstores$Patch,
61356
+ options?: MethodOptions
61357
+ ): Promise<
61358
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61359
+ >;
61360
+ patch(
61361
+ params: Params$Resource$Projects$Locations$Userstores$Patch,
61362
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
61363
+ callback: BodyResponseCallback<Readable>
61364
+ ): void;
61365
+ patch(
61366
+ params: Params$Resource$Projects$Locations$Userstores$Patch,
61367
+ options:
61368
+ | MethodOptions
61369
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>,
61370
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61371
+ ): void;
61372
+ patch(
61373
+ params: Params$Resource$Projects$Locations$Userstores$Patch,
61374
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61375
+ ): void;
61376
+ patch(
61377
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61378
+ ): void;
61379
+ patch(
61380
+ paramsOrCallback?:
61381
+ | Params$Resource$Projects$Locations$Userstores$Patch
61382
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61383
+ | BodyResponseCallback<Readable>,
61384
+ optionsOrCallback?:
61385
+ | MethodOptions
61386
+ | StreamMethodOptions
61387
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61388
+ | BodyResponseCallback<Readable>,
61389
+ callback?:
61390
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61391
+ | BodyResponseCallback<Readable>
61392
+ ):
61393
+ | void
61394
+ | Promise<
61395
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61396
+ >
61397
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
61398
+ let params = (paramsOrCallback ||
61399
+ {}) as Params$Resource$Projects$Locations$Userstores$Patch;
61400
+ let options = (optionsOrCallback || {}) as MethodOptions;
61401
+
61402
+ if (typeof paramsOrCallback === 'function') {
61403
+ callback = paramsOrCallback;
61404
+ params = {} as Params$Resource$Projects$Locations$Userstores$Patch;
61405
+ options = {};
61406
+ }
61407
+
61408
+ if (typeof optionsOrCallback === 'function') {
61409
+ callback = optionsOrCallback;
61410
+ options = {};
61411
+ }
61412
+
61413
+ const rootUrl =
61414
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
61415
+ const parameters = {
61416
+ options: Object.assign(
61417
+ {
61418
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
61419
+ method: 'PATCH',
61420
+ apiVersion: '',
61421
+ },
61422
+ options
61423
+ ),
61424
+ params,
61425
+ requiredParams: ['name'],
61426
+ pathParams: ['name'],
61427
+ context: this.context,
61428
+ };
61429
+ if (callback) {
61430
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61431
+ parameters,
61432
+ callback as BodyResponseCallback<unknown>
61433
+ );
61434
+ } else {
61435
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61436
+ parameters
61437
+ );
61438
+ }
61439
+ }
60636
61440
  }
60637
61441
 
60638
61442
  export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses
@@ -60647,6 +61451,52 @@ export namespace discoveryengine_v1beta {
60647
61451
  */
60648
61452
  requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest;
60649
61453
  }
61454
+ export interface Params$Resource$Projects$Locations$Userstores$Create
61455
+ extends StandardParameters {
61456
+ /**
61457
+ * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
61458
+ */
61459
+ parent?: string;
61460
+ /**
61461
+ * 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.
61462
+ */
61463
+ userStoreId?: string;
61464
+
61465
+ /**
61466
+ * Request body metadata
61467
+ */
61468
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore;
61469
+ }
61470
+ export interface Params$Resource$Projects$Locations$Userstores$Delete
61471
+ extends StandardParameters {
61472
+ /**
61473
+ * Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
61474
+ */
61475
+ name?: string;
61476
+ }
61477
+ export interface Params$Resource$Projects$Locations$Userstores$Get
61478
+ extends StandardParameters {
61479
+ /**
61480
+ * Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
61481
+ */
61482
+ name?: string;
61483
+ }
61484
+ export interface Params$Resource$Projects$Locations$Userstores$Patch
61485
+ extends StandardParameters {
61486
+ /**
61487
+ * 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.
61488
+ */
61489
+ name?: string;
61490
+ /**
61491
+ * Optional. The list of fields to update.
61492
+ */
61493
+ updateMask?: string;
61494
+
61495
+ /**
61496
+ * Request body metadata
61497
+ */
61498
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore;
61499
+ }
60650
61500
 
60651
61501
  export class Resource$Projects$Locations$Userstores$Userlicenses {
60652
61502
  context: APIRequestContext;