@maxim_mazurok/gapi.client.dataplex-v1 0.3.20261005 → 0.3.20261012

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 +191 -4
  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: 20261005
12
+ // Revision: 20261012
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -193,7 +193,7 @@ declare namespace gapi.client {
193
193
  displayName?: string;
194
194
  /** Optional. Display order for a field. You can use this to reorder where a field is rendered. */
195
195
  displayOrder?: number;
196
- /** Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference. */
196
+ /** Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. markdown: The field must be interpreted as a markdown field. url: A fully qualified URL link. resource: A service qualified resource reference. */
197
197
  stringType?: string;
198
198
  /** Optional. Suggested hints for string fields. You can use them to suggest values to users through console. */
199
199
  stringValues?: string[];
@@ -336,6 +336,44 @@ declare namespace gapi.client {
336
336
  /** Last update time of the status. */
337
337
  updateTime?: string;
338
338
  }
339
+ interface GoogleCloudDataplexV1BatchChangeMetadataRequest {
340
+ /** Required. The list of changes to apply. Only a single change per resource is supported. Maximum number of changes supported is 250. */
341
+ changes?: GoogleCloudDataplexV1BatchChangeMetadataRequestChange[];
342
+ /** Optional. Text description of the batch change. */
343
+ description?: GoogleCloudDataplexV1BatchChangeMetadataRequestDescription;
344
+ /** Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} */
345
+ name?: string;
346
+ }
347
+ interface GoogleCloudDataplexV1BatchChangeMetadataRequestChange {
348
+ /** Payload for creating an EntryLink. */
349
+ createEntryLinkRequest?: GoogleCloudDataplexV1CreateEntryLinkRequest;
350
+ /** Payload for creating an Entry. */
351
+ createEntryRequest?: GoogleCloudDataplexV1CreateEntryRequest;
352
+ /** Payload for deleting an EntryLink. */
353
+ deleteEntryLinkRequest?: GoogleCloudDataplexV1DeleteEntryLinkRequest;
354
+ /** Payload for deleting an Entry. */
355
+ deleteEntryRequest?: GoogleCloudDataplexV1DeleteEntryRequest;
356
+ /** Payload for updating an EntryLink. */
357
+ updateEntryLinkRequest?: GoogleCloudDataplexV1UpdateEntryLinkRequest;
358
+ /** Payload for updating an Entry. */
359
+ updateEntryRequest?: GoogleCloudDataplexV1UpdateEntryRequest;
360
+ }
361
+ interface GoogleCloudDataplexV1BatchChangeMetadataRequestDescription {
362
+ /** Optional. The text description content. */
363
+ content?: string;
364
+ /** Optional. The job that created the batch change. */
365
+ job?: GoogleCloudDataplexV1BatchChangeMetadataRequestDescriptionJob;
366
+ }
367
+ interface GoogleCloudDataplexV1BatchChangeMetadataRequestDescriptionJob {
368
+ /** Optional. The name of the job that created the batch change. For example: projects/{project_number}/locations/{location_id}/enrichmentTasks/{enrichment_task_id}/runs/{enrichment_run_id} */
369
+ name?: string;
370
+ /** Optional. The start time of the job run that created the batch change. */
371
+ runTime?: string;
372
+ }
373
+ interface GoogleCloudDataplexV1BatchChangeMetadataResponse {
374
+ /** A map of failed requests for a batch change, where the key is the 0-based index of the failed request in the batch and the value is the error status. If all operations succeeded, this map is empty. */
375
+ failedRequests?: {[P in string]: GoogleRpcStatus};
376
+ }
339
377
  interface GoogleCloudDataplexV1BusinessGlossaryEvent {
340
378
  /** The type of the event. */
341
379
  eventType?:
@@ -363,6 +401,10 @@ declare namespace gapi.client {
363
401
  approver?: string;
364
402
  /** Output only. The email address of the user who created the ChangeRequest. */
365
403
  author?: string;
404
+ /** Payload for executing a batch of catalog changes. */
405
+ batchChangeMetadataRequest?: GoogleCloudDataplexV1BatchChangeMetadataRequest;
406
+ /** Output only. Result of applying a batch change metadata request. */
407
+ batchChangeMetadataResponse?: GoogleCloudDataplexV1BatchChangeMetadataResponse;
366
408
  /** Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. */
367
409
  changeType?:
368
410
  | 'CHANGE_TYPE_UNSPECIFIED'
@@ -380,7 +422,8 @@ declare namespace gapi.client {
380
422
  | 'CREATE_GLOSSARY_TERM'
381
423
  | 'UPDATE_GLOSSARY_TERM'
382
424
  | 'DELETE_GLOSSARY_TERM'
383
- | 'REQUEST_DATA_PRODUCT_ACCESS';
425
+ | 'REQUEST_DATA_PRODUCT_ACCESS'
426
+ | 'BATCH_CHANGE_METADATA';
384
427
  /** Payload for creating an Entry. */
385
428
  createEntry?: GoogleCloudDataplexV1CreateEntryRequest;
386
429
  /** Payload for creating an EntryLink. */
@@ -426,7 +469,9 @@ declare namespace gapi.client {
426
469
  | 'APPROVED'
427
470
  | 'REJECTED'
428
471
  | 'EXPIRED'
429
- | 'REVOKED';
472
+ | 'REVOKED'
473
+ | 'APPLYING'
474
+ | 'FAILED';
430
475
  /** Output only. System generated globally unique ID for the ChangeRequest. */
431
476
  uid?: string;
432
477
  /** Payload for updating an Entry. */
@@ -1662,6 +1707,8 @@ declare namespace gapi.client {
1662
1707
  updateTime?: string;
1663
1708
  }
1664
1709
  interface GoogleCloudDataplexV1EntryGroup {
1710
+ /** Optional. Specifies the configuration for requesting changes in the metadata belonging to the Entry Group. */
1711
+ changeRequestConfig?: GoogleCloudDataplexV1EntryGroupChangeRequestConfig;
1665
1712
  /** Output only. The time when the EntryGroup was created. */
1666
1713
  createTime?: string;
1667
1714
  /** Optional. Description of the EntryGroup. */
@@ -1684,6 +1731,10 @@ declare namespace gapi.client {
1684
1731
  /** Output only. The time when the EntryGroup was last updated. */
1685
1732
  updateTime?: string;
1686
1733
  }
1734
+ interface GoogleCloudDataplexV1EntryGroupChangeRequestConfig {
1735
+ /** Optional. Specifies the email addresses of users who are potential approvers and are notified when a change request is created for the metadata belonging to the Entry Group. The maximum number of emails allowed is 10. */
1736
+ approverEmails?: string[];
1737
+ }
1687
1738
  interface GoogleCloudDataplexV1EntryLink {
1688
1739
  /** Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. */
1689
1740
  aspects?: {[P in string]: GoogleCloudDataplexV1Aspect};
@@ -2397,6 +2448,18 @@ declare namespace gapi.client {
2397
2448
  /** Optional. The etag of the ChangeRequest. */
2398
2449
  etag?: string;
2399
2450
  }
2451
+ interface GoogleCloudDataplexV1RequestBatchMetadataChangeRequest {
2452
+ /** Required. The detailed specification of the proposed changes. This payload is intended to be embedded as the change_payload in the resulting ChangeRequest. */
2453
+ changePayload?: GoogleCloudDataplexV1BatchChangeMetadataRequest;
2454
+ /** Optional. Justification for the metadata change request. */
2455
+ justification?: string;
2456
+ /** Optional. User-defined labels for the metadata change request. */
2457
+ labels?: {[P in string]: string};
2458
+ }
2459
+ interface GoogleCloudDataplexV1RequestBatchMetadataChangeResponse {
2460
+ /** The resource name of the created ChangeRequest. Format: projects/{project}/locations/{location}/changeRequests/{change_request} */
2461
+ changeRequest?: string;
2462
+ }
2400
2463
  interface GoogleCloudDataplexV1RequestDataProductAccessRequest {
2401
2464
  /** Required. The change request for the data product access request. */
2402
2465
  changeRequest?: GoogleCloudDataplexV1ChangeRequest;
@@ -2736,6 +2799,14 @@ declare namespace gapi.client {
2736
2799
  /** 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. */
2737
2800
  cron?: string;
2738
2801
  }
2802
+ interface GoogleCloudDataplexV1UpdateEntryLinkRequest {
2803
+ /** Optional. If set to true and the entry link doesn't exist, the service will create it. */
2804
+ allowMissing?: boolean;
2805
+ /** Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. */
2806
+ aspectKeys?: string[];
2807
+ /** Required. Entry Link resource. */
2808
+ entryLink?: GoogleCloudDataplexV1EntryLink;
2809
+ }
2739
2810
  interface GoogleCloudDataplexV1UpdateEntryRequest {
2740
2811
  /** Optional. If set to true and the entry doesn't exist, the service will create it. */
2741
2812
  allowMissing?: boolean;
@@ -6544,6 +6615,64 @@ declare namespace gapi.client {
6544
6615
  ): Request<GoogleCloudDataplexV1EntryLink>;
6545
6616
  }
6546
6617
  interface EntryGroupsResource {
6618
+ /** Batch changes metadata within an EntryGroup. */
6619
+ batchChangeMetadata(request: {
6620
+ /** V1 error format. */
6621
+ '$.xgafv'?: '1' | '2';
6622
+ /** OAuth access token. */
6623
+ access_token?: string;
6624
+ /** Data format for response. */
6625
+ alt?: 'json' | 'media' | 'proto';
6626
+ /** JSONP */
6627
+ callback?: string;
6628
+ /** Selector specifying which fields to include in a partial response. */
6629
+ fields?: string;
6630
+ /** 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. */
6631
+ key?: string;
6632
+ /** Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} */
6633
+ name: string;
6634
+ /** OAuth 2.0 token for the current user. */
6635
+ oauth_token?: string;
6636
+ /** Returns response with indentations and line breaks. */
6637
+ prettyPrint?: boolean;
6638
+ /** 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. */
6639
+ quotaUser?: string;
6640
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6641
+ upload_protocol?: string;
6642
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6643
+ uploadType?: string;
6644
+ /** Request body */
6645
+ resource: GoogleCloudDataplexV1BatchChangeMetadataRequest;
6646
+ }): Request<GoogleLongrunningOperation>;
6647
+ batchChangeMetadata(
6648
+ request: {
6649
+ /** V1 error format. */
6650
+ '$.xgafv'?: '1' | '2';
6651
+ /** OAuth access token. */
6652
+ access_token?: string;
6653
+ /** Data format for response. */
6654
+ alt?: 'json' | 'media' | 'proto';
6655
+ /** JSONP */
6656
+ callback?: string;
6657
+ /** Selector specifying which fields to include in a partial response. */
6658
+ fields?: string;
6659
+ /** 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. */
6660
+ key?: string;
6661
+ /** Required. The resource name of the EntryGroup on which the batch change applies. Format: projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id} */
6662
+ name: string;
6663
+ /** OAuth 2.0 token for the current user. */
6664
+ oauth_token?: string;
6665
+ /** Returns response with indentations and line breaks. */
6666
+ prettyPrint?: boolean;
6667
+ /** 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. */
6668
+ quotaUser?: string;
6669
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6670
+ upload_protocol?: string;
6671
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6672
+ uploadType?: string;
6673
+ },
6674
+ body: GoogleCloudDataplexV1BatchChangeMetadataRequest,
6675
+ ): Request<GoogleLongrunningOperation>;
6547
6676
  /** Creates an EntryGroup. */
6548
6677
  create(request: {
6549
6678
  /** V1 error format. */
@@ -6796,6 +6925,64 @@ declare namespace gapi.client {
6796
6925
  },
6797
6926
  body: GoogleCloudDataplexV1EntryGroup,
6798
6927
  ): Request<GoogleLongrunningOperation>;
6928
+ /** Submits a catalog change request for multiple resources within an EntryGroup. This method creates a ChangeRequest resource that must be reviewed and approved before the proposed changes are applied. */
6929
+ requestBatchMetadataChange(request: {
6930
+ /** V1 error format. */
6931
+ '$.xgafv'?: '1' | '2';
6932
+ /** OAuth access token. */
6933
+ access_token?: string;
6934
+ /** Data format for response. */
6935
+ alt?: 'json' | 'media' | 'proto';
6936
+ /** JSONP */
6937
+ callback?: string;
6938
+ /** Selector specifying which fields to include in a partial response. */
6939
+ fields?: string;
6940
+ /** 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. */
6941
+ key?: string;
6942
+ /** Required. The resource name of the Entry Group on which the change applies. Format: projects/{project}/locations/{location}/entryGroups/{entry_group} */
6943
+ name: string;
6944
+ /** OAuth 2.0 token for the current user. */
6945
+ oauth_token?: string;
6946
+ /** Returns response with indentations and line breaks. */
6947
+ prettyPrint?: boolean;
6948
+ /** 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. */
6949
+ quotaUser?: string;
6950
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6951
+ upload_protocol?: string;
6952
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6953
+ uploadType?: string;
6954
+ /** Request body */
6955
+ resource: GoogleCloudDataplexV1RequestBatchMetadataChangeRequest;
6956
+ }): Request<GoogleCloudDataplexV1RequestBatchMetadataChangeResponse>;
6957
+ requestBatchMetadataChange(
6958
+ request: {
6959
+ /** V1 error format. */
6960
+ '$.xgafv'?: '1' | '2';
6961
+ /** OAuth access token. */
6962
+ access_token?: string;
6963
+ /** Data format for response. */
6964
+ alt?: 'json' | 'media' | 'proto';
6965
+ /** JSONP */
6966
+ callback?: string;
6967
+ /** Selector specifying which fields to include in a partial response. */
6968
+ fields?: string;
6969
+ /** 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. */
6970
+ key?: string;
6971
+ /** Required. The resource name of the Entry Group on which the change applies. Format: projects/{project}/locations/{location}/entryGroups/{entry_group} */
6972
+ name: string;
6973
+ /** OAuth 2.0 token for the current user. */
6974
+ oauth_token?: string;
6975
+ /** Returns response with indentations and line breaks. */
6976
+ prettyPrint?: boolean;
6977
+ /** 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. */
6978
+ quotaUser?: string;
6979
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6980
+ upload_protocol?: string;
6981
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6982
+ uploadType?: string;
6983
+ },
6984
+ body: GoogleCloudDataplexV1RequestBatchMetadataChangeRequest,
6985
+ ): Request<GoogleCloudDataplexV1RequestBatchMetadataChangeResponse>;
6799
6986
  /** Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. */
6800
6987
  setIamPolicy(
6801
6988
  request: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.dataplex-v1",
3
- "version": "0.3.20261005",
3
+ "version": "0.3.20261012",
4
4
  "description": "TypeScript typings for Cloud Dataplex API v1",
5
5
  "repository": {
6
6
  "type": "git",