@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240224 → 0.0.20240227

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=v1alpha
-// Revision: 20240224
+// Revision: 20240227
 
 /// <reference types="gapi.client" />
 
@@ -82,6 +82,12 @@ declare namespace gapi.client {
       /** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
       functionName?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaAclConfig {
+      /** Identity provider config. */
+      idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
+      /** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+      name?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaAdditionalParams {
       /** Token that used for non-human user check. */
       token?: string;
@@ -244,6 +250,8 @@ declare namespace gapi.client {
       enableSearchAdaptor?: boolean;
     }
     interface GoogleCloudDiscoveryengineV1alphaDataStore {
+      /** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
+      aclEnabled?: boolean;
       /** 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. */
@@ -254,6 +262,8 @@ declare namespace gapi.client {
       displayName?: string;
       /** Configuration for Document understanding and enrichment. */
       documentProcessingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
+      /** Output only. Data store level identity provider config. */
+      idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: 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. */
@@ -297,6 +307,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest {}
     interface GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse {}
     interface GoogleCloudDiscoveryengineV1alphaDocument {
+      /** Access control information for the document. */
+      aclInfo?: GoogleCloudDiscoveryengineV1alphaDocumentAclInfo;
       /** The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. */
       content?: GoogleCloudDiscoveryengineV1alphaDocumentContent;
       /** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
@@ -316,6 +328,13 @@ declare namespace gapi.client {
       /** The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
       structData?: {[P in string]: any};
     }
+    interface GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
+      readers?: GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
+    }
+    interface GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction {
+      /** List of principals. */
+      principals?: GoogleCloudDiscoveryengineV1alphaPrincipal[];
+    }
     interface GoogleCloudDiscoveryengineV1alphaDocumentContent {
       /** The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. */
       mimeType?: string;
@@ -373,6 +392,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest {}
     interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse {}
     interface GoogleCloudDiscoveryengineV1alphaEngine {
+      /** Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. */
+      allowMultipleDataStoresSearchEngine?: boolean;
       /** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
       chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
       /** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
@@ -535,6 +556,16 @@ declare namespace gapi.client {
       /** Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3. */
       maxRelatedQuestions?: number;
     }
+    interface GoogleCloudDiscoveryengineV1alphaIdpConfig {
+      /** External Identity provider config. */
+      externalIdpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
+      /** Identity provider type configured. */
+      idpType?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
+      /** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
+      workforcePoolName?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -737,6 +768,12 @@ declare namespace gapi.client {
       totalPanels?: number;
     }
     interface GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {}
+    interface GoogleCloudDiscoveryengineV1alphaPrincipal {
+      /** Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. */
+      groupId?: string;
+      /** User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. */
+      userId?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -750,10 +787,14 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest {
+      /** The desired location of errors incurred during the purge. */
+      errorConfig?: GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig;
       /** Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */
       filter?: string;
       /** Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */
       force?: boolean;
+      /** Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. */
+      gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
     }
     interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse {
       /** The total count of documents purged as a result of the operation. */
@@ -761,6 +802,10 @@ declare namespace gapi.client {
       /** A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
       purgeSample?: string[];
     }
+    interface GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig {
+      /** Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */
+      gcsPrefix?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2696,6 +2741,8 @@ declare namespace gapi.client {
         prettyPrint?: boolean;
         /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
         quotaUser?: string;
+        /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
+        updateMask?: string;
         /** Upload protocol for media (e.g. "raw", "multipart"). */
         upload_protocol?: string;
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -2727,6 +2774,8 @@ declare namespace gapi.client {
           prettyPrint?: boolean;
           /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
           quotaUser?: string;
+          /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
+          updateMask?: string;
           /** Upload protocol for media (e.g. "raw", "multipart"). */
           upload_protocol?: string;
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -6439,6 +6488,8 @@ declare namespace gapi.client {
         prettyPrint?: boolean;
         /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
         quotaUser?: string;
+        /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
+        updateMask?: string;
         /** Upload protocol for media (e.g. "raw", "multipart"). */
         upload_protocol?: string;
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -6470,6 +6521,8 @@ declare namespace gapi.client {
           prettyPrint?: boolean;
           /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
           quotaUser?: string;
+          /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
+          updateMask?: string;
           /** Upload protocol for media (e.g. "raw", "multipart"). */
           upload_protocol?: string;
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -8710,6 +8763,91 @@ declare namespace gapi.client {
         },
         body: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest
       ): Request<GoogleLongrunningOperation>;
+      /** Gets the AclConfig. */
+      getAclConfig(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** 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. */
+        key?: string;
+        /** Required. Resource name of AclConfig, such as `projects/*‍/locations/*‍/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GoogleCloudDiscoveryengineV1alphaAclConfig>;
+      /** Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. */
+      updateAclConfig(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** 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. */
+        key?: string;
+        /** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudDiscoveryengineV1alphaAclConfig;
+      }): Request<GoogleCloudDiscoveryengineV1alphaAclConfig>;
+      updateAclConfig(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** 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. */
+          key?: string;
+          /** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+          name: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1alphaAclConfig
+      ): Request<GoogleCloudDiscoveryengineV1alphaAclConfig>;
       collections: CollectionsResource;
       dataStores: DataStoresResource;
       operations: OperationsResource;

package/package.json

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