@maxim_mazurok/gapi.client.dataplex-v1 0.1.20260113 → 0.1.20260127
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 +270 -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://dataplex.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260127
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -544,6 +544,8 @@ declare namespace gapi.client {
|
|
|
544
544
|
interface GoogleCloudDataplexV1DataDocumentationSpec {
|
|
545
545
|
/** Optional. Whether to publish result to Dataplex Catalog. */
|
|
546
546
|
catalogPublishingEnabled?: boolean;
|
|
547
|
+
/** Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated. */
|
|
548
|
+
generationScopes?: string[];
|
|
547
549
|
}
|
|
548
550
|
interface GoogleCloudDataplexV1DataProduct {
|
|
549
551
|
/** Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.Example: { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts@example.com" } } } */
|
|
@@ -1794,6 +1796,14 @@ declare namespace gapi.client {
|
|
|
1794
1796
|
/** Locations that could not be reached. */
|
|
1795
1797
|
unreachableLocations?: string[];
|
|
1796
1798
|
}
|
|
1799
|
+
interface GoogleCloudDataplexV1ListMetadataFeedsResponse {
|
|
1800
|
+
/** List of metadata feeds under the specified parent location. */
|
|
1801
|
+
metadataFeeds?: GoogleCloudDataplexV1MetadataFeed[];
|
|
1802
|
+
/** A token to retrieve the next page of results. If there are no more results in the list, the value is empty. */
|
|
1803
|
+
nextPageToken?: string;
|
|
1804
|
+
/** Unordered list. Locations that the service couldn't reach. */
|
|
1805
|
+
unreachable?: string[];
|
|
1806
|
+
}
|
|
1797
1807
|
interface GoogleCloudDataplexV1ListMetadataJobsResponse {
|
|
1798
1808
|
/** Metadata jobs under the specified parent location. */
|
|
1799
1809
|
metadataJobs?: GoogleCloudDataplexV1MetadataJob[];
|
|
@@ -1828,6 +1838,40 @@ declare namespace gapi.client {
|
|
|
1828
1838
|
/** Zones under the given parent lake. */
|
|
1829
1839
|
zones?: GoogleCloudDataplexV1Zone[];
|
|
1830
1840
|
}
|
|
1841
|
+
interface GoogleCloudDataplexV1MetadataFeed {
|
|
1842
|
+
/** Output only. The time when the feed was created. */
|
|
1843
|
+
createTime?: string;
|
|
1844
|
+
/** Optional. The filters of the metadata feed. Only the changes that match the filters are published. */
|
|
1845
|
+
filters?: GoogleCloudDataplexV1MetadataFeedFilters;
|
|
1846
|
+
/** Optional. User-defined labels. */
|
|
1847
|
+
labels?: {[P in string]: string};
|
|
1848
|
+
/** Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}. */
|
|
1849
|
+
name?: string;
|
|
1850
|
+
/** Optional. The pubsub topic that you want the metadata feed messages to publish to. Please grant Dataplex service account the permission to publish messages to the topic. The service account is: service-{PROJECT_NUMBER}@gcp-sa-dataplex.iam.gserviceaccount.com. */
|
|
1851
|
+
pubsubTopic?: string;
|
|
1852
|
+
/** Required. The scope of the metadata feed. Only the in scope changes are published. */
|
|
1853
|
+
scope?: GoogleCloudDataplexV1MetadataFeedScope;
|
|
1854
|
+
/** Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different. */
|
|
1855
|
+
uid?: string;
|
|
1856
|
+
/** Output only. The time when the feed was updated. */
|
|
1857
|
+
updateTime?: string;
|
|
1858
|
+
}
|
|
1859
|
+
interface GoogleCloudDataplexV1MetadataFeedFilters {
|
|
1860
|
+
/** Optional. The aspect types that you want to listen to. Depending on how the aspect is attached to the entry, in the format: projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}. */
|
|
1861
|
+
aspectTypes?: string[];
|
|
1862
|
+
/** Optional. The type of change that you want to listen to. If not specified, all changes are published. */
|
|
1863
|
+
changeTypes?: string[];
|
|
1864
|
+
/** Optional. The entry types that you want to listen to, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}. Only entries that belong to the specified entry types are published. */
|
|
1865
|
+
entryTypes?: string[];
|
|
1866
|
+
}
|
|
1867
|
+
interface GoogleCloudDataplexV1MetadataFeedScope {
|
|
1868
|
+
/** Optional. The entry groups whose entries you want to listen to. Must be in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. */
|
|
1869
|
+
entryGroups?: string[];
|
|
1870
|
+
/** Optional. Whether the metadata feed is at the organization-level. If true, all changes happened to the entries in the same organization as the feed are published. If false, you must specify a list of projects or a list of entry groups whose entries you want to listen to.The default is false. */
|
|
1871
|
+
organizationLevel?: boolean;
|
|
1872
|
+
/** Optional. The projects whose entries you want to listen to. Must be in the same organization as the feed. Must be in the format: projects/{project_id_or_number}. */
|
|
1873
|
+
projects?: string[];
|
|
1874
|
+
}
|
|
1831
1875
|
interface GoogleCloudDataplexV1MetadataJob {
|
|
1832
1876
|
/** Output only. The time when the metadata job was created. */
|
|
1833
1877
|
createTime?: string;
|
|
@@ -10280,6 +10324,229 @@ declare namespace gapi.client {
|
|
|
10280
10324
|
tasks: TasksResource;
|
|
10281
10325
|
zones: ZonesResource;
|
|
10282
10326
|
}
|
|
10327
|
+
interface MetadataFeedsResource {
|
|
10328
|
+
/** Creates a MetadataFeed. */
|
|
10329
|
+
create(request: {
|
|
10330
|
+
/** V1 error format. */
|
|
10331
|
+
'$.xgafv'?: string;
|
|
10332
|
+
/** OAuth access token. */
|
|
10333
|
+
access_token?: string;
|
|
10334
|
+
/** Data format for response. */
|
|
10335
|
+
alt?: string;
|
|
10336
|
+
/** JSONP */
|
|
10337
|
+
callback?: string;
|
|
10338
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10339
|
+
fields?: string;
|
|
10340
|
+
/** 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. */
|
|
10341
|
+
key?: string;
|
|
10342
|
+
/** Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-. */
|
|
10343
|
+
metadataFeedId?: string;
|
|
10344
|
+
/** OAuth 2.0 token for the current user. */
|
|
10345
|
+
oauth_token?: string;
|
|
10346
|
+
/** Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} */
|
|
10347
|
+
parent: string;
|
|
10348
|
+
/** Returns response with indentations and line breaks. */
|
|
10349
|
+
prettyPrint?: boolean;
|
|
10350
|
+
/** 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. */
|
|
10351
|
+
quotaUser?: string;
|
|
10352
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10353
|
+
upload_protocol?: string;
|
|
10354
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10355
|
+
uploadType?: string;
|
|
10356
|
+
/** Optional. The service validates the request without performing any mutations. The default is false. */
|
|
10357
|
+
validateOnly?: boolean;
|
|
10358
|
+
/** Request body */
|
|
10359
|
+
resource: GoogleCloudDataplexV1MetadataFeed;
|
|
10360
|
+
}): Request<GoogleLongrunningOperation>;
|
|
10361
|
+
create(
|
|
10362
|
+
request: {
|
|
10363
|
+
/** V1 error format. */
|
|
10364
|
+
'$.xgafv'?: string;
|
|
10365
|
+
/** OAuth access token. */
|
|
10366
|
+
access_token?: string;
|
|
10367
|
+
/** Data format for response. */
|
|
10368
|
+
alt?: string;
|
|
10369
|
+
/** JSONP */
|
|
10370
|
+
callback?: string;
|
|
10371
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10372
|
+
fields?: string;
|
|
10373
|
+
/** 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. */
|
|
10374
|
+
key?: string;
|
|
10375
|
+
/** Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-. */
|
|
10376
|
+
metadataFeedId?: string;
|
|
10377
|
+
/** OAuth 2.0 token for the current user. */
|
|
10378
|
+
oauth_token?: string;
|
|
10379
|
+
/** Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} */
|
|
10380
|
+
parent: string;
|
|
10381
|
+
/** Returns response with indentations and line breaks. */
|
|
10382
|
+
prettyPrint?: boolean;
|
|
10383
|
+
/** 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. */
|
|
10384
|
+
quotaUser?: string;
|
|
10385
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10386
|
+
upload_protocol?: string;
|
|
10387
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10388
|
+
uploadType?: string;
|
|
10389
|
+
/** Optional. The service validates the request without performing any mutations. The default is false. */
|
|
10390
|
+
validateOnly?: boolean;
|
|
10391
|
+
},
|
|
10392
|
+
body: GoogleCloudDataplexV1MetadataFeed,
|
|
10393
|
+
): Request<GoogleLongrunningOperation>;
|
|
10394
|
+
/** Deletes a MetadataFeed. */
|
|
10395
|
+
delete(request?: {
|
|
10396
|
+
/** V1 error format. */
|
|
10397
|
+
'$.xgafv'?: string;
|
|
10398
|
+
/** OAuth access token. */
|
|
10399
|
+
access_token?: string;
|
|
10400
|
+
/** Data format for response. */
|
|
10401
|
+
alt?: string;
|
|
10402
|
+
/** JSONP */
|
|
10403
|
+
callback?: string;
|
|
10404
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10405
|
+
fields?: string;
|
|
10406
|
+
/** 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. */
|
|
10407
|
+
key?: string;
|
|
10408
|
+
/** Required. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/MetadataFeeds/{metadata_feed_id}. */
|
|
10409
|
+
name: string;
|
|
10410
|
+
/** OAuth 2.0 token for the current user. */
|
|
10411
|
+
oauth_token?: string;
|
|
10412
|
+
/** Returns response with indentations and line breaks. */
|
|
10413
|
+
prettyPrint?: boolean;
|
|
10414
|
+
/** 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. */
|
|
10415
|
+
quotaUser?: string;
|
|
10416
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10417
|
+
upload_protocol?: string;
|
|
10418
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10419
|
+
uploadType?: string;
|
|
10420
|
+
}): Request<GoogleLongrunningOperation>;
|
|
10421
|
+
/** Gets a MetadataFeed. */
|
|
10422
|
+
get(request?: {
|
|
10423
|
+
/** V1 error format. */
|
|
10424
|
+
'$.xgafv'?: string;
|
|
10425
|
+
/** OAuth access token. */
|
|
10426
|
+
access_token?: string;
|
|
10427
|
+
/** Data format for response. */
|
|
10428
|
+
alt?: string;
|
|
10429
|
+
/** JSONP */
|
|
10430
|
+
callback?: string;
|
|
10431
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10432
|
+
fields?: string;
|
|
10433
|
+
/** 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. */
|
|
10434
|
+
key?: string;
|
|
10435
|
+
/** Required. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/MetadataFeeds/{metadata_feed_id}. */
|
|
10436
|
+
name: string;
|
|
10437
|
+
/** OAuth 2.0 token for the current user. */
|
|
10438
|
+
oauth_token?: string;
|
|
10439
|
+
/** Returns response with indentations and line breaks. */
|
|
10440
|
+
prettyPrint?: boolean;
|
|
10441
|
+
/** 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. */
|
|
10442
|
+
quotaUser?: string;
|
|
10443
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10444
|
+
upload_protocol?: string;
|
|
10445
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10446
|
+
uploadType?: string;
|
|
10447
|
+
}): Request<GoogleCloudDataplexV1MetadataFeed>;
|
|
10448
|
+
/** Retrieve a list of MetadataFeeds. */
|
|
10449
|
+
list(request?: {
|
|
10450
|
+
/** V1 error format. */
|
|
10451
|
+
'$.xgafv'?: string;
|
|
10452
|
+
/** OAuth access token. */
|
|
10453
|
+
access_token?: string;
|
|
10454
|
+
/** Data format for response. */
|
|
10455
|
+
alt?: string;
|
|
10456
|
+
/** JSONP */
|
|
10457
|
+
callback?: string;
|
|
10458
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10459
|
+
fields?: string;
|
|
10460
|
+
/** Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"You can combine filters with AND, OR, and NOT operators. */
|
|
10461
|
+
filter?: string;
|
|
10462
|
+
/** 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. */
|
|
10463
|
+
key?: string;
|
|
10464
|
+
/** OAuth 2.0 token for the current user. */
|
|
10465
|
+
oauth_token?: string;
|
|
10466
|
+
/** Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined. */
|
|
10467
|
+
orderBy?: string;
|
|
10468
|
+
/** Optional. The maximum number of metadata feeds to return. The service might return fewer feeds than this value. If unspecified, at most 10 feeds are returned. The maximum value is 1,000. */
|
|
10469
|
+
pageSize?: number;
|
|
10470
|
+
/** Optional. The page token received from a previous ListMetadataFeeds call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataFeeds request must match the call that provided the page token. */
|
|
10471
|
+
pageToken?: string;
|
|
10472
|
+
/** Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} */
|
|
10473
|
+
parent: string;
|
|
10474
|
+
/** Returns response with indentations and line breaks. */
|
|
10475
|
+
prettyPrint?: boolean;
|
|
10476
|
+
/** 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. */
|
|
10477
|
+
quotaUser?: string;
|
|
10478
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10479
|
+
upload_protocol?: string;
|
|
10480
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10481
|
+
uploadType?: string;
|
|
10482
|
+
}): Request<GoogleCloudDataplexV1ListMetadataFeedsResponse>;
|
|
10483
|
+
/** Updates a MetadataFeed. */
|
|
10484
|
+
patch(request: {
|
|
10485
|
+
/** V1 error format. */
|
|
10486
|
+
'$.xgafv'?: string;
|
|
10487
|
+
/** OAuth access token. */
|
|
10488
|
+
access_token?: string;
|
|
10489
|
+
/** Data format for response. */
|
|
10490
|
+
alt?: string;
|
|
10491
|
+
/** JSONP */
|
|
10492
|
+
callback?: string;
|
|
10493
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10494
|
+
fields?: string;
|
|
10495
|
+
/** 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. */
|
|
10496
|
+
key?: string;
|
|
10497
|
+
/** Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}. */
|
|
10498
|
+
name: string;
|
|
10499
|
+
/** OAuth 2.0 token for the current user. */
|
|
10500
|
+
oauth_token?: string;
|
|
10501
|
+
/** Returns response with indentations and line breaks. */
|
|
10502
|
+
prettyPrint?: boolean;
|
|
10503
|
+
/** 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. */
|
|
10504
|
+
quotaUser?: string;
|
|
10505
|
+
/** Optional. Mask of fields to update. */
|
|
10506
|
+
updateMask?: string;
|
|
10507
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10508
|
+
upload_protocol?: string;
|
|
10509
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10510
|
+
uploadType?: string;
|
|
10511
|
+
/** Optional. Only validate the request, but do not perform mutations. The default is false. */
|
|
10512
|
+
validateOnly?: boolean;
|
|
10513
|
+
/** Request body */
|
|
10514
|
+
resource: GoogleCloudDataplexV1MetadataFeed;
|
|
10515
|
+
}): Request<GoogleLongrunningOperation>;
|
|
10516
|
+
patch(
|
|
10517
|
+
request: {
|
|
10518
|
+
/** V1 error format. */
|
|
10519
|
+
'$.xgafv'?: string;
|
|
10520
|
+
/** OAuth access token. */
|
|
10521
|
+
access_token?: string;
|
|
10522
|
+
/** Data format for response. */
|
|
10523
|
+
alt?: string;
|
|
10524
|
+
/** JSONP */
|
|
10525
|
+
callback?: string;
|
|
10526
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10527
|
+
fields?: string;
|
|
10528
|
+
/** 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. */
|
|
10529
|
+
key?: string;
|
|
10530
|
+
/** Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}. */
|
|
10531
|
+
name: string;
|
|
10532
|
+
/** OAuth 2.0 token for the current user. */
|
|
10533
|
+
oauth_token?: string;
|
|
10534
|
+
/** Returns response with indentations and line breaks. */
|
|
10535
|
+
prettyPrint?: boolean;
|
|
10536
|
+
/** 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. */
|
|
10537
|
+
quotaUser?: string;
|
|
10538
|
+
/** Optional. Mask of fields to update. */
|
|
10539
|
+
updateMask?: string;
|
|
10540
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10541
|
+
upload_protocol?: string;
|
|
10542
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10543
|
+
uploadType?: string;
|
|
10544
|
+
/** Optional. Only validate the request, but do not perform mutations. The default is false. */
|
|
10545
|
+
validateOnly?: boolean;
|
|
10546
|
+
},
|
|
10547
|
+
body: GoogleCloudDataplexV1MetadataFeed,
|
|
10548
|
+
): Request<GoogleLongrunningOperation>;
|
|
10549
|
+
}
|
|
10283
10550
|
interface MetadataJobsResource {
|
|
10284
10551
|
/** Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job. */
|
|
10285
10552
|
cancel(request: {
|
|
@@ -10645,7 +10912,7 @@ declare namespace gapi.client {
|
|
|
10645
10912
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10646
10913
|
uploadType?: string;
|
|
10647
10914
|
}): Request<GoogleCloudLocationLocation>;
|
|
10648
|
-
/** Lists information about the supported locations for this service. */
|
|
10915
|
+
/** Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project. */
|
|
10649
10916
|
list(request?: {
|
|
10650
10917
|
/** V1 error format. */
|
|
10651
10918
|
'$.xgafv'?: string;
|
|
@@ -10766,6 +11033,7 @@ declare namespace gapi.client {
|
|
|
10766
11033
|
glossaries: GlossariesResource;
|
|
10767
11034
|
governanceRules: GovernanceRulesResource;
|
|
10768
11035
|
lakes: LakesResource;
|
|
11036
|
+
metadataFeeds: MetadataFeedsResource;
|
|
10769
11037
|
metadataJobs: MetadataJobsResource;
|
|
10770
11038
|
operations: OperationsResource;
|
|
10771
11039
|
}
|