@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20241004 → 0.0.20241014

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
-// Revision: 20241004
+// Revision: 20241014
 
 /// <reference types="gapi.client" />
 
@@ -266,6 +266,20 @@ declare namespace gapi.client {
       /** TargetSites created. */
       targetSites?: GoogleCloudDiscoveryengineV1alphaTargetSite[];
     }
+    interface GoogleCloudDiscoveryengineV1alphaCmekConfig {
+      /** Output only. The default CmekConfig for the Customer. */
+      isDefault?: boolean;
+      /** Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
+      kmsKey?: string;
+      /** Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
+      kmsKeyVersion?: string;
+      /** Output only. The timestamp of the last key rotation. */
+      lastRotationTimestampMicros?: string;
+      /** Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. */
+      name?: string;
+      /** Output only. State of the CmekConfig. */
+      state?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaCondition {
       /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
       activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
@@ -380,6 +394,8 @@ declare namespace gapi.client {
       aclEnabled?: boolean;
       /** Output only. Data size estimation for billing. */
       billingEstimation?: GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation;
+      /** Output only. CMEK-related information for the DataStore. */
+      cmekConfig?: GoogleCloudDiscoveryengineV1alphaCmekConfig;
       /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
       contentConfig?: string;
       /** Output only. Timestamp the DataStore was created at. */
@@ -394,6 +410,8 @@ declare namespace gapi.client {
       idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
+      /** Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. */
+      kmsKeyName?: string;
       /** Language info for DataStore. */
       languageInfo?: GoogleCloudDiscoveryengineV1alphaLanguageInfo;
       /** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
@@ -964,6 +982,8 @@ declare namespace gapi.client {
       naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
       /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       offset?: number;
+      /** The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. */
+      oneBoxPageSize?: number;
       /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
       orderBy?: string;
       /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
@@ -1265,6 +1285,12 @@ declare namespace gapi.client {
       engine?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {}
+    interface GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1648,6 +1674,20 @@ declare namespace gapi.client {
       /** TargetSites created. */
       targetSites?: GoogleCloudDiscoveryengineV1betaTargetSite[];
     }
+    interface GoogleCloudDiscoveryengineV1betaCmekConfig {
+      /** Output only. The default CmekConfig for the Customer. */
+      isDefault?: boolean;
+      /** Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
+      kmsKey?: string;
+      /** Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
+      kmsKeyVersion?: string;
+      /** Output only. The timestamp of the last key rotation. */
+      lastRotationTimestampMicros?: string;
+      /** Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. */
+      name?: string;
+      /** Output only. State of the CmekConfig. */
+      state?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaCondition {
       /** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
       activeTimeRange?: GoogleCloudDiscoveryengineV1betaConditionTimeRange[];
@@ -1756,6 +1796,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaDataStore {
       /** Output only. Data size estimation for billing. */
       billingEstimation?: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation;
+      /** Output only. CMEK-related information for the DataStore. */
+      cmekConfig?: GoogleCloudDiscoveryengineV1betaCmekConfig;
       /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
       contentConfig?: string;
       /** Output only. Timestamp the DataStore was created at. */
@@ -1768,6 +1810,8 @@ declare namespace gapi.client {
       documentProcessingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
+      /** Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. */
+      kmsKeyName?: string;
       /** Language info for DataStore. */
       languageInfo?: GoogleCloudDiscoveryengineV1betaLanguageInfo;
       /** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
@@ -2185,6 +2229,8 @@ declare namespace gapi.client {
       naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
       /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       offset?: number;
+      /** The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. */
+      oneBoxPageSize?: number;
       /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
       orderBy?: string;
       /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
@@ -2625,6 +2671,20 @@ declare namespace gapi.client {
       /** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
       tableId?: string;
     }
+    interface GoogleCloudDiscoveryengineV1CmekConfig {
+      /** Output only. The default CmekConfig for the Customer. */
+      isDefault?: boolean;
+      /** Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
+      kmsKey?: string;
+      /** Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
+      kmsKeyVersion?: string;
+      /** Output only. The timestamp of the last key rotation. */
+      lastRotationTimestampMicros?: string;
+      /** Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. */
+      name?: string;
+      /** Output only. State of the CmekConfig. */
+      state?: string;
+    }
     interface GoogleCloudDiscoveryengineV1CompleteQueryResponse {
       /** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
       querySuggestions?: GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion[];
@@ -2832,6 +2892,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1DataStore {
       /** Output only. Data size estimation for billing. */
       billingEstimation?: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation;
+      /** Output only. CMEK-related information for the DataStore. */
+      cmekConfig?: GoogleCloudDiscoveryengineV1CmekConfig;
       /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
       contentConfig?: string;
       /** Output only. Timestamp the DataStore was created at. */
@@ -2844,6 +2906,8 @@ declare namespace gapi.client {
       documentProcessingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
+      /** Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. */
+      kmsKeyName?: string;
       /** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
       /** Optional. Stores serving config at DataStore level. */
@@ -3549,6 +3613,8 @@ declare namespace gapi.client {
       languageCode?: string;
       /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       offset?: number;
+      /** The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. */
+      oneBoxPageSize?: number;
       /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
       orderBy?: string;
       /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
@@ -3984,6 +4050,12 @@ declare namespace gapi.client {
       /** Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. */
       value?: number;
     }
+    interface GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1UpdateSchemaMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -7118,10 +7190,14 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
+        /** Resource name of the CmekConfig to use for protecting this DataStore. */
+        cmekConfigName?: string;
         /** A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. */
         createAdvancedSiteSearch?: boolean;
         /** Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
         dataStoreId?: string;
+        /** DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. */
+        disableCmek?: boolean;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -7153,10 +7229,14 @@ declare namespace gapi.client {
           alt?: string;
           /** JSONP */
           callback?: string;
+          /** Resource name of the CmekConfig to use for protecting this DataStore. */
+          cmekConfigName?: string;
           /** A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. */
           createAdvancedSiteSearch?: boolean;
           /** Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
           dataStoreId?: string;
+          /** DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. */
+          disableCmek?: boolean;
           /** Selector specifying which fields to include in a partial response. */
           fields?: string;
           /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -11329,10 +11409,14 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
+        /** Resource name of the CmekConfig to use for protecting this DataStore. */
+        cmekConfigName?: string;
         /** A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. */
         createAdvancedSiteSearch?: boolean;
         /** Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
         dataStoreId?: string;
+        /** DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. */
+        disableCmek?: boolean;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
@@ -11364,10 +11448,14 @@ declare namespace gapi.client {
           alt?: string;
           /** JSONP */
           callback?: string;
+          /** Resource name of the CmekConfig to use for protecting this DataStore. */
+          cmekConfigName?: string;
           /** A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. */
           createAdvancedSiteSearch?: boolean;
           /** Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
           dataStoreId?: string;
+          /** DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. */
+          disableCmek?: boolean;
           /** Selector specifying which fields to include in a partial response. */
           fields?: string;
           /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1",
-  "version": "0.0.20241004",
+  "version": "0.0.20241014",
   "description": "TypeScript typings for Discovery Engine API v1",
   "repository": {
     "type": "git",