@maxim_mazurok/gapi.client.dataplex-v1 0.3.20260929 → 0.3.20261005
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/index.d.ts +3 -127
- 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://dataplex.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20261005
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -578,8 +578,6 @@ declare namespace gapi.client {
|
|
|
578
578
|
includePatterns?: string[];
|
|
579
579
|
/** Optional. Configuration for JSON data. */
|
|
580
580
|
jsonOptions?: GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions;
|
|
581
|
-
/** Optional. Specifies configuration for unstructured data discovery. */
|
|
582
|
-
unstructuredDataOptions?: GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions;
|
|
583
581
|
}
|
|
584
582
|
interface GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions {
|
|
585
583
|
/** Optional. The delimiter that is used to separate values. The default is , (comma). */
|
|
@@ -599,12 +597,6 @@ declare namespace gapi.client {
|
|
|
599
597
|
/** Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). */
|
|
600
598
|
typeInferenceDisabled?: boolean;
|
|
601
599
|
}
|
|
602
|
-
interface GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions {
|
|
603
|
-
/** Optional. Whether to use the global model endpoint. */
|
|
604
|
-
globalEndpointEnabled?: boolean;
|
|
605
|
-
/** Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. */
|
|
606
|
-
semanticInferenceEnabled?: boolean;
|
|
607
|
-
}
|
|
608
600
|
interface GoogleCloudDataplexV1DataDocumentationResult {
|
|
609
601
|
/** Output only. Insights for a Dataset resource. */
|
|
610
602
|
datasetResult?: GoogleCloudDataplexV1DataDocumentationResultDatasetResult;
|
|
@@ -1287,14 +1279,9 @@ declare namespace gapi.client {
|
|
|
1287
1279
|
| 'DATA_QUALITY'
|
|
1288
1280
|
| 'DATA_PROFILE'
|
|
1289
1281
|
| 'DATA_DISCOVERY'
|
|
1290
|
-
| 'DATA_DOCUMENTATION'
|
|
1291
|
-
| 'UNSTRUCTURED_DATA_PROFILE';
|
|
1282
|
+
| 'DATA_DOCUMENTATION';
|
|
1292
1283
|
/** Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name. */
|
|
1293
1284
|
uid?: string;
|
|
1294
|
-
/** Output only. The result of an unstructured data profile scan. */
|
|
1295
|
-
unstructuredDataProfileResult?: GoogleCloudDataplexV1UnstructuredDataProfileResult;
|
|
1296
|
-
/** Optional. Settings for an unstructured data profile scan. */
|
|
1297
|
-
unstructuredDataProfileSpec?: GoogleCloudDataplexV1UnstructuredDataProfileSpec;
|
|
1298
1285
|
/** Output only. The time when the scan was last updated. */
|
|
1299
1286
|
updateTime?: string;
|
|
1300
1287
|
}
|
|
@@ -1475,14 +1462,9 @@ declare namespace gapi.client {
|
|
|
1475
1462
|
| 'DATA_QUALITY'
|
|
1476
1463
|
| 'DATA_PROFILE'
|
|
1477
1464
|
| 'DATA_DISCOVERY'
|
|
1478
|
-
| 'DATA_DOCUMENTATION'
|
|
1479
|
-
| 'UNSTRUCTURED_DATA_PROFILE';
|
|
1465
|
+
| 'DATA_DOCUMENTATION';
|
|
1480
1466
|
/** Output only. System generated globally unique ID for the DataScanJob. */
|
|
1481
1467
|
uid?: string;
|
|
1482
|
-
/** Output only. The result of an unstructured data profile scan. */
|
|
1483
|
-
unstructuredDataProfileResult?: GoogleCloudDataplexV1UnstructuredDataProfileResult;
|
|
1484
|
-
/** Output only. Settings for an unstructured data profile scan. */
|
|
1485
|
-
unstructuredDataProfileSpec?: GoogleCloudDataplexV1UnstructuredDataProfileSpec;
|
|
1486
1468
|
}
|
|
1487
1469
|
interface GoogleCloudDataplexV1DataSource {
|
|
1488
1470
|
/** Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. */
|
|
@@ -1917,96 +1899,6 @@ declare namespace gapi.client {
|
|
|
1917
1899
|
/** Type of entity. */
|
|
1918
1900
|
entityType?: 'ENTITY_TYPE_UNSPECIFIED' | 'TABLE' | 'FILESET';
|
|
1919
1901
|
}
|
|
1920
|
-
interface GoogleCloudDataplexV1GraphProfile {
|
|
1921
|
-
/** Output only. Edge types. */
|
|
1922
|
-
edgeTypes?: GoogleCloudDataplexV1GraphProfileEdgeType[];
|
|
1923
|
-
/** Output only. Node types. */
|
|
1924
|
-
nodeTypes?: GoogleCloudDataplexV1GraphProfileNodeType[];
|
|
1925
|
-
}
|
|
1926
|
-
interface GoogleCloudDataplexV1GraphProfileEdgeType {
|
|
1927
|
-
/** Output only. Description of the edge type. */
|
|
1928
|
-
description?: string;
|
|
1929
|
-
/** Output only. Extraction hints for the edge. */
|
|
1930
|
-
extractionHints?: GoogleCloudDataplexV1GraphProfileEdgeTypeExtractionHints;
|
|
1931
|
-
/** Output only. Fields of the edge type. */
|
|
1932
|
-
fields?: GoogleCloudDataplexV1GraphProfileField[];
|
|
1933
|
-
/** Output only. Defines the Foreign Key constraints for the edge. */
|
|
1934
|
-
foreignKeys?: GoogleCloudDataplexV1GraphProfileEdgeTypeForeignKey[];
|
|
1935
|
-
/** Output only. Name of the edge type. */
|
|
1936
|
-
name?: string;
|
|
1937
|
-
/** Output only. Source node type. */
|
|
1938
|
-
sourceNodeType?: string;
|
|
1939
|
-
/** Output only. Target node type. */
|
|
1940
|
-
targetNodeType?: string;
|
|
1941
|
-
}
|
|
1942
|
-
interface GoogleCloudDataplexV1GraphProfileEdgeTypeExtractionHints {
|
|
1943
|
-
/** Output only. Expected connectivity topology and bounds of this relationship. Format: "Topology - Description" Example: "1:N - One company can have multiple financial reports." */
|
|
1944
|
-
cardinality?: string;
|
|
1945
|
-
}
|
|
1946
|
-
interface GoogleCloudDataplexV1GraphProfileEdgeTypeForeignKey {
|
|
1947
|
-
/** Output only. Description of the foreign key. */
|
|
1948
|
-
description?: string;
|
|
1949
|
-
/** Output only. Field Mappings. Mappings between local fields and the fields they reference in the referenced node type. */
|
|
1950
|
-
fieldMappings?: GoogleCloudDataplexV1GraphProfileEdgeTypeForeignKeyFieldMapping[];
|
|
1951
|
-
/** Output only. Name of the foreign key constraint. */
|
|
1952
|
-
name?: string;
|
|
1953
|
-
/** Output only. The node type this constraint references. */
|
|
1954
|
-
referencedNodeType?: string;
|
|
1955
|
-
}
|
|
1956
|
-
interface GoogleCloudDataplexV1GraphProfileEdgeTypeForeignKeyFieldMapping {
|
|
1957
|
-
/** Output only. Local field name forming part of the foreign key. */
|
|
1958
|
-
field?: string;
|
|
1959
|
-
/** Output only. Field name in the referenced node type. */
|
|
1960
|
-
referencedField?: string;
|
|
1961
|
-
}
|
|
1962
|
-
interface GoogleCloudDataplexV1GraphProfileField {
|
|
1963
|
-
/** Output only. The data type of the field, e.g., STRING, INTEGER, DATE. */
|
|
1964
|
-
dataType?: string;
|
|
1965
|
-
/** Output only. Description of the field. */
|
|
1966
|
-
description?: string;
|
|
1967
|
-
/** Output only. Extraction hints for the field. */
|
|
1968
|
-
extractionHints?: GoogleCloudDataplexV1GraphProfileFieldExtractionHints;
|
|
1969
|
-
/** Output only. Sub-fields of this field (for STRUCT types). */
|
|
1970
|
-
fields?: GoogleCloudDataplexV1GraphProfileField[];
|
|
1971
|
-
/** Output only. The mapped metadata type. */
|
|
1972
|
-
metadataType?:
|
|
1973
|
-
| 'METADATA_TYPE_UNSPECIFIED'
|
|
1974
|
-
| 'BOOLEAN'
|
|
1975
|
-
| 'NUMBER'
|
|
1976
|
-
| 'STRING'
|
|
1977
|
-
| 'BYTES'
|
|
1978
|
-
| 'DATETIME'
|
|
1979
|
-
| 'TIMESTAMP'
|
|
1980
|
-
| 'GEOSPATIAL'
|
|
1981
|
-
| 'STRUCT'
|
|
1982
|
-
| 'OTHER';
|
|
1983
|
-
/** Output only. The mode of the field. */
|
|
1984
|
-
mode?: 'MODE_UNSPECIFIED' | 'NULLABLE' | 'REPEATED' | 'REQUIRED';
|
|
1985
|
-
/** Output only. Name of the field. */
|
|
1986
|
-
name?: string;
|
|
1987
|
-
}
|
|
1988
|
-
interface GoogleCloudDataplexV1GraphProfileFieldExtractionHints {
|
|
1989
|
-
/** Output only. Standardizes extracted data (e.g., to ISO 3166-1 alpha-2). */
|
|
1990
|
-
normalization?: string;
|
|
1991
|
-
/** Output only. Generates value from other data instead of direct extraction (e.g., hashing). */
|
|
1992
|
-
synthesis?: string;
|
|
1993
|
-
}
|
|
1994
|
-
interface GoogleCloudDataplexV1GraphProfileNodeType {
|
|
1995
|
-
/** Output only. Description of the node type. */
|
|
1996
|
-
description?: string;
|
|
1997
|
-
/** Output only. Extraction hints for the node. */
|
|
1998
|
-
extractionHints?: GoogleCloudDataplexV1GraphProfileNodeTypeExtractionHints;
|
|
1999
|
-
/** Output only. Fields of the node type. */
|
|
2000
|
-
fields?: GoogleCloudDataplexV1GraphProfileField[];
|
|
2001
|
-
/** Output only. Name of the node type. */
|
|
2002
|
-
name?: string;
|
|
2003
|
-
/** Output only. Field names forming the primary keys. The order in this array defines the key's ordinal positions for composite keys. */
|
|
2004
|
-
primaryKeys?: string[];
|
|
2005
|
-
}
|
|
2006
|
-
interface GoogleCloudDataplexV1GraphProfileNodeTypeExtractionHints {
|
|
2007
|
-
/** Output only. Expected occurrence frequency of this node type within a document. Format: "Bounds - Description" Example: "0:N - A document may contain multiple people names." */
|
|
2008
|
-
cardinality?: string;
|
|
2009
|
-
}
|
|
2010
1902
|
interface GoogleCloudDataplexV1ImportItem {
|
|
2011
1903
|
/** The aspects to modify. Supports the following syntaxes: {aspect_type_reference}: matches aspects that belong to the specified aspect type and are attached directly to the entry. {aspect_type_reference}@{path}: matches aspects that belong to the specified aspect type and path. {aspect_type_reference}@* : matches aspects of the given type for all paths. *@path : matches aspects of all types on the given path.Replace {aspect_type_reference} with a reference to the aspect type, in the format {project_id_or_number}.{location_id}.{aspect_type_id}.In FULL entry sync mode, if you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry. Dataplex Universal Catalog implicitly adds the keys for all of the required aspects of an entry. */
|
|
2012
1904
|
aspectKeys?: string[];
|
|
@@ -2844,22 +2736,6 @@ declare namespace gapi.client {
|
|
|
2844
2736
|
/** Required. Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.This field is required for Schedule scans. */
|
|
2845
2737
|
cron?: string;
|
|
2846
2738
|
}
|
|
2847
|
-
interface GoogleCloudDataplexV1UnstructuredDataProfileResult {
|
|
2848
|
-
/** Output only. The inferred description. */
|
|
2849
|
-
description?: string;
|
|
2850
|
-
/** Output only. The inferred graph profile. */
|
|
2851
|
-
graphProfile?: GoogleCloudDataplexV1GraphProfile;
|
|
2852
|
-
/** Output only. Optional message for partial failures (e.g. node type extraction failed). */
|
|
2853
|
-
partialFailureMessage?: string;
|
|
2854
|
-
}
|
|
2855
|
-
interface GoogleCloudDataplexV1UnstructuredDataProfileSpec {
|
|
2856
|
-
/** Optional. Customized prompt for unstructured data profile. The field will be used as part of the prompt, could be some instruction, specifying skill, or specific area to focus. */
|
|
2857
|
-
customizedPrompt?: string;
|
|
2858
|
-
/** Optional. Whether to use the global model. */
|
|
2859
|
-
globalEndpointEnabled?: boolean;
|
|
2860
|
-
/** Optional. Whether to publish graph-profile as aspect on the catalog entry. */
|
|
2861
|
-
graphProfilePublishingEnabled?: boolean;
|
|
2862
|
-
}
|
|
2863
2739
|
interface GoogleCloudDataplexV1UpdateEntryRequest {
|
|
2864
2740
|
/** Optional. If set to true and the entry doesn't exist, the service will create it. */
|
|
2865
2741
|
allowMissing?: boolean;
|