@googleapis/discoveryengine 26.1.0 → 27.1.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
  */
@@ -2858,6 +2888,10 @@ export declare namespace discoveryengine_v1beta {
2858
2888
  * Optional. If true, the LLM based annotation is added to the image during parsing.
2859
2889
  */
2860
2890
  enableImageAnnotation?: boolean | null;
2891
+ /**
2892
+ * Optional. If true, the pdf layout will be refined using an LLM.
2893
+ */
2894
+ enableLlmLayoutParsing?: boolean | null;
2861
2895
  /**
2862
2896
  * Optional. If true, the LLM based annotation is added to the table during parsing.
2863
2897
  */
@@ -2926,6 +2960,10 @@ export declare namespace discoveryengine_v1beta {
2926
2960
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
2927
2961
  */
2928
2962
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
2963
+ /**
2964
+ * Output only. CMEK-related information for the Engine.
2965
+ */
2966
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
2929
2967
  /**
2930
2968
  * Common config spec that specifies the metadata of the engine.
2931
2969
  */
@@ -2964,6 +3002,12 @@ export declare namespace discoveryengine_v1beta {
2964
3002
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
2965
3003
  */
2966
3004
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
3005
+ /**
3006
+ * Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
3007
+ */
3008
+ modelConfigs?: {
3009
+ [key: string]: string;
3010
+ } | null;
2967
3011
  /**
2968
3012
  * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
2969
3013
  */
@@ -3776,6 +3820,10 @@ export declare namespace discoveryengine_v1beta {
3776
3820
  * Metadata and configurations for a Google Cloud project in the service.
3777
3821
  */
3778
3822
  export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
3823
+ /**
3824
+ * Output only. The current status of the project's configurable billing.
3825
+ */
3826
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus;
3779
3827
  /**
3780
3828
  * Output only. The timestamp when this project is created.
3781
3829
  */
@@ -3799,6 +3847,23 @@ export declare namespace discoveryengine_v1beta {
3799
3847
  [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
3800
3848
  } | null;
3801
3849
  }
3850
+ /**
3851
+ * 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).
3852
+ */
3853
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus {
3854
+ /**
3855
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
3856
+ */
3857
+ effectiveIndexingCoreThreshold?: string | null;
3858
+ /**
3859
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
3860
+ */
3861
+ effectiveSearchQpmThreshold?: string | null;
3862
+ /**
3863
+ * Optional. The start time of the currently active billing subscription.
3864
+ */
3865
+ startTime?: string | null;
3866
+ }
3802
3867
  /**
3803
3868
  * Customer provided configurations.
3804
3869
  */
@@ -3816,6 +3881,10 @@ export declare namespace discoveryengine_v1beta {
3816
3881
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
3817
3882
  */
3818
3883
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
3884
+ /**
3885
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
3886
+ */
3887
+ optOutNotebookSharing?: boolean | null;
3819
3888
  }
3820
3889
  /**
3821
3890
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -4395,7 +4464,7 @@ export declare namespace discoveryengine_v1beta {
4395
4464
  [key: string]: string;
4396
4465
  } | null;
4397
4466
  /**
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.
4467
+ * 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
4468
  */
4400
4469
  userPseudoId?: string | null;
4401
4470
  }
@@ -5539,7 +5608,7 @@ export declare namespace discoveryengine_v1beta {
5539
5608
  */
5540
5609
  userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo;
5541
5610
  /**
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
5611
+ * 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
5612
  */
5544
5613
  userPseudoId?: string | null;
5545
5614
  }
@@ -8171,6 +8240,10 @@ export declare namespace discoveryengine_v1beta {
8171
8240
  * Optional. Configuration for configurable billing approach. See
8172
8241
  */
8173
8242
  configurableBillingApproach?: string | null;
8243
+ /**
8244
+ * Output only. The timestamp when configurable_billing_approach was last updated.
8245
+ */
8246
+ configurableBillingApproachUpdateTime?: string | null;
8174
8247
  /**
8175
8248
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
8176
8249
  */
@@ -8621,6 +8694,10 @@ export declare namespace discoveryengine_v1beta {
8621
8694
  * Optional. If true, the LLM based annotation is added to the image during parsing.
8622
8695
  */
8623
8696
  enableImageAnnotation?: boolean | null;
8697
+ /**
8698
+ * Optional. If true, the pdf layout will be refined using an LLM.
8699
+ */
8700
+ enableLlmLayoutParsing?: boolean | null;
8624
8701
  /**
8625
8702
  * Optional. If true, the LLM based annotation is added to the table during parsing.
8626
8703
  */
@@ -8712,6 +8789,10 @@ export declare namespace discoveryengine_v1beta {
8712
8789
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
8713
8790
  */
8714
8791
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
8792
+ /**
8793
+ * Output only. CMEK-related information for the Engine.
8794
+ */
8795
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
8715
8796
  /**
8716
8797
  * Common config spec that specifies the metadata of the engine.
8717
8798
  */
@@ -8750,6 +8831,12 @@ export declare namespace discoveryengine_v1beta {
8750
8831
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
8751
8832
  */
8752
8833
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
8834
+ /**
8835
+ * Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
8836
+ */
8837
+ modelConfigs?: {
8838
+ [key: string]: string;
8839
+ } | null;
8753
8840
  /**
8754
8841
  * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
8755
8842
  */
@@ -9681,6 +9768,19 @@ export declare namespace discoveryengine_v1beta {
9681
9768
  */
9682
9769
  subscriptionTier?: string | null;
9683
9770
  }
9771
+ /**
9772
+ * Stats about users' licenses.
9773
+ */
9774
+ export interface Schema$GoogleCloudDiscoveryengineV1betaLicenseConfigUsageStats {
9775
+ /**
9776
+ * Required. The LicenseConfig name.
9777
+ */
9778
+ licenseConfig?: string | null;
9779
+ /**
9780
+ * Required. The number of licenses used.
9781
+ */
9782
+ usedLicenseCount?: string | null;
9783
+ }
9684
9784
  /**
9685
9785
  * Response message for CmekConfigService.ListCmekConfigs method.
9686
9786
  */
@@ -9829,6 +9929,15 @@ export declare namespace discoveryengine_v1beta {
9829
9929
  */
9830
9930
  nextPageToken?: string | null;
9831
9931
  }
9932
+ /**
9933
+ * Response message for UserLicenseService.ListLicenseConfigUsageStats method.
9934
+ */
9935
+ export interface Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse {
9936
+ /**
9937
+ * All the customer's LicenseConfigUsageStats.
9938
+ */
9939
+ licenseConfigUsageStats?: Schema$GoogleCloudDiscoveryengineV1betaLicenseConfigUsageStats[];
9940
+ }
9832
9941
  /**
9833
9942
  * Response message for SampleQueryService.ListSampleQueries method.
9834
9943
  */
@@ -10061,6 +10170,10 @@ export declare namespace discoveryengine_v1beta {
10061
10170
  * Metadata and configurations for a Google Cloud project in the service.
10062
10171
  */
10063
10172
  export interface Schema$GoogleCloudDiscoveryengineV1betaProject {
10173
+ /**
10174
+ * Output only. The current status of the project's configurable billing.
10175
+ */
10176
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus;
10064
10177
  /**
10065
10178
  * Output only. The timestamp when this project is created.
10066
10179
  */
@@ -10084,6 +10197,23 @@ export declare namespace discoveryengine_v1beta {
10084
10197
  [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
10085
10198
  } | null;
10086
10199
  }
10200
+ /**
10201
+ * 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).
10202
+ */
10203
+ export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus {
10204
+ /**
10205
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
10206
+ */
10207
+ effectiveIndexingCoreThreshold?: string | null;
10208
+ /**
10209
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
10210
+ */
10211
+ effectiveSearchQpmThreshold?: string | null;
10212
+ /**
10213
+ * Optional. The start time of the currently active billing subscription.
10214
+ */
10215
+ startTime?: string | null;
10216
+ }
10087
10217
  /**
10088
10218
  * Customer provided configurations.
10089
10219
  */
@@ -10101,6 +10231,10 @@ export declare namespace discoveryengine_v1beta {
10101
10231
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
10102
10232
  */
10103
10233
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
10234
+ /**
10235
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
10236
+ */
10237
+ optOutNotebookSharing?: boolean | null;
10104
10238
  }
10105
10239
  /**
10106
10240
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -10956,7 +11090,7 @@ export declare namespace discoveryengine_v1beta {
10956
11090
  [key: string]: string;
10957
11091
  } | null;
10958
11092
  /**
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.
11093
+ * 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
11094
  */
10961
11095
  userPseudoId?: string | null;
10962
11096
  }
@@ -12758,6 +12892,31 @@ export declare namespace discoveryengine_v1beta {
12758
12892
  */
12759
12893
  userProfile?: string | null;
12760
12894
  }
12895
+ /**
12896
+ * Configures metadata that is used for End User entities.
12897
+ */
12898
+ export interface Schema$GoogleCloudDiscoveryengineV1betaUserStore {
12899
+ /**
12900
+ * 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.
12901
+ */
12902
+ defaultLicenseConfig?: string | null;
12903
+ /**
12904
+ * The display name of the User Store.
12905
+ */
12906
+ displayName?: string | null;
12907
+ /**
12908
+ * 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.
12909
+ */
12910
+ enableExpiredLicenseAutoUpdate?: boolean | null;
12911
+ /**
12912
+ * 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.
12913
+ */
12914
+ enableLicenseAutoRegister?: boolean | null;
12915
+ /**
12916
+ * 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.
12917
+ */
12918
+ name?: string | null;
12919
+ }
12761
12920
  /**
12762
12921
  * Config to store data store type configuration for workspace data
12763
12922
  */
@@ -13393,6 +13552,10 @@ export declare namespace discoveryengine_v1beta {
13393
13552
  * Optional. Configuration for configurable billing approach. See
13394
13553
  */
13395
13554
  configurableBillingApproach?: string | null;
13555
+ /**
13556
+ * Output only. The timestamp when configurable_billing_approach was last updated.
13557
+ */
13558
+ configurableBillingApproachUpdateTime?: string | null;
13396
13559
  /**
13397
13560
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
13398
13561
  */
@@ -13729,6 +13892,10 @@ export declare namespace discoveryengine_v1beta {
13729
13892
  * Optional. If true, the LLM based annotation is added to the image during parsing.
13730
13893
  */
13731
13894
  enableImageAnnotation?: boolean | null;
13895
+ /**
13896
+ * Optional. If true, the pdf layout will be refined using an LLM.
13897
+ */
13898
+ enableLlmLayoutParsing?: boolean | null;
13732
13899
  /**
13733
13900
  * Optional. If true, the LLM based annotation is added to the table during parsing.
13734
13901
  */
@@ -13797,6 +13964,10 @@ export declare namespace discoveryengine_v1beta {
13797
13964
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
13798
13965
  */
13799
13966
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
13967
+ /**
13968
+ * Output only. CMEK-related information for the Engine.
13969
+ */
13970
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
13800
13971
  /**
13801
13972
  * Common config spec that specifies the metadata of the engine.
13802
13973
  */
@@ -13835,6 +14006,12 @@ export declare namespace discoveryengine_v1beta {
13835
14006
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
13836
14007
  */
13837
14008
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
14009
+ /**
14010
+ * Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
14011
+ */
14012
+ modelConfigs?: {
14013
+ [key: string]: string;
14014
+ } | null;
13838
14015
  /**
13839
14016
  * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
13840
14017
  */
@@ -14266,6 +14443,10 @@ export declare namespace discoveryengine_v1beta {
14266
14443
  * Metadata and configurations for a Google Cloud project in the service.
14267
14444
  */
14268
14445
  export interface Schema$GoogleCloudDiscoveryengineV1Project {
14446
+ /**
14447
+ * Output only. The current status of the project's configurable billing.
14448
+ */
14449
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus;
14269
14450
  /**
14270
14451
  * Output only. The timestamp when this project is created.
14271
14452
  */
@@ -14289,6 +14470,23 @@ export declare namespace discoveryengine_v1beta {
14289
14470
  [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms;
14290
14471
  } | null;
14291
14472
  }
14473
+ /**
14474
+ * 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).
14475
+ */
14476
+ export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus {
14477
+ /**
14478
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
14479
+ */
14480
+ effectiveIndexingCoreThreshold?: string | null;
14481
+ /**
14482
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
14483
+ */
14484
+ effectiveSearchQpmThreshold?: string | null;
14485
+ /**
14486
+ * Optional. The start time of the currently active billing subscription.
14487
+ */
14488
+ startTime?: string | null;
14489
+ }
14292
14490
  /**
14293
14491
  * Customer provided configurations.
14294
14492
  */
@@ -14306,6 +14504,10 @@ export declare namespace discoveryengine_v1beta {
14306
14504
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
14307
14505
  */
14308
14506
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
14507
+ /**
14508
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
14509
+ */
14510
+ optOutNotebookSharing?: boolean | null;
14309
14511
  }
14310
14512
  /**
14311
14513
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -14986,6 +15188,31 @@ export declare namespace discoveryengine_v1beta {
14986
15188
  */
14987
15189
  userProfile?: string | null;
14988
15190
  }
15191
+ /**
15192
+ * Configures metadata that is used for End User entities.
15193
+ */
15194
+ export interface Schema$GoogleCloudDiscoveryengineV1UserStore {
15195
+ /**
15196
+ * 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.
15197
+ */
15198
+ defaultLicenseConfig?: string | null;
15199
+ /**
15200
+ * The display name of the User Store.
15201
+ */
15202
+ displayName?: string | null;
15203
+ /**
15204
+ * 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.
15205
+ */
15206
+ enableExpiredLicenseAutoUpdate?: boolean | null;
15207
+ /**
15208
+ * 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.
15209
+ */
15210
+ enableLicenseAutoRegister?: boolean | null;
15211
+ /**
15212
+ * 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.
15213
+ */
15214
+ name?: string | null;
15215
+ }
14989
15216
  /**
14990
15217
  * Config to store data store type configuration for workspace data
14991
15218
  */
@@ -16626,7 +16853,7 @@ export declare namespace discoveryengine_v1beta {
16626
16853
  * query: 'placeholder-value',
16627
16854
  * // 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
16855
  * 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.
16856
+ * // 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
16857
  * userPseudoId: 'placeholder-value',
16631
16858
  * },
16632
16859
  * );
@@ -16715,6 +16942,7 @@ export declare namespace discoveryengine_v1beta {
16715
16942
  * // "billingEstimation": {},
16716
16943
  * // "cmekConfig": {},
16717
16944
  * // "configurableBillingApproach": "my_configurableBillingApproach",
16945
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
16718
16946
  * // "contentConfig": "my_contentConfig",
16719
16947
  * // "createTime": "my_createTime",
16720
16948
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -16880,6 +17108,7 @@ export declare namespace discoveryengine_v1beta {
16880
17108
  * // "billingEstimation": {},
16881
17109
  * // "cmekConfig": {},
16882
17110
  * // "configurableBillingApproach": "my_configurableBillingApproach",
17111
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
16883
17112
  * // "contentConfig": "my_contentConfig",
16884
17113
  * // "createTime": "my_createTime",
16885
17114
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -17105,6 +17334,7 @@ export declare namespace discoveryengine_v1beta {
17105
17334
  * // "billingEstimation": {},
17106
17335
  * // "cmekConfig": {},
17107
17336
  * // "configurableBillingApproach": "my_configurableBillingApproach",
17337
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
17108
17338
  * // "contentConfig": "my_contentConfig",
17109
17339
  * // "createTime": "my_createTime",
17110
17340
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -17134,6 +17364,7 @@ export declare namespace discoveryengine_v1beta {
17134
17364
  * // "billingEstimation": {},
17135
17365
  * // "cmekConfig": {},
17136
17366
  * // "configurableBillingApproach": "my_configurableBillingApproach",
17367
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
17137
17368
  * // "contentConfig": "my_contentConfig",
17138
17369
  * // "createTime": "my_createTime",
17139
17370
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -17273,7 +17504,7 @@ export declare namespace discoveryengine_v1beta {
17273
17504
  */
17274
17505
  queryModel?: string;
17275
17506
  /**
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.
17507
+ * 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
17508
  */
17278
17509
  userPseudoId?: string;
17279
17510
  }
@@ -24406,6 +24637,7 @@ export declare namespace discoveryengine_v1beta {
24406
24637
  * // "appType": "my_appType",
24407
24638
  * // "chatEngineConfig": {},
24408
24639
  * // "chatEngineMetadata": {},
24640
+ * // "cmekConfig": {},
24409
24641
  * // "commonConfig": {},
24410
24642
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24411
24643
  * // "createTime": "my_createTime",
@@ -24415,6 +24647,7 @@ export declare namespace discoveryengine_v1beta {
24415
24647
  * // "features": {},
24416
24648
  * // "industryVertical": "my_industryVertical",
24417
24649
  * // "mediaRecommendationEngineConfig": {},
24650
+ * // "modelConfigs": {},
24418
24651
  * // "name": "my_name",
24419
24652
  * // "searchEngineConfig": {},
24420
24653
  * // "solutionType": "my_solutionType",
@@ -24564,6 +24797,7 @@ export declare namespace discoveryengine_v1beta {
24564
24797
  * // "appType": "my_appType",
24565
24798
  * // "chatEngineConfig": {},
24566
24799
  * // "chatEngineMetadata": {},
24800
+ * // "cmekConfig": {},
24567
24801
  * // "commonConfig": {},
24568
24802
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24569
24803
  * // "createTime": "my_createTime",
@@ -24573,6 +24807,7 @@ export declare namespace discoveryengine_v1beta {
24573
24807
  * // "features": {},
24574
24808
  * // "industryVertical": "my_industryVertical",
24575
24809
  * // "mediaRecommendationEngineConfig": {},
24810
+ * // "modelConfigs": {},
24576
24811
  * // "name": "my_name",
24577
24812
  * // "searchEngineConfig": {},
24578
24813
  * // "solutionType": "my_solutionType",
@@ -24718,6 +24953,7 @@ export declare namespace discoveryengine_v1beta {
24718
24953
  * // "appType": "my_appType",
24719
24954
  * // "chatEngineConfig": {},
24720
24955
  * // "chatEngineMetadata": {},
24956
+ * // "cmekConfig": {},
24721
24957
  * // "commonConfig": {},
24722
24958
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24723
24959
  * // "createTime": "my_createTime",
@@ -24727,6 +24963,7 @@ export declare namespace discoveryengine_v1beta {
24727
24963
  * // "features": {},
24728
24964
  * // "industryVertical": "my_industryVertical",
24729
24965
  * // "mediaRecommendationEngineConfig": {},
24966
+ * // "modelConfigs": {},
24730
24967
  * // "name": "my_name",
24731
24968
  * // "searchEngineConfig": {},
24732
24969
  * // "solutionType": "my_solutionType",
@@ -24741,6 +24978,7 @@ export declare namespace discoveryengine_v1beta {
24741
24978
  * // "appType": "my_appType",
24742
24979
  * // "chatEngineConfig": {},
24743
24980
  * // "chatEngineMetadata": {},
24981
+ * // "cmekConfig": {},
24744
24982
  * // "commonConfig": {},
24745
24983
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24746
24984
  * // "createTime": "my_createTime",
@@ -24750,6 +24988,7 @@ export declare namespace discoveryengine_v1beta {
24750
24988
  * // "features": {},
24751
24989
  * // "industryVertical": "my_industryVertical",
24752
24990
  * // "mediaRecommendationEngineConfig": {},
24991
+ * // "modelConfigs": {},
24753
24992
  * // "name": "my_name",
24754
24993
  * // "searchEngineConfig": {},
24755
24994
  * // "solutionType": "my_solutionType",
@@ -24826,6 +25065,7 @@ export declare namespace discoveryengine_v1beta {
24826
25065
  * // "appType": "my_appType",
24827
25066
  * // "chatEngineConfig": {},
24828
25067
  * // "chatEngineMetadata": {},
25068
+ * // "cmekConfig": {},
24829
25069
  * // "commonConfig": {},
24830
25070
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24831
25071
  * // "createTime": "my_createTime",
@@ -24835,6 +25075,7 @@ export declare namespace discoveryengine_v1beta {
24835
25075
  * // "features": {},
24836
25076
  * // "industryVertical": "my_industryVertical",
24837
25077
  * // "mediaRecommendationEngineConfig": {},
25078
+ * // "modelConfigs": {},
24838
25079
  * // "name": "my_name",
24839
25080
  * // "searchEngineConfig": {},
24840
25081
  * // "solutionType": "my_solutionType",
@@ -24911,6 +25152,7 @@ export declare namespace discoveryengine_v1beta {
24911
25152
  * // "appType": "my_appType",
24912
25153
  * // "chatEngineConfig": {},
24913
25154
  * // "chatEngineMetadata": {},
25155
+ * // "cmekConfig": {},
24914
25156
  * // "commonConfig": {},
24915
25157
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24916
25158
  * // "createTime": "my_createTime",
@@ -24920,6 +25162,7 @@ export declare namespace discoveryengine_v1beta {
24920
25162
  * // "features": {},
24921
25163
  * // "industryVertical": "my_industryVertical",
24922
25164
  * // "mediaRecommendationEngineConfig": {},
25165
+ * // "modelConfigs": {},
24923
25166
  * // "name": "my_name",
24924
25167
  * // "searchEngineConfig": {},
24925
25168
  * // "solutionType": "my_solutionType",
@@ -28422,7 +28665,7 @@ export declare namespace discoveryengine_v1beta {
28422
28665
  * query: 'placeholder-value',
28423
28666
  * // 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
28667
  * 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.
28668
+ * // 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
28669
  * userPseudoId: 'placeholder-value',
28427
28670
  * },
28428
28671
  * );
@@ -28509,6 +28752,7 @@ export declare namespace discoveryengine_v1beta {
28509
28752
  * // "billingEstimation": {},
28510
28753
  * // "cmekConfig": {},
28511
28754
  * // "configurableBillingApproach": "my_configurableBillingApproach",
28755
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
28512
28756
  * // "contentConfig": "my_contentConfig",
28513
28757
  * // "createTime": "my_createTime",
28514
28758
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -28672,6 +28916,7 @@ export declare namespace discoveryengine_v1beta {
28672
28916
  * // "billingEstimation": {},
28673
28917
  * // "cmekConfig": {},
28674
28918
  * // "configurableBillingApproach": "my_configurableBillingApproach",
28919
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
28675
28920
  * // "contentConfig": "my_contentConfig",
28676
28921
  * // "createTime": "my_createTime",
28677
28922
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -28892,6 +29137,7 @@ export declare namespace discoveryengine_v1beta {
28892
29137
  * // "billingEstimation": {},
28893
29138
  * // "cmekConfig": {},
28894
29139
  * // "configurableBillingApproach": "my_configurableBillingApproach",
29140
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
28895
29141
  * // "contentConfig": "my_contentConfig",
28896
29142
  * // "createTime": "my_createTime",
28897
29143
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -28921,6 +29167,7 @@ export declare namespace discoveryengine_v1beta {
28921
29167
  * // "billingEstimation": {},
28922
29168
  * // "cmekConfig": {},
28923
29169
  * // "configurableBillingApproach": "my_configurableBillingApproach",
29170
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
28924
29171
  * // "contentConfig": "my_contentConfig",
28925
29172
  * // "createTime": "my_createTime",
28926
29173
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -28978,7 +29225,7 @@ export declare namespace discoveryengine_v1beta {
28978
29225
  */
28979
29226
  queryModel?: string;
28980
29227
  /**
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.
29228
+ * 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
29229
  */
28983
29230
  userPseudoId?: string;
28984
29231
  }
@@ -38426,6 +38673,7 @@ export declare namespace discoveryengine_v1beta {
38426
38673
  }
38427
38674
  export class Resource$Projects$Locations$Userstores {
38428
38675
  context: APIRequestContext;
38676
+ licenseConfigsUsageStats: Resource$Projects$Locations$Userstores$Licenseconfigsusagestats;
38429
38677
  userLicenses: Resource$Projects$Locations$Userstores$Userlicenses;
38430
38678
  constructor(context: APIRequestContext);
38431
38679
  /**
@@ -38508,6 +38756,302 @@ export declare namespace discoveryengine_v1beta {
38508
38756
  batchUpdateUserLicenses(params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38509
38757
  batchUpdateUserLicenses(params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38510
38758
  batchUpdateUserLicenses(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38759
+ /**
38760
+ * Creates a new User Store.
38761
+ * @example
38762
+ * ```js
38763
+ * // Before running the sample:
38764
+ * // - Enable the API at:
38765
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38766
+ * // - Login into gcloud by running:
38767
+ * // ```sh
38768
+ * // $ gcloud auth application-default login
38769
+ * // ```
38770
+ * // - Install the npm module by running:
38771
+ * // ```sh
38772
+ * // $ npm install googleapis
38773
+ * // ```
38774
+ *
38775
+ * const {google} = require('googleapis');
38776
+ * const discoveryengine = google.discoveryengine('v1beta');
38777
+ *
38778
+ * async function main() {
38779
+ * const auth = new google.auth.GoogleAuth({
38780
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38781
+ * scopes: [
38782
+ * 'https://www.googleapis.com/auth/cloud-platform',
38783
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38784
+ * ],
38785
+ * });
38786
+ *
38787
+ * // Acquire an auth client, and bind it to all future calls
38788
+ * const authClient = await auth.getClient();
38789
+ * google.options({auth: authClient});
38790
+ *
38791
+ * // Do the magic
38792
+ * const res = await discoveryengine.projects.locations.userStores.create({
38793
+ * // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
38794
+ * parent: 'projects/my-project/locations/my-location',
38795
+ * // 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.
38796
+ * userStoreId: 'placeholder-value',
38797
+ *
38798
+ * // Request body metadata
38799
+ * requestBody: {
38800
+ * // request body parameters
38801
+ * // {
38802
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
38803
+ * // "displayName": "my_displayName",
38804
+ * // "enableExpiredLicenseAutoUpdate": false,
38805
+ * // "enableLicenseAutoRegister": false,
38806
+ * // "name": "my_name"
38807
+ * // }
38808
+ * },
38809
+ * });
38810
+ * console.log(res.data);
38811
+ *
38812
+ * // Example response
38813
+ * // {
38814
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
38815
+ * // "displayName": "my_displayName",
38816
+ * // "enableExpiredLicenseAutoUpdate": false,
38817
+ * // "enableLicenseAutoRegister": false,
38818
+ * // "name": "my_name"
38819
+ * // }
38820
+ * }
38821
+ *
38822
+ * main().catch(e => {
38823
+ * console.error(e);
38824
+ * throw e;
38825
+ * });
38826
+ *
38827
+ * ```
38828
+ *
38829
+ * @param params - Parameters for request
38830
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38831
+ * @param callback - Optional callback that handles the response.
38832
+ * @returns A promise if used with async/await, or void if used with a callback.
38833
+ */
38834
+ create(params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38835
+ create(params?: Params$Resource$Projects$Locations$Userstores$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>>;
38836
+ create(params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38837
+ create(params: Params$Resource$Projects$Locations$Userstores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38838
+ create(params: Params$Resource$Projects$Locations$Userstores$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38839
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38840
+ /**
38841
+ * Deletes the User Store.
38842
+ * @example
38843
+ * ```js
38844
+ * // Before running the sample:
38845
+ * // - Enable the API at:
38846
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38847
+ * // - Login into gcloud by running:
38848
+ * // ```sh
38849
+ * // $ gcloud auth application-default login
38850
+ * // ```
38851
+ * // - Install the npm module by running:
38852
+ * // ```sh
38853
+ * // $ npm install googleapis
38854
+ * // ```
38855
+ *
38856
+ * const {google} = require('googleapis');
38857
+ * const discoveryengine = google.discoveryengine('v1beta');
38858
+ *
38859
+ * async function main() {
38860
+ * const auth = new google.auth.GoogleAuth({
38861
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38862
+ * scopes: [
38863
+ * 'https://www.googleapis.com/auth/cloud-platform',
38864
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38865
+ * ],
38866
+ * });
38867
+ *
38868
+ * // Acquire an auth client, and bind it to all future calls
38869
+ * const authClient = await auth.getClient();
38870
+ * google.options({auth: authClient});
38871
+ *
38872
+ * // Do the magic
38873
+ * const res = await discoveryengine.projects.locations.userStores.delete({
38874
+ * // Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
38875
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
38876
+ * });
38877
+ * console.log(res.data);
38878
+ *
38879
+ * // Example response
38880
+ * // {
38881
+ * // "done": false,
38882
+ * // "error": {},
38883
+ * // "metadata": {},
38884
+ * // "name": "my_name",
38885
+ * // "response": {}
38886
+ * // }
38887
+ * }
38888
+ *
38889
+ * main().catch(e => {
38890
+ * console.error(e);
38891
+ * throw e;
38892
+ * });
38893
+ *
38894
+ * ```
38895
+ *
38896
+ * @param params - Parameters for request
38897
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38898
+ * @param callback - Optional callback that handles the response.
38899
+ * @returns A promise if used with async/await, or void if used with a callback.
38900
+ */
38901
+ delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38902
+ delete(params?: Params$Resource$Projects$Locations$Userstores$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
38903
+ delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38904
+ delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38905
+ delete(params: Params$Resource$Projects$Locations$Userstores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38906
+ delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38907
+ /**
38908
+ * Gets the User Store.
38909
+ * @example
38910
+ * ```js
38911
+ * // Before running the sample:
38912
+ * // - Enable the API at:
38913
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38914
+ * // - Login into gcloud by running:
38915
+ * // ```sh
38916
+ * // $ gcloud auth application-default login
38917
+ * // ```
38918
+ * // - Install the npm module by running:
38919
+ * // ```sh
38920
+ * // $ npm install googleapis
38921
+ * // ```
38922
+ *
38923
+ * const {google} = require('googleapis');
38924
+ * const discoveryengine = google.discoveryengine('v1beta');
38925
+ *
38926
+ * async function main() {
38927
+ * const auth = new google.auth.GoogleAuth({
38928
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38929
+ * scopes: [
38930
+ * 'https://www.googleapis.com/auth/cloud-platform',
38931
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38932
+ * ],
38933
+ * });
38934
+ *
38935
+ * // Acquire an auth client, and bind it to all future calls
38936
+ * const authClient = await auth.getClient();
38937
+ * google.options({auth: authClient});
38938
+ *
38939
+ * // Do the magic
38940
+ * const res = await discoveryengine.projects.locations.userStores.get({
38941
+ * // Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
38942
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
38943
+ * });
38944
+ * console.log(res.data);
38945
+ *
38946
+ * // Example response
38947
+ * // {
38948
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
38949
+ * // "displayName": "my_displayName",
38950
+ * // "enableExpiredLicenseAutoUpdate": false,
38951
+ * // "enableLicenseAutoRegister": false,
38952
+ * // "name": "my_name"
38953
+ * // }
38954
+ * }
38955
+ *
38956
+ * main().catch(e => {
38957
+ * console.error(e);
38958
+ * throw e;
38959
+ * });
38960
+ *
38961
+ * ```
38962
+ *
38963
+ * @param params - Parameters for request
38964
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38965
+ * @param callback - Optional callback that handles the response.
38966
+ * @returns A promise if used with async/await, or void if used with a callback.
38967
+ */
38968
+ get(params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38969
+ get(params?: Params$Resource$Projects$Locations$Userstores$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>>;
38970
+ get(params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38971
+ get(params: Params$Resource$Projects$Locations$Userstores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38972
+ get(params: Params$Resource$Projects$Locations$Userstores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38973
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38974
+ /**
38975
+ * Updates the User Store.
38976
+ * @example
38977
+ * ```js
38978
+ * // Before running the sample:
38979
+ * // - Enable the API at:
38980
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38981
+ * // - Login into gcloud by running:
38982
+ * // ```sh
38983
+ * // $ gcloud auth application-default login
38984
+ * // ```
38985
+ * // - Install the npm module by running:
38986
+ * // ```sh
38987
+ * // $ npm install googleapis
38988
+ * // ```
38989
+ *
38990
+ * const {google} = require('googleapis');
38991
+ * const discoveryengine = google.discoveryengine('v1beta');
38992
+ *
38993
+ * async function main() {
38994
+ * const auth = new google.auth.GoogleAuth({
38995
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38996
+ * scopes: [
38997
+ * 'https://www.googleapis.com/auth/cloud-platform',
38998
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38999
+ * ],
39000
+ * });
39001
+ *
39002
+ * // Acquire an auth client, and bind it to all future calls
39003
+ * const authClient = await auth.getClient();
39004
+ * google.options({auth: authClient});
39005
+ *
39006
+ * // Do the magic
39007
+ * const res = await discoveryengine.projects.locations.userStores.patch({
39008
+ * // 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.
39009
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
39010
+ * // Optional. The list of fields to update.
39011
+ * updateMask: 'placeholder-value',
39012
+ *
39013
+ * // Request body metadata
39014
+ * requestBody: {
39015
+ * // request body parameters
39016
+ * // {
39017
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
39018
+ * // "displayName": "my_displayName",
39019
+ * // "enableExpiredLicenseAutoUpdate": false,
39020
+ * // "enableLicenseAutoRegister": false,
39021
+ * // "name": "my_name"
39022
+ * // }
39023
+ * },
39024
+ * });
39025
+ * console.log(res.data);
39026
+ *
39027
+ * // Example response
39028
+ * // {
39029
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
39030
+ * // "displayName": "my_displayName",
39031
+ * // "enableExpiredLicenseAutoUpdate": false,
39032
+ * // "enableLicenseAutoRegister": false,
39033
+ * // "name": "my_name"
39034
+ * // }
39035
+ * }
39036
+ *
39037
+ * main().catch(e => {
39038
+ * console.error(e);
39039
+ * throw e;
39040
+ * });
39041
+ *
39042
+ * ```
39043
+ *
39044
+ * @param params - Parameters for request
39045
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
39046
+ * @param callback - Optional callback that handles the response.
39047
+ * @returns A promise if used with async/await, or void if used with a callback.
39048
+ */
39049
+ patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
39050
+ patch(params?: Params$Resource$Projects$Locations$Userstores$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>>;
39051
+ patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
39052
+ patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
39053
+ patch(params: Params$Resource$Projects$Locations$Userstores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
39054
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>): void;
38511
39055
  }
38512
39056
  export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses extends StandardParameters {
38513
39057
  /**
@@ -38519,6 +39063,123 @@ export declare namespace discoveryengine_v1beta {
38519
39063
  */
38520
39064
  requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest;
38521
39065
  }
39066
+ export interface Params$Resource$Projects$Locations$Userstores$Create extends StandardParameters {
39067
+ /**
39068
+ * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
39069
+ */
39070
+ parent?: string;
39071
+ /**
39072
+ * 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.
39073
+ */
39074
+ userStoreId?: string;
39075
+ /**
39076
+ * Request body metadata
39077
+ */
39078
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore;
39079
+ }
39080
+ export interface Params$Resource$Projects$Locations$Userstores$Delete extends StandardParameters {
39081
+ /**
39082
+ * Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
39083
+ */
39084
+ name?: string;
39085
+ }
39086
+ export interface Params$Resource$Projects$Locations$Userstores$Get extends StandardParameters {
39087
+ /**
39088
+ * Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
39089
+ */
39090
+ name?: string;
39091
+ }
39092
+ export interface Params$Resource$Projects$Locations$Userstores$Patch extends StandardParameters {
39093
+ /**
39094
+ * 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.
39095
+ */
39096
+ name?: string;
39097
+ /**
39098
+ * Optional. The list of fields to update.
39099
+ */
39100
+ updateMask?: string;
39101
+ /**
39102
+ * Request body metadata
39103
+ */
39104
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore;
39105
+ }
39106
+ export class Resource$Projects$Locations$Userstores$Licenseconfigsusagestats {
39107
+ context: APIRequestContext;
39108
+ constructor(context: APIRequestContext);
39109
+ /**
39110
+ * Lists all the LicenseConfigUsageStatss associated with the project.
39111
+ * @example
39112
+ * ```js
39113
+ * // Before running the sample:
39114
+ * // - Enable the API at:
39115
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
39116
+ * // - Login into gcloud by running:
39117
+ * // ```sh
39118
+ * // $ gcloud auth application-default login
39119
+ * // ```
39120
+ * // - Install the npm module by running:
39121
+ * // ```sh
39122
+ * // $ npm install googleapis
39123
+ * // ```
39124
+ *
39125
+ * const {google} = require('googleapis');
39126
+ * const discoveryengine = google.discoveryengine('v1beta');
39127
+ *
39128
+ * async function main() {
39129
+ * const auth = new google.auth.GoogleAuth({
39130
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
39131
+ * scopes: [
39132
+ * 'https://www.googleapis.com/auth/cloud-platform',
39133
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
39134
+ * ],
39135
+ * });
39136
+ *
39137
+ * // Acquire an auth client, and bind it to all future calls
39138
+ * const authClient = await auth.getClient();
39139
+ * google.options({auth: authClient});
39140
+ *
39141
+ * // Do the magic
39142
+ * const res =
39143
+ * await discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list(
39144
+ * {
39145
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
39146
+ * parent:
39147
+ * 'projects/my-project/locations/my-location/userStores/my-userStore',
39148
+ * },
39149
+ * );
39150
+ * console.log(res.data);
39151
+ *
39152
+ * // Example response
39153
+ * // {
39154
+ * // "licenseConfigUsageStats": []
39155
+ * // }
39156
+ * }
39157
+ *
39158
+ * main().catch(e => {
39159
+ * console.error(e);
39160
+ * throw e;
39161
+ * });
39162
+ *
39163
+ * ```
39164
+ *
39165
+ * @param params - Parameters for request
39166
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
39167
+ * @param callback - Optional callback that handles the response.
39168
+ * @returns A promise if used with async/await, or void if used with a callback.
39169
+ */
39170
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
39171
+ list(params?: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>>;
39172
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
39173
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>): void;
39174
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>): void;
39175
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>): void;
39176
+ }
39177
+ export interface Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List extends StandardParameters {
39178
+ /**
39179
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
39180
+ */
39181
+ parent?: string;
39182
+ }
38522
39183
  export class Resource$Projects$Locations$Userstores$Userlicenses {
38523
39184
  context: APIRequestContext;
38524
39185
  constructor(context: APIRequestContext);
@@ -38557,7 +39218,7 @@ export declare namespace discoveryengine_v1beta {
38557
39218
  * // Do the magic
38558
39219
  * const res =
38559
39220
  * await discoveryengine.projects.locations.userStores.userLicenses.list({
38560
- * // Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
39221
+ * // Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
38561
39222
  * filter: 'placeholder-value',
38562
39223
  * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
38563
39224
  * pageSize: 'placeholder-value',
@@ -38597,7 +39258,7 @@ export declare namespace discoveryengine_v1beta {
38597
39258
  }
38598
39259
  export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
38599
39260
  /**
38600
- * Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
39261
+ * Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
38601
39262
  */
38602
39263
  filter?: string;
38603
39264
  /**