@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240323 → 0.0.20240329

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.
Files changed (2) hide show
  1. package/index.d.ts +83 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20240323
12
+ // Revision: 20240329
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -121,6 +121,44 @@ declare namespace gapi.client {
121
121
  /** Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */
122
122
  tableId?: string;
123
123
  }
124
+ interface GoogleCloudDiscoveryengineV1alphaBigtableOptions {
125
+ /** The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored. */
126
+ families?: {
127
+ [P in string]: GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily;
128
+ };
129
+ /** The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9* */
130
+ keyFieldName?: string;
131
+ }
132
+ interface GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn {
133
+ /** Optional. The encoding mode of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */
134
+ encoding?: string;
135
+ /** The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined. */
136
+ fieldName?: string;
137
+ /** Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string. */
138
+ qualifier?: string;
139
+ /** Optional. The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY. */
140
+ type?: string;
141
+ }
142
+ interface GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily {
143
+ /** The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored. */
144
+ columns?: GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn[];
145
+ /** Optional. The encoding mode of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */
146
+ encoding?: string;
147
+ /** The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined. */
148
+ fieldName?: string;
149
+ /** Optional. The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY. */
150
+ type?: string;
151
+ }
152
+ interface GoogleCloudDiscoveryengineV1alphaBigtableSource {
153
+ /** Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. */
154
+ bigtableOptions?: GoogleCloudDiscoveryengineV1alphaBigtableOptions;
155
+ /** Required. The instance ID of the Cloud Bigtable that needs to be exported. */
156
+ instanceId?: string;
157
+ /** The project ID (can be project # or ID) that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
158
+ projectId?: string;
159
+ /** Required. The table ID of the Cloud Bigtable that needs to be exported. */
160
+ tableId?: string;
161
+ }
124
162
  interface GoogleCloudDiscoveryengineV1alphaChunk {
125
163
  /** Output only. Metadata of the current chunk. */
126
164
  chunkMetadata?: GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
@@ -155,6 +193,20 @@ declare namespace gapi.client {
155
193
  /** The start page of the chunk. */
156
194
  pageStart?: number;
157
195
  }
196
+ interface GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
197
+ /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
198
+ databaseId?: string;
199
+ /** Optional. Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. */
200
+ gcsStagingDir?: string;
201
+ /** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
202
+ instanceId?: string;
203
+ /** Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless */
204
+ offload?: boolean;
205
+ /** Optional. The project ID (can be project # or ID) that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
206
+ projectId?: string;
207
+ /** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
208
+ tableId?: string;
209
+ }
158
210
  interface GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
159
211
  /** Required. The parent data store resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. */
160
212
  dataStore?: string;
@@ -598,6 +650,16 @@ declare namespace gapi.client {
598
650
  /** If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. */
599
651
  searchableOption?: string;
600
652
  }
653
+ interface GoogleCloudDiscoveryengineV1alphaFirestoreSource {
654
+ /** Required. The Firestore collection to copy the data from with a length limit of 1500 characters. */
655
+ collectionId?: string;
656
+ /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
657
+ databaseId?: string;
658
+ /** Optional. Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. */
659
+ gcsStagingDir?: string;
660
+ /** Optional. The project ID (can be project # or ID) that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
661
+ projectId?: string;
662
+ }
601
663
  interface GoogleCloudDiscoveryengineV1alphaGcsSource {
602
664
  /** The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. */
603
665
  dataSchema?: string;
@@ -655,10 +717,16 @@ declare namespace gapi.client {
655
717
  autoGenerateIds?: boolean;
656
718
  /** BigQuery input source. */
657
719
  bigquerySource?: GoogleCloudDiscoveryengineV1alphaBigQuerySource;
720
+ /** Cloud Bigtable input source. */
721
+ bigtableSource?: GoogleCloudDiscoveryengineV1alphaBigtableSource;
722
+ /** Cloud SQL input source. */
723
+ cloudSqlSource?: GoogleCloudDiscoveryengineV1alphaCloudSqlSource;
658
724
  /** The desired location of errors incurred during the Import. */
659
725
  errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
660
726
  /** FhirStore input source. */
661
727
  fhirStoreSource?: GoogleCloudDiscoveryengineV1alphaFhirStoreSource;
728
+ /** Firestore input source. */
729
+ firestoreSource?: GoogleCloudDiscoveryengineV1alphaFirestoreSource;
662
730
  /** Cloud Storage location for the input content. */
663
731
  gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
664
732
  /** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource */
@@ -667,6 +735,8 @@ declare namespace gapi.client {
667
735
  inlineSource?: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource;
668
736
  /** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
669
737
  reconciliationMode?: string;
738
+ /** Spanner input source. */
739
+ spannerSource?: GoogleCloudDiscoveryengineV1alphaSpannerSource;
670
740
  }
671
741
  interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource {
672
742
  /** Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. */
@@ -1424,6 +1494,18 @@ declare namespace gapi.client {
1424
1494
  /** Latest site verification time. */
1425
1495
  verifyTime?: string;
1426
1496
  }
1497
+ interface GoogleCloudDiscoveryengineV1alphaSpannerSource {
1498
+ /** Required. The database ID of the source Spanner table. */
1499
+ databaseId?: string;
1500
+ /** Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas */
1501
+ enableDataBoost?: boolean;
1502
+ /** Required. The instance ID of the source Spanner table. */
1503
+ instanceId?: string;
1504
+ /** The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
1505
+ projectId?: string;
1506
+ /** Required. The table name of the Spanner database that needs to be imported. */
1507
+ tableId?: string;
1508
+ }
1427
1509
  interface GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry {
1428
1510
  /** Required. Phrase to block from suggestions served. Can be maximum 125 characters. */
1429
1511
  blockPhrase?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20240323",
3
+ "version": "0.0.20240329",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",