@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/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
  */
@@ -2866,6 +2896,10 @@ export namespace discoveryengine_v1beta {
2866
2896
  * Optional. If true, the LLM based annotation is added to the image during parsing.
2867
2897
  */
2868
2898
  enableImageAnnotation?: boolean | null;
2899
+ /**
2900
+ * Optional. If true, the pdf layout will be refined using an LLM.
2901
+ */
2902
+ enableLlmLayoutParsing?: boolean | null;
2869
2903
  /**
2870
2904
  * Optional. If true, the LLM based annotation is added to the table during parsing.
2871
2905
  */
@@ -2933,6 +2967,10 @@ export namespace discoveryengine_v1beta {
2933
2967
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
2934
2968
  */
2935
2969
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
2970
+ /**
2971
+ * Output only. CMEK-related information for the Engine.
2972
+ */
2973
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
2936
2974
  /**
2937
2975
  * Common config spec that specifies the metadata of the engine.
2938
2976
  */
@@ -2969,6 +3007,10 @@ export namespace discoveryengine_v1beta {
2969
3007
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
2970
3008
  */
2971
3009
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
3010
+ /**
3011
+ * 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.
3012
+ */
3013
+ modelConfigs?: {[key: string]: string} | null;
2972
3014
  /**
2973
3015
  * 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.
2974
3016
  */
@@ -3775,6 +3817,10 @@ export namespace discoveryengine_v1beta {
3775
3817
  * Metadata and configurations for a Google Cloud project in the service.
3776
3818
  */
3777
3819
  export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
3820
+ /**
3821
+ * Output only. The current status of the project's configurable billing.
3822
+ */
3823
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus;
3778
3824
  /**
3779
3825
  * Output only. The timestamp when this project is created.
3780
3826
  */
@@ -3800,6 +3846,23 @@ export namespace discoveryengine_v1beta {
3800
3846
  ]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
3801
3847
  } | null;
3802
3848
  }
3849
+ /**
3850
+ * 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).
3851
+ */
3852
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus {
3853
+ /**
3854
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
3855
+ */
3856
+ effectiveIndexingCoreThreshold?: string | null;
3857
+ /**
3858
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
3859
+ */
3860
+ effectiveSearchQpmThreshold?: string | null;
3861
+ /**
3862
+ * Optional. The start time of the currently active billing subscription.
3863
+ */
3864
+ startTime?: string | null;
3865
+ }
3803
3866
  /**
3804
3867
  * Customer provided configurations.
3805
3868
  */
@@ -3817,6 +3880,10 @@ export namespace discoveryengine_v1beta {
3817
3880
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
3818
3881
  */
3819
3882
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
3883
+ /**
3884
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
3885
+ */
3886
+ optOutNotebookSharing?: boolean | null;
3820
3887
  }
3821
3888
  /**
3822
3889
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -4389,7 +4456,7 @@ export namespace discoveryengine_v1beta {
4389
4456
  */
4390
4457
  userLabels?: {[key: string]: string} | null;
4391
4458
  /**
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.
4459
+ * 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
4460
  */
4394
4461
  userPseudoId?: string | null;
4395
4462
  }
@@ -5526,7 +5593,7 @@ export namespace discoveryengine_v1beta {
5526
5593
  */
5527
5594
  userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo;
5528
5595
  /**
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
5596
+ * 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
5597
  */
5531
5598
  userPseudoId?: string | null;
5532
5599
  }
@@ -8138,6 +8205,10 @@ export namespace discoveryengine_v1beta {
8138
8205
  * Optional. Configuration for configurable billing approach. See
8139
8206
  */
8140
8207
  configurableBillingApproach?: string | null;
8208
+ /**
8209
+ * Output only. The timestamp when configurable_billing_approach was last updated.
8210
+ */
8211
+ configurableBillingApproachUpdateTime?: string | null;
8141
8212
  /**
8142
8213
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
8143
8214
  */
@@ -8583,6 +8654,10 @@ export namespace discoveryengine_v1beta {
8583
8654
  * Optional. If true, the LLM based annotation is added to the image during parsing.
8584
8655
  */
8585
8656
  enableImageAnnotation?: boolean | null;
8657
+ /**
8658
+ * Optional. If true, the pdf layout will be refined using an LLM.
8659
+ */
8660
+ enableLlmLayoutParsing?: boolean | null;
8586
8661
  /**
8587
8662
  * Optional. If true, the LLM based annotation is added to the table during parsing.
8588
8663
  */
@@ -8672,6 +8747,10 @@ export namespace discoveryengine_v1beta {
8672
8747
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
8673
8748
  */
8674
8749
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
8750
+ /**
8751
+ * Output only. CMEK-related information for the Engine.
8752
+ */
8753
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
8675
8754
  /**
8676
8755
  * Common config spec that specifies the metadata of the engine.
8677
8756
  */
@@ -8708,6 +8787,10 @@ export namespace discoveryengine_v1beta {
8708
8787
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
8709
8788
  */
8710
8789
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
8790
+ /**
8791
+ * 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.
8792
+ */
8793
+ modelConfigs?: {[key: string]: string} | null;
8711
8794
  /**
8712
8795
  * 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.
8713
8796
  */
@@ -9635,6 +9718,19 @@ export namespace discoveryengine_v1beta {
9635
9718
  */
9636
9719
  subscriptionTier?: string | null;
9637
9720
  }
9721
+ /**
9722
+ * Stats about users' licenses.
9723
+ */
9724
+ export interface Schema$GoogleCloudDiscoveryengineV1betaLicenseConfigUsageStats {
9725
+ /**
9726
+ * Required. The LicenseConfig name.
9727
+ */
9728
+ licenseConfig?: string | null;
9729
+ /**
9730
+ * Required. The number of licenses used.
9731
+ */
9732
+ usedLicenseCount?: string | null;
9733
+ }
9638
9734
  /**
9639
9735
  * Response message for CmekConfigService.ListCmekConfigs method.
9640
9736
  */
@@ -9783,6 +9879,15 @@ export namespace discoveryengine_v1beta {
9783
9879
  */
9784
9880
  nextPageToken?: string | null;
9785
9881
  }
9882
+ /**
9883
+ * Response message for UserLicenseService.ListLicenseConfigUsageStats method.
9884
+ */
9885
+ export interface Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse {
9886
+ /**
9887
+ * All the customer's LicenseConfigUsageStats.
9888
+ */
9889
+ licenseConfigUsageStats?: Schema$GoogleCloudDiscoveryengineV1betaLicenseConfigUsageStats[];
9890
+ }
9786
9891
  /**
9787
9892
  * Response message for SampleQueryService.ListSampleQueries method.
9788
9893
  */
@@ -10014,6 +10119,10 @@ export namespace discoveryengine_v1beta {
10014
10119
  * Metadata and configurations for a Google Cloud project in the service.
10015
10120
  */
10016
10121
  export interface Schema$GoogleCloudDiscoveryengineV1betaProject {
10122
+ /**
10123
+ * Output only. The current status of the project's configurable billing.
10124
+ */
10125
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus;
10017
10126
  /**
10018
10127
  * Output only. The timestamp when this project is created.
10019
10128
  */
@@ -10037,6 +10146,23 @@ export namespace discoveryengine_v1beta {
10037
10146
  [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
10038
10147
  } | null;
10039
10148
  }
10149
+ /**
10150
+ * 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).
10151
+ */
10152
+ export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus {
10153
+ /**
10154
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
10155
+ */
10156
+ effectiveIndexingCoreThreshold?: string | null;
10157
+ /**
10158
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
10159
+ */
10160
+ effectiveSearchQpmThreshold?: string | null;
10161
+ /**
10162
+ * Optional. The start time of the currently active billing subscription.
10163
+ */
10164
+ startTime?: string | null;
10165
+ }
10040
10166
  /**
10041
10167
  * Customer provided configurations.
10042
10168
  */
@@ -10054,6 +10180,10 @@ export namespace discoveryengine_v1beta {
10054
10180
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
10055
10181
  */
10056
10182
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
10183
+ /**
10184
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
10185
+ */
10186
+ optOutNotebookSharing?: boolean | null;
10057
10187
  }
10058
10188
  /**
10059
10189
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -10890,7 +11020,7 @@ export namespace discoveryengine_v1beta {
10890
11020
  */
10891
11021
  userLabels?: {[key: string]: string} | null;
10892
11022
  /**
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.
11023
+ * 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
11024
  */
10895
11025
  userPseudoId?: string | null;
10896
11026
  }
@@ -12683,6 +12813,31 @@ export namespace discoveryengine_v1beta {
12683
12813
  */
12684
12814
  userProfile?: string | null;
12685
12815
  }
12816
+ /**
12817
+ * Configures metadata that is used for End User entities.
12818
+ */
12819
+ export interface Schema$GoogleCloudDiscoveryengineV1betaUserStore {
12820
+ /**
12821
+ * 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.
12822
+ */
12823
+ defaultLicenseConfig?: string | null;
12824
+ /**
12825
+ * The display name of the User Store.
12826
+ */
12827
+ displayName?: string | null;
12828
+ /**
12829
+ * 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.
12830
+ */
12831
+ enableExpiredLicenseAutoUpdate?: boolean | null;
12832
+ /**
12833
+ * 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.
12834
+ */
12835
+ enableLicenseAutoRegister?: boolean | null;
12836
+ /**
12837
+ * 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.
12838
+ */
12839
+ name?: string | null;
12840
+ }
12686
12841
  /**
12687
12842
  * Config to store data store type configuration for workspace data
12688
12843
  */
@@ -13304,6 +13459,10 @@ export namespace discoveryengine_v1beta {
13304
13459
  * Optional. Configuration for configurable billing approach. See
13305
13460
  */
13306
13461
  configurableBillingApproach?: string | null;
13462
+ /**
13463
+ * Output only. The timestamp when configurable_billing_approach was last updated.
13464
+ */
13465
+ configurableBillingApproachUpdateTime?: string | null;
13307
13466
  /**
13308
13467
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
13309
13468
  */
@@ -13638,6 +13797,10 @@ export namespace discoveryengine_v1beta {
13638
13797
  * Optional. If true, the LLM based annotation is added to the image during parsing.
13639
13798
  */
13640
13799
  enableImageAnnotation?: boolean | null;
13800
+ /**
13801
+ * Optional. If true, the pdf layout will be refined using an LLM.
13802
+ */
13803
+ enableLlmLayoutParsing?: boolean | null;
13641
13804
  /**
13642
13805
  * Optional. If true, the LLM based annotation is added to the table during parsing.
13643
13806
  */
@@ -13705,6 +13868,10 @@ export namespace discoveryengine_v1beta {
13705
13868
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
13706
13869
  */
13707
13870
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
13871
+ /**
13872
+ * Output only. CMEK-related information for the Engine.
13873
+ */
13874
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
13708
13875
  /**
13709
13876
  * Common config spec that specifies the metadata of the engine.
13710
13877
  */
@@ -13741,6 +13908,10 @@ export namespace discoveryengine_v1beta {
13741
13908
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
13742
13909
  */
13743
13910
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
13911
+ /**
13912
+ * 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.
13913
+ */
13914
+ modelConfigs?: {[key: string]: string} | null;
13744
13915
  /**
13745
13916
  * 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.
13746
13917
  */
@@ -14172,6 +14343,10 @@ export namespace discoveryengine_v1beta {
14172
14343
  * Metadata and configurations for a Google Cloud project in the service.
14173
14344
  */
14174
14345
  export interface Schema$GoogleCloudDiscoveryengineV1Project {
14346
+ /**
14347
+ * Output only. The current status of the project's configurable billing.
14348
+ */
14349
+ configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus;
14175
14350
  /**
14176
14351
  * Output only. The timestamp when this project is created.
14177
14352
  */
@@ -14195,6 +14370,23 @@ export namespace discoveryengine_v1beta {
14195
14370
  [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms;
14196
14371
  } | null;
14197
14372
  }
14373
+ /**
14374
+ * 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).
14375
+ */
14376
+ export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus {
14377
+ /**
14378
+ * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
14379
+ */
14380
+ effectiveIndexingCoreThreshold?: string | null;
14381
+ /**
14382
+ * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
14383
+ */
14384
+ effectiveSearchQpmThreshold?: string | null;
14385
+ /**
14386
+ * Optional. The start time of the currently active billing subscription.
14387
+ */
14388
+ startTime?: string | null;
14389
+ }
14198
14390
  /**
14199
14391
  * Customer provided configurations.
14200
14392
  */
@@ -14212,6 +14404,10 @@ export namespace discoveryengine_v1beta {
14212
14404
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
14213
14405
  */
14214
14406
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
14407
+ /**
14408
+ * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
14409
+ */
14410
+ optOutNotebookSharing?: boolean | null;
14215
14411
  }
14216
14412
  /**
14217
14413
  * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
@@ -14886,6 +15082,31 @@ export namespace discoveryengine_v1beta {
14886
15082
  */
14887
15083
  userProfile?: string | null;
14888
15084
  }
15085
+ /**
15086
+ * Configures metadata that is used for End User entities.
15087
+ */
15088
+ export interface Schema$GoogleCloudDiscoveryengineV1UserStore {
15089
+ /**
15090
+ * 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.
15091
+ */
15092
+ defaultLicenseConfig?: string | null;
15093
+ /**
15094
+ * The display name of the User Store.
15095
+ */
15096
+ displayName?: string | null;
15097
+ /**
15098
+ * 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.
15099
+ */
15100
+ enableExpiredLicenseAutoUpdate?: boolean | null;
15101
+ /**
15102
+ * 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.
15103
+ */
15104
+ enableLicenseAutoRegister?: boolean | null;
15105
+ /**
15106
+ * 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.
15107
+ */
15108
+ name?: string | null;
15109
+ }
14889
15110
  /**
14890
15111
  * Config to store data store type configuration for workspace data
14891
15112
  */
@@ -17922,7 +18143,7 @@ export namespace discoveryengine_v1beta {
17922
18143
  * query: 'placeholder-value',
17923
18144
  * // 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
18145
  * 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.
18146
+ * // 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
18147
  * userPseudoId: 'placeholder-value',
17927
18148
  * },
17928
18149
  * );
@@ -18100,6 +18321,7 @@ export namespace discoveryengine_v1beta {
18100
18321
  * // "billingEstimation": {},
18101
18322
  * // "cmekConfig": {},
18102
18323
  * // "configurableBillingApproach": "my_configurableBillingApproach",
18324
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
18103
18325
  * // "contentConfig": "my_contentConfig",
18104
18326
  * // "createTime": "my_createTime",
18105
18327
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -18428,6 +18650,7 @@ export namespace discoveryengine_v1beta {
18428
18650
  * // "billingEstimation": {},
18429
18651
  * // "cmekConfig": {},
18430
18652
  * // "configurableBillingApproach": "my_configurableBillingApproach",
18653
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
18431
18654
  * // "contentConfig": "my_contentConfig",
18432
18655
  * // "createTime": "my_createTime",
18433
18656
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -18914,6 +19137,7 @@ export namespace discoveryengine_v1beta {
18914
19137
  * // "billingEstimation": {},
18915
19138
  * // "cmekConfig": {},
18916
19139
  * // "configurableBillingApproach": "my_configurableBillingApproach",
19140
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
18917
19141
  * // "contentConfig": "my_contentConfig",
18918
19142
  * // "createTime": "my_createTime",
18919
19143
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -18943,6 +19167,7 @@ export namespace discoveryengine_v1beta {
18943
19167
  * // "billingEstimation": {},
18944
19168
  * // "cmekConfig": {},
18945
19169
  * // "configurableBillingApproach": "my_configurableBillingApproach",
19170
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
18946
19171
  * // "contentConfig": "my_contentConfig",
18947
19172
  * // "createTime": "my_createTime",
18948
19173
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -19252,7 +19477,7 @@ export namespace discoveryengine_v1beta {
19252
19477
  */
19253
19478
  queryModel?: string;
19254
19479
  /**
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.
19480
+ * 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
19481
  */
19257
19482
  userPseudoId?: string;
19258
19483
  }
@@ -33025,6 +33250,7 @@ export namespace discoveryengine_v1beta {
33025
33250
  * // "appType": "my_appType",
33026
33251
  * // "chatEngineConfig": {},
33027
33252
  * // "chatEngineMetadata": {},
33253
+ * // "cmekConfig": {},
33028
33254
  * // "commonConfig": {},
33029
33255
  * // "configurableBillingApproach": "my_configurableBillingApproach",
33030
33256
  * // "createTime": "my_createTime",
@@ -33034,6 +33260,7 @@ export namespace discoveryengine_v1beta {
33034
33260
  * // "features": {},
33035
33261
  * // "industryVertical": "my_industryVertical",
33036
33262
  * // "mediaRecommendationEngineConfig": {},
33263
+ * // "modelConfigs": {},
33037
33264
  * // "name": "my_name",
33038
33265
  * // "searchEngineConfig": {},
33039
33266
  * // "solutionType": "my_solutionType",
@@ -33346,6 +33573,7 @@ export namespace discoveryengine_v1beta {
33346
33573
  * // "appType": "my_appType",
33347
33574
  * // "chatEngineConfig": {},
33348
33575
  * // "chatEngineMetadata": {},
33576
+ * // "cmekConfig": {},
33349
33577
  * // "commonConfig": {},
33350
33578
  * // "configurableBillingApproach": "my_configurableBillingApproach",
33351
33579
  * // "createTime": "my_createTime",
@@ -33355,6 +33583,7 @@ export namespace discoveryengine_v1beta {
33355
33583
  * // "features": {},
33356
33584
  * // "industryVertical": "my_industryVertical",
33357
33585
  * // "mediaRecommendationEngineConfig": {},
33586
+ * // "modelConfigs": {},
33358
33587
  * // "name": "my_name",
33359
33588
  * // "searchEngineConfig": {},
33360
33589
  * // "solutionType": "my_solutionType",
@@ -33675,6 +33904,7 @@ export namespace discoveryengine_v1beta {
33675
33904
  * // "appType": "my_appType",
33676
33905
  * // "chatEngineConfig": {},
33677
33906
  * // "chatEngineMetadata": {},
33907
+ * // "cmekConfig": {},
33678
33908
  * // "commonConfig": {},
33679
33909
  * // "configurableBillingApproach": "my_configurableBillingApproach",
33680
33910
  * // "createTime": "my_createTime",
@@ -33684,6 +33914,7 @@ export namespace discoveryengine_v1beta {
33684
33914
  * // "features": {},
33685
33915
  * // "industryVertical": "my_industryVertical",
33686
33916
  * // "mediaRecommendationEngineConfig": {},
33917
+ * // "modelConfigs": {},
33687
33918
  * // "name": "my_name",
33688
33919
  * // "searchEngineConfig": {},
33689
33920
  * // "solutionType": "my_solutionType",
@@ -33698,6 +33929,7 @@ export namespace discoveryengine_v1beta {
33698
33929
  * // "appType": "my_appType",
33699
33930
  * // "chatEngineConfig": {},
33700
33931
  * // "chatEngineMetadata": {},
33932
+ * // "cmekConfig": {},
33701
33933
  * // "commonConfig": {},
33702
33934
  * // "configurableBillingApproach": "my_configurableBillingApproach",
33703
33935
  * // "createTime": "my_createTime",
@@ -33707,6 +33939,7 @@ export namespace discoveryengine_v1beta {
33707
33939
  * // "features": {},
33708
33940
  * // "industryVertical": "my_industryVertical",
33709
33941
  * // "mediaRecommendationEngineConfig": {},
33942
+ * // "modelConfigs": {},
33710
33943
  * // "name": "my_name",
33711
33944
  * // "searchEngineConfig": {},
33712
33945
  * // "solutionType": "my_solutionType",
@@ -33869,6 +34102,7 @@ export namespace discoveryengine_v1beta {
33869
34102
  * // "appType": "my_appType",
33870
34103
  * // "chatEngineConfig": {},
33871
34104
  * // "chatEngineMetadata": {},
34105
+ * // "cmekConfig": {},
33872
34106
  * // "commonConfig": {},
33873
34107
  * // "configurableBillingApproach": "my_configurableBillingApproach",
33874
34108
  * // "createTime": "my_createTime",
@@ -33878,6 +34112,7 @@ export namespace discoveryengine_v1beta {
33878
34112
  * // "features": {},
33879
34113
  * // "industryVertical": "my_industryVertical",
33880
34114
  * // "mediaRecommendationEngineConfig": {},
34115
+ * // "modelConfigs": {},
33881
34116
  * // "name": "my_name",
33882
34117
  * // "searchEngineConfig": {},
33883
34118
  * // "solutionType": "my_solutionType",
@@ -34043,6 +34278,7 @@ export namespace discoveryengine_v1beta {
34043
34278
  * // "appType": "my_appType",
34044
34279
  * // "chatEngineConfig": {},
34045
34280
  * // "chatEngineMetadata": {},
34281
+ * // "cmekConfig": {},
34046
34282
  * // "commonConfig": {},
34047
34283
  * // "configurableBillingApproach": "my_configurableBillingApproach",
34048
34284
  * // "createTime": "my_createTime",
@@ -34052,6 +34288,7 @@ export namespace discoveryengine_v1beta {
34052
34288
  * // "features": {},
34053
34289
  * // "industryVertical": "my_industryVertical",
34054
34290
  * // "mediaRecommendationEngineConfig": {},
34291
+ * // "modelConfigs": {},
34055
34292
  * // "name": "my_name",
34056
34293
  * // "searchEngineConfig": {},
34057
34294
  * // "solutionType": "my_solutionType",
@@ -40809,7 +41046,7 @@ export namespace discoveryengine_v1beta {
40809
41046
  * query: 'placeholder-value',
40810
41047
  * // 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
41048
  * 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.
41049
+ * // 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
41050
  * userPseudoId: 'placeholder-value',
40814
41051
  * },
40815
41052
  * );
@@ -40985,6 +41222,7 @@ export namespace discoveryengine_v1beta {
40985
41222
  * // "billingEstimation": {},
40986
41223
  * // "cmekConfig": {},
40987
41224
  * // "configurableBillingApproach": "my_configurableBillingApproach",
41225
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
40988
41226
  * // "contentConfig": "my_contentConfig",
40989
41227
  * // "createTime": "my_createTime",
40990
41228
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -41309,6 +41547,7 @@ export namespace discoveryengine_v1beta {
41309
41547
  * // "billingEstimation": {},
41310
41548
  * // "cmekConfig": {},
41311
41549
  * // "configurableBillingApproach": "my_configurableBillingApproach",
41550
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
41312
41551
  * // "contentConfig": "my_contentConfig",
41313
41552
  * // "createTime": "my_createTime",
41314
41553
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -41788,6 +42027,7 @@ export namespace discoveryengine_v1beta {
41788
42027
  * // "billingEstimation": {},
41789
42028
  * // "cmekConfig": {},
41790
42029
  * // "configurableBillingApproach": "my_configurableBillingApproach",
42030
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
41791
42031
  * // "contentConfig": "my_contentConfig",
41792
42032
  * // "createTime": "my_createTime",
41793
42033
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -41817,6 +42057,7 @@ export namespace discoveryengine_v1beta {
41817
42057
  * // "billingEstimation": {},
41818
42058
  * // "cmekConfig": {},
41819
42059
  * // "configurableBillingApproach": "my_configurableBillingApproach",
42060
+ * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
41820
42061
  * // "contentConfig": "my_contentConfig",
41821
42062
  * // "createTime": "my_createTime",
41822
42063
  * // "defaultSchemaId": "my_defaultSchemaId",
@@ -41960,7 +42201,7 @@ export namespace discoveryengine_v1beta {
41960
42201
  */
41961
42202
  queryModel?: string;
41962
42203
  /**
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.
42204
+ * 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
42205
  */
41965
42206
  userPseudoId?: string;
41966
42207
  }
@@ -60465,9 +60706,14 @@ export namespace discoveryengine_v1beta {
60465
60706
 
60466
60707
  export class Resource$Projects$Locations$Userstores {
60467
60708
  context: APIRequestContext;
60709
+ licenseConfigsUsageStats: Resource$Projects$Locations$Userstores$Licenseconfigsusagestats;
60468
60710
  userLicenses: Resource$Projects$Locations$Userstores$Userlicenses;
60469
60711
  constructor(context: APIRequestContext) {
60470
60712
  this.context = context;
60713
+ this.licenseConfigsUsageStats =
60714
+ new Resource$Projects$Locations$Userstores$Licenseconfigsusagestats(
60715
+ this.context
60716
+ );
60471
60717
  this.userLicenses =
60472
60718
  new Resource$Projects$Locations$Userstores$Userlicenses(this.context);
60473
60719
  }
@@ -60633,6 +60879,639 @@ export namespace discoveryengine_v1beta {
60633
60879
  return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
60634
60880
  }
60635
60881
  }
60882
+
60883
+ /**
60884
+ * Creates a new User Store.
60885
+ * @example
60886
+ * ```js
60887
+ * // Before running the sample:
60888
+ * // - Enable the API at:
60889
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
60890
+ * // - Login into gcloud by running:
60891
+ * // ```sh
60892
+ * // $ gcloud auth application-default login
60893
+ * // ```
60894
+ * // - Install the npm module by running:
60895
+ * // ```sh
60896
+ * // $ npm install googleapis
60897
+ * // ```
60898
+ *
60899
+ * const {google} = require('googleapis');
60900
+ * const discoveryengine = google.discoveryengine('v1beta');
60901
+ *
60902
+ * async function main() {
60903
+ * const auth = new google.auth.GoogleAuth({
60904
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
60905
+ * scopes: [
60906
+ * 'https://www.googleapis.com/auth/cloud-platform',
60907
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
60908
+ * ],
60909
+ * });
60910
+ *
60911
+ * // Acquire an auth client, and bind it to all future calls
60912
+ * const authClient = await auth.getClient();
60913
+ * google.options({auth: authClient});
60914
+ *
60915
+ * // Do the magic
60916
+ * const res = await discoveryengine.projects.locations.userStores.create({
60917
+ * // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
60918
+ * parent: 'projects/my-project/locations/my-location',
60919
+ * // 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.
60920
+ * userStoreId: 'placeholder-value',
60921
+ *
60922
+ * // Request body metadata
60923
+ * requestBody: {
60924
+ * // request body parameters
60925
+ * // {
60926
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
60927
+ * // "displayName": "my_displayName",
60928
+ * // "enableExpiredLicenseAutoUpdate": false,
60929
+ * // "enableLicenseAutoRegister": false,
60930
+ * // "name": "my_name"
60931
+ * // }
60932
+ * },
60933
+ * });
60934
+ * console.log(res.data);
60935
+ *
60936
+ * // Example response
60937
+ * // {
60938
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
60939
+ * // "displayName": "my_displayName",
60940
+ * // "enableExpiredLicenseAutoUpdate": false,
60941
+ * // "enableLicenseAutoRegister": false,
60942
+ * // "name": "my_name"
60943
+ * // }
60944
+ * }
60945
+ *
60946
+ * main().catch(e => {
60947
+ * console.error(e);
60948
+ * throw e;
60949
+ * });
60950
+ *
60951
+ * ```
60952
+ *
60953
+ * @param params - Parameters for request
60954
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
60955
+ * @param callback - Optional callback that handles the response.
60956
+ * @returns A promise if used with async/await, or void if used with a callback.
60957
+ */
60958
+ create(
60959
+ params: Params$Resource$Projects$Locations$Userstores$Create,
60960
+ options: StreamMethodOptions
60961
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
60962
+ create(
60963
+ params?: Params$Resource$Projects$Locations$Userstores$Create,
60964
+ options?: MethodOptions
60965
+ ): Promise<
60966
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60967
+ >;
60968
+ create(
60969
+ params: Params$Resource$Projects$Locations$Userstores$Create,
60970
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
60971
+ callback: BodyResponseCallback<Readable>
60972
+ ): void;
60973
+ create(
60974
+ params: Params$Resource$Projects$Locations$Userstores$Create,
60975
+ options:
60976
+ | MethodOptions
60977
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>,
60978
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60979
+ ): void;
60980
+ create(
60981
+ params: Params$Resource$Projects$Locations$Userstores$Create,
60982
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60983
+ ): void;
60984
+ create(
60985
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60986
+ ): void;
60987
+ create(
60988
+ paramsOrCallback?:
60989
+ | Params$Resource$Projects$Locations$Userstores$Create
60990
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60991
+ | BodyResponseCallback<Readable>,
60992
+ optionsOrCallback?:
60993
+ | MethodOptions
60994
+ | StreamMethodOptions
60995
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60996
+ | BodyResponseCallback<Readable>,
60997
+ callback?:
60998
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
60999
+ | BodyResponseCallback<Readable>
61000
+ ):
61001
+ | void
61002
+ | Promise<
61003
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61004
+ >
61005
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
61006
+ let params = (paramsOrCallback ||
61007
+ {}) as Params$Resource$Projects$Locations$Userstores$Create;
61008
+ let options = (optionsOrCallback || {}) as MethodOptions;
61009
+
61010
+ if (typeof paramsOrCallback === 'function') {
61011
+ callback = paramsOrCallback;
61012
+ params = {} as Params$Resource$Projects$Locations$Userstores$Create;
61013
+ options = {};
61014
+ }
61015
+
61016
+ if (typeof optionsOrCallback === 'function') {
61017
+ callback = optionsOrCallback;
61018
+ options = {};
61019
+ }
61020
+
61021
+ const rootUrl =
61022
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
61023
+ const parameters = {
61024
+ options: Object.assign(
61025
+ {
61026
+ url: (rootUrl + '/v1beta/{+parent}/userStores').replace(
61027
+ /([^:]\/)\/+/g,
61028
+ '$1'
61029
+ ),
61030
+ method: 'POST',
61031
+ apiVersion: '',
61032
+ },
61033
+ options
61034
+ ),
61035
+ params,
61036
+ requiredParams: ['parent'],
61037
+ pathParams: ['parent'],
61038
+ context: this.context,
61039
+ };
61040
+ if (callback) {
61041
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61042
+ parameters,
61043
+ callback as BodyResponseCallback<unknown>
61044
+ );
61045
+ } else {
61046
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61047
+ parameters
61048
+ );
61049
+ }
61050
+ }
61051
+
61052
+ /**
61053
+ * Deletes the User Store.
61054
+ * @example
61055
+ * ```js
61056
+ * // Before running the sample:
61057
+ * // - Enable the API at:
61058
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
61059
+ * // - Login into gcloud by running:
61060
+ * // ```sh
61061
+ * // $ gcloud auth application-default login
61062
+ * // ```
61063
+ * // - Install the npm module by running:
61064
+ * // ```sh
61065
+ * // $ npm install googleapis
61066
+ * // ```
61067
+ *
61068
+ * const {google} = require('googleapis');
61069
+ * const discoveryengine = google.discoveryengine('v1beta');
61070
+ *
61071
+ * async function main() {
61072
+ * const auth = new google.auth.GoogleAuth({
61073
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
61074
+ * scopes: [
61075
+ * 'https://www.googleapis.com/auth/cloud-platform',
61076
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
61077
+ * ],
61078
+ * });
61079
+ *
61080
+ * // Acquire an auth client, and bind it to all future calls
61081
+ * const authClient = await auth.getClient();
61082
+ * google.options({auth: authClient});
61083
+ *
61084
+ * // Do the magic
61085
+ * const res = await discoveryengine.projects.locations.userStores.delete({
61086
+ * // Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
61087
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
61088
+ * });
61089
+ * console.log(res.data);
61090
+ *
61091
+ * // Example response
61092
+ * // {
61093
+ * // "done": false,
61094
+ * // "error": {},
61095
+ * // "metadata": {},
61096
+ * // "name": "my_name",
61097
+ * // "response": {}
61098
+ * // }
61099
+ * }
61100
+ *
61101
+ * main().catch(e => {
61102
+ * console.error(e);
61103
+ * throw e;
61104
+ * });
61105
+ *
61106
+ * ```
61107
+ *
61108
+ * @param params - Parameters for request
61109
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
61110
+ * @param callback - Optional callback that handles the response.
61111
+ * @returns A promise if used with async/await, or void if used with a callback.
61112
+ */
61113
+ delete(
61114
+ params: Params$Resource$Projects$Locations$Userstores$Delete,
61115
+ options: StreamMethodOptions
61116
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
61117
+ delete(
61118
+ params?: Params$Resource$Projects$Locations$Userstores$Delete,
61119
+ options?: MethodOptions
61120
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
61121
+ delete(
61122
+ params: Params$Resource$Projects$Locations$Userstores$Delete,
61123
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
61124
+ callback: BodyResponseCallback<Readable>
61125
+ ): void;
61126
+ delete(
61127
+ params: Params$Resource$Projects$Locations$Userstores$Delete,
61128
+ options:
61129
+ | MethodOptions
61130
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
61131
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
61132
+ ): void;
61133
+ delete(
61134
+ params: Params$Resource$Projects$Locations$Userstores$Delete,
61135
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
61136
+ ): void;
61137
+ delete(
61138
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
61139
+ ): void;
61140
+ delete(
61141
+ paramsOrCallback?:
61142
+ | Params$Resource$Projects$Locations$Userstores$Delete
61143
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
61144
+ | BodyResponseCallback<Readable>,
61145
+ optionsOrCallback?:
61146
+ | MethodOptions
61147
+ | StreamMethodOptions
61148
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
61149
+ | BodyResponseCallback<Readable>,
61150
+ callback?:
61151
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
61152
+ | BodyResponseCallback<Readable>
61153
+ ):
61154
+ | void
61155
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
61156
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
61157
+ let params = (paramsOrCallback ||
61158
+ {}) as Params$Resource$Projects$Locations$Userstores$Delete;
61159
+ let options = (optionsOrCallback || {}) as MethodOptions;
61160
+
61161
+ if (typeof paramsOrCallback === 'function') {
61162
+ callback = paramsOrCallback;
61163
+ params = {} as Params$Resource$Projects$Locations$Userstores$Delete;
61164
+ options = {};
61165
+ }
61166
+
61167
+ if (typeof optionsOrCallback === 'function') {
61168
+ callback = optionsOrCallback;
61169
+ options = {};
61170
+ }
61171
+
61172
+ const rootUrl =
61173
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
61174
+ const parameters = {
61175
+ options: Object.assign(
61176
+ {
61177
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
61178
+ method: 'DELETE',
61179
+ apiVersion: '',
61180
+ },
61181
+ options
61182
+ ),
61183
+ params,
61184
+ requiredParams: ['name'],
61185
+ pathParams: ['name'],
61186
+ context: this.context,
61187
+ };
61188
+ if (callback) {
61189
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
61190
+ parameters,
61191
+ callback as BodyResponseCallback<unknown>
61192
+ );
61193
+ } else {
61194
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
61195
+ }
61196
+ }
61197
+
61198
+ /**
61199
+ * Gets the User Store.
61200
+ * @example
61201
+ * ```js
61202
+ * // Before running the sample:
61203
+ * // - Enable the API at:
61204
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
61205
+ * // - Login into gcloud by running:
61206
+ * // ```sh
61207
+ * // $ gcloud auth application-default login
61208
+ * // ```
61209
+ * // - Install the npm module by running:
61210
+ * // ```sh
61211
+ * // $ npm install googleapis
61212
+ * // ```
61213
+ *
61214
+ * const {google} = require('googleapis');
61215
+ * const discoveryengine = google.discoveryengine('v1beta');
61216
+ *
61217
+ * async function main() {
61218
+ * const auth = new google.auth.GoogleAuth({
61219
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
61220
+ * scopes: [
61221
+ * 'https://www.googleapis.com/auth/cloud-platform',
61222
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
61223
+ * ],
61224
+ * });
61225
+ *
61226
+ * // Acquire an auth client, and bind it to all future calls
61227
+ * const authClient = await auth.getClient();
61228
+ * google.options({auth: authClient});
61229
+ *
61230
+ * // Do the magic
61231
+ * const res = await discoveryengine.projects.locations.userStores.get({
61232
+ * // Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
61233
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
61234
+ * });
61235
+ * console.log(res.data);
61236
+ *
61237
+ * // Example response
61238
+ * // {
61239
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
61240
+ * // "displayName": "my_displayName",
61241
+ * // "enableExpiredLicenseAutoUpdate": false,
61242
+ * // "enableLicenseAutoRegister": false,
61243
+ * // "name": "my_name"
61244
+ * // }
61245
+ * }
61246
+ *
61247
+ * main().catch(e => {
61248
+ * console.error(e);
61249
+ * throw e;
61250
+ * });
61251
+ *
61252
+ * ```
61253
+ *
61254
+ * @param params - Parameters for request
61255
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
61256
+ * @param callback - Optional callback that handles the response.
61257
+ * @returns A promise if used with async/await, or void if used with a callback.
61258
+ */
61259
+ get(
61260
+ params: Params$Resource$Projects$Locations$Userstores$Get,
61261
+ options: StreamMethodOptions
61262
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
61263
+ get(
61264
+ params?: Params$Resource$Projects$Locations$Userstores$Get,
61265
+ options?: MethodOptions
61266
+ ): Promise<
61267
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61268
+ >;
61269
+ get(
61270
+ params: Params$Resource$Projects$Locations$Userstores$Get,
61271
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
61272
+ callback: BodyResponseCallback<Readable>
61273
+ ): void;
61274
+ get(
61275
+ params: Params$Resource$Projects$Locations$Userstores$Get,
61276
+ options:
61277
+ | MethodOptions
61278
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>,
61279
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61280
+ ): void;
61281
+ get(
61282
+ params: Params$Resource$Projects$Locations$Userstores$Get,
61283
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61284
+ ): void;
61285
+ get(
61286
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61287
+ ): void;
61288
+ get(
61289
+ paramsOrCallback?:
61290
+ | Params$Resource$Projects$Locations$Userstores$Get
61291
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61292
+ | BodyResponseCallback<Readable>,
61293
+ optionsOrCallback?:
61294
+ | MethodOptions
61295
+ | StreamMethodOptions
61296
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61297
+ | BodyResponseCallback<Readable>,
61298
+ callback?:
61299
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61300
+ | BodyResponseCallback<Readable>
61301
+ ):
61302
+ | void
61303
+ | Promise<
61304
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61305
+ >
61306
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
61307
+ let params = (paramsOrCallback ||
61308
+ {}) as Params$Resource$Projects$Locations$Userstores$Get;
61309
+ let options = (optionsOrCallback || {}) as MethodOptions;
61310
+
61311
+ if (typeof paramsOrCallback === 'function') {
61312
+ callback = paramsOrCallback;
61313
+ params = {} as Params$Resource$Projects$Locations$Userstores$Get;
61314
+ options = {};
61315
+ }
61316
+
61317
+ if (typeof optionsOrCallback === 'function') {
61318
+ callback = optionsOrCallback;
61319
+ options = {};
61320
+ }
61321
+
61322
+ const rootUrl =
61323
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
61324
+ const parameters = {
61325
+ options: Object.assign(
61326
+ {
61327
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
61328
+ method: 'GET',
61329
+ apiVersion: '',
61330
+ },
61331
+ options
61332
+ ),
61333
+ params,
61334
+ requiredParams: ['name'],
61335
+ pathParams: ['name'],
61336
+ context: this.context,
61337
+ };
61338
+ if (callback) {
61339
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61340
+ parameters,
61341
+ callback as BodyResponseCallback<unknown>
61342
+ );
61343
+ } else {
61344
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61345
+ parameters
61346
+ );
61347
+ }
61348
+ }
61349
+
61350
+ /**
61351
+ * Updates the User Store.
61352
+ * @example
61353
+ * ```js
61354
+ * // Before running the sample:
61355
+ * // - Enable the API at:
61356
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
61357
+ * // - Login into gcloud by running:
61358
+ * // ```sh
61359
+ * // $ gcloud auth application-default login
61360
+ * // ```
61361
+ * // - Install the npm module by running:
61362
+ * // ```sh
61363
+ * // $ npm install googleapis
61364
+ * // ```
61365
+ *
61366
+ * const {google} = require('googleapis');
61367
+ * const discoveryengine = google.discoveryengine('v1beta');
61368
+ *
61369
+ * async function main() {
61370
+ * const auth = new google.auth.GoogleAuth({
61371
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
61372
+ * scopes: [
61373
+ * 'https://www.googleapis.com/auth/cloud-platform',
61374
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
61375
+ * ],
61376
+ * });
61377
+ *
61378
+ * // Acquire an auth client, and bind it to all future calls
61379
+ * const authClient = await auth.getClient();
61380
+ * google.options({auth: authClient});
61381
+ *
61382
+ * // Do the magic
61383
+ * const res = await discoveryengine.projects.locations.userStores.patch({
61384
+ * // 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.
61385
+ * name: 'projects/my-project/locations/my-location/userStores/my-userStore',
61386
+ * // Optional. The list of fields to update.
61387
+ * updateMask: 'placeholder-value',
61388
+ *
61389
+ * // Request body metadata
61390
+ * requestBody: {
61391
+ * // request body parameters
61392
+ * // {
61393
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
61394
+ * // "displayName": "my_displayName",
61395
+ * // "enableExpiredLicenseAutoUpdate": false,
61396
+ * // "enableLicenseAutoRegister": false,
61397
+ * // "name": "my_name"
61398
+ * // }
61399
+ * },
61400
+ * });
61401
+ * console.log(res.data);
61402
+ *
61403
+ * // Example response
61404
+ * // {
61405
+ * // "defaultLicenseConfig": "my_defaultLicenseConfig",
61406
+ * // "displayName": "my_displayName",
61407
+ * // "enableExpiredLicenseAutoUpdate": false,
61408
+ * // "enableLicenseAutoRegister": false,
61409
+ * // "name": "my_name"
61410
+ * // }
61411
+ * }
61412
+ *
61413
+ * main().catch(e => {
61414
+ * console.error(e);
61415
+ * throw e;
61416
+ * });
61417
+ *
61418
+ * ```
61419
+ *
61420
+ * @param params - Parameters for request
61421
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
61422
+ * @param callback - Optional callback that handles the response.
61423
+ * @returns A promise if used with async/await, or void if used with a callback.
61424
+ */
61425
+ patch(
61426
+ params: Params$Resource$Projects$Locations$Userstores$Patch,
61427
+ options: StreamMethodOptions
61428
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
61429
+ patch(
61430
+ params?: Params$Resource$Projects$Locations$Userstores$Patch,
61431
+ options?: MethodOptions
61432
+ ): Promise<
61433
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61434
+ >;
61435
+ patch(
61436
+ params: Params$Resource$Projects$Locations$Userstores$Patch,
61437
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
61438
+ callback: BodyResponseCallback<Readable>
61439
+ ): void;
61440
+ patch(
61441
+ params: Params$Resource$Projects$Locations$Userstores$Patch,
61442
+ options:
61443
+ | MethodOptions
61444
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>,
61445
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61446
+ ): void;
61447
+ patch(
61448
+ params: Params$Resource$Projects$Locations$Userstores$Patch,
61449
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61450
+ ): void;
61451
+ patch(
61452
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61453
+ ): void;
61454
+ patch(
61455
+ paramsOrCallback?:
61456
+ | Params$Resource$Projects$Locations$Userstores$Patch
61457
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61458
+ | BodyResponseCallback<Readable>,
61459
+ optionsOrCallback?:
61460
+ | MethodOptions
61461
+ | StreamMethodOptions
61462
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61463
+ | BodyResponseCallback<Readable>,
61464
+ callback?:
61465
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61466
+ | BodyResponseCallback<Readable>
61467
+ ):
61468
+ | void
61469
+ | Promise<
61470
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaUserStore>
61471
+ >
61472
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
61473
+ let params = (paramsOrCallback ||
61474
+ {}) as Params$Resource$Projects$Locations$Userstores$Patch;
61475
+ let options = (optionsOrCallback || {}) as MethodOptions;
61476
+
61477
+ if (typeof paramsOrCallback === 'function') {
61478
+ callback = paramsOrCallback;
61479
+ params = {} as Params$Resource$Projects$Locations$Userstores$Patch;
61480
+ options = {};
61481
+ }
61482
+
61483
+ if (typeof optionsOrCallback === 'function') {
61484
+ callback = optionsOrCallback;
61485
+ options = {};
61486
+ }
61487
+
61488
+ const rootUrl =
61489
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
61490
+ const parameters = {
61491
+ options: Object.assign(
61492
+ {
61493
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
61494
+ method: 'PATCH',
61495
+ apiVersion: '',
61496
+ },
61497
+ options
61498
+ ),
61499
+ params,
61500
+ requiredParams: ['name'],
61501
+ pathParams: ['name'],
61502
+ context: this.context,
61503
+ };
61504
+ if (callback) {
61505
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61506
+ parameters,
61507
+ callback as BodyResponseCallback<unknown>
61508
+ );
61509
+ } else {
61510
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaUserStore>(
61511
+ parameters
61512
+ );
61513
+ }
61514
+ }
60636
61515
  }
60637
61516
 
60638
61517
  export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses
@@ -60647,6 +61526,222 @@ export namespace discoveryengine_v1beta {
60647
61526
  */
60648
61527
  requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest;
60649
61528
  }
61529
+ export interface Params$Resource$Projects$Locations$Userstores$Create
61530
+ extends StandardParameters {
61531
+ /**
61532
+ * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
61533
+ */
61534
+ parent?: string;
61535
+ /**
61536
+ * 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.
61537
+ */
61538
+ userStoreId?: string;
61539
+
61540
+ /**
61541
+ * Request body metadata
61542
+ */
61543
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore;
61544
+ }
61545
+ export interface Params$Resource$Projects$Locations$Userstores$Delete
61546
+ extends StandardParameters {
61547
+ /**
61548
+ * Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
61549
+ */
61550
+ name?: string;
61551
+ }
61552
+ export interface Params$Resource$Projects$Locations$Userstores$Get
61553
+ extends StandardParameters {
61554
+ /**
61555
+ * Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
61556
+ */
61557
+ name?: string;
61558
+ }
61559
+ export interface Params$Resource$Projects$Locations$Userstores$Patch
61560
+ extends StandardParameters {
61561
+ /**
61562
+ * 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.
61563
+ */
61564
+ name?: string;
61565
+ /**
61566
+ * Optional. The list of fields to update.
61567
+ */
61568
+ updateMask?: string;
61569
+
61570
+ /**
61571
+ * Request body metadata
61572
+ */
61573
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore;
61574
+ }
61575
+
61576
+ export class Resource$Projects$Locations$Userstores$Licenseconfigsusagestats {
61577
+ context: APIRequestContext;
61578
+ constructor(context: APIRequestContext) {
61579
+ this.context = context;
61580
+ }
61581
+
61582
+ /**
61583
+ * Lists all the LicenseConfigUsageStatss associated with the project.
61584
+ * @example
61585
+ * ```js
61586
+ * // Before running the sample:
61587
+ * // - Enable the API at:
61588
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
61589
+ * // - Login into gcloud by running:
61590
+ * // ```sh
61591
+ * // $ gcloud auth application-default login
61592
+ * // ```
61593
+ * // - Install the npm module by running:
61594
+ * // ```sh
61595
+ * // $ npm install googleapis
61596
+ * // ```
61597
+ *
61598
+ * const {google} = require('googleapis');
61599
+ * const discoveryengine = google.discoveryengine('v1beta');
61600
+ *
61601
+ * async function main() {
61602
+ * const auth = new google.auth.GoogleAuth({
61603
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
61604
+ * scopes: [
61605
+ * 'https://www.googleapis.com/auth/cloud-platform',
61606
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
61607
+ * ],
61608
+ * });
61609
+ *
61610
+ * // Acquire an auth client, and bind it to all future calls
61611
+ * const authClient = await auth.getClient();
61612
+ * google.options({auth: authClient});
61613
+ *
61614
+ * // Do the magic
61615
+ * const res =
61616
+ * await discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list(
61617
+ * {
61618
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
61619
+ * parent:
61620
+ * 'projects/my-project/locations/my-location/userStores/my-userStore',
61621
+ * },
61622
+ * );
61623
+ * console.log(res.data);
61624
+ *
61625
+ * // Example response
61626
+ * // {
61627
+ * // "licenseConfigUsageStats": []
61628
+ * // }
61629
+ * }
61630
+ *
61631
+ * main().catch(e => {
61632
+ * console.error(e);
61633
+ * throw e;
61634
+ * });
61635
+ *
61636
+ * ```
61637
+ *
61638
+ * @param params - Parameters for request
61639
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
61640
+ * @param callback - Optional callback that handles the response.
61641
+ * @returns A promise if used with async/await, or void if used with a callback.
61642
+ */
61643
+ list(
61644
+ params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
61645
+ options: StreamMethodOptions
61646
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
61647
+ list(
61648
+ params?: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
61649
+ options?: MethodOptions
61650
+ ): Promise<
61651
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>
61652
+ >;
61653
+ list(
61654
+ params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
61655
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
61656
+ callback: BodyResponseCallback<Readable>
61657
+ ): void;
61658
+ list(
61659
+ params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
61660
+ options:
61661
+ | MethodOptions
61662
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>,
61663
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>
61664
+ ): void;
61665
+ list(
61666
+ params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
61667
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>
61668
+ ): void;
61669
+ list(
61670
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>
61671
+ ): void;
61672
+ list(
61673
+ paramsOrCallback?:
61674
+ | Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List
61675
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>
61676
+ | BodyResponseCallback<Readable>,
61677
+ optionsOrCallback?:
61678
+ | MethodOptions
61679
+ | StreamMethodOptions
61680
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>
61681
+ | BodyResponseCallback<Readable>,
61682
+ callback?:
61683
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>
61684
+ | BodyResponseCallback<Readable>
61685
+ ):
61686
+ | void
61687
+ | Promise<
61688
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>
61689
+ >
61690
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
61691
+ let params = (paramsOrCallback ||
61692
+ {}) as Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List;
61693
+ let options = (optionsOrCallback || {}) as MethodOptions;
61694
+
61695
+ if (typeof paramsOrCallback === 'function') {
61696
+ callback = paramsOrCallback;
61697
+ params =
61698
+ {} as Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List;
61699
+ options = {};
61700
+ }
61701
+
61702
+ if (typeof optionsOrCallback === 'function') {
61703
+ callback = optionsOrCallback;
61704
+ options = {};
61705
+ }
61706
+
61707
+ const rootUrl =
61708
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
61709
+ const parameters = {
61710
+ options: Object.assign(
61711
+ {
61712
+ url: (
61713
+ rootUrl + '/v1beta/{+parent}/licenseConfigsUsageStats'
61714
+ ).replace(/([^:]\/)\/+/g, '$1'),
61715
+ method: 'GET',
61716
+ apiVersion: '',
61717
+ },
61718
+ options
61719
+ ),
61720
+ params,
61721
+ requiredParams: ['parent'],
61722
+ pathParams: ['parent'],
61723
+ context: this.context,
61724
+ };
61725
+ if (callback) {
61726
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>(
61727
+ parameters,
61728
+ callback as BodyResponseCallback<unknown>
61729
+ );
61730
+ } else {
61731
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>(
61732
+ parameters
61733
+ );
61734
+ }
61735
+ }
61736
+ }
61737
+
61738
+ export interface Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List
61739
+ extends StandardParameters {
61740
+ /**
61741
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
61742
+ */
61743
+ parent?: string;
61744
+ }
60650
61745
 
60651
61746
  export class Resource$Projects$Locations$Userstores$Userlicenses {
60652
61747
  context: APIRequestContext;
@@ -60689,7 +61784,7 @@ export namespace discoveryengine_v1beta {
60689
61784
  * // Do the magic
60690
61785
  * const res =
60691
61786
  * await discoveryengine.projects.locations.userStores.userLicenses.list({
60692
- * // 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.
61787
+ * // 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.
60693
61788
  * filter: 'placeholder-value',
60694
61789
  * // 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.
60695
61790
  * pageSize: 'placeholder-value',
@@ -60819,7 +61914,7 @@ export namespace discoveryengine_v1beta {
60819
61914
  export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List
60820
61915
  extends StandardParameters {
60821
61916
  /**
60822
- * 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.
61917
+ * 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.
60823
61918
  */
60824
61919
  filter?: string;
60825
61920
  /**