|
12 | 12 | "baseUrl": "https://dataplex.googleapis.com/",
|
13 | 13 | "batchPath": "batch",
|
14 | 14 | "canonicalName": "Cloud Dataplex",
|
15 |
| - "description": "Dataplex API is used to manage the lifecycle of data lakes.", |
| 15 | + "description": "A unified, intelligent governance solution for data and AI assets.", |
16 | 16 | "discoveryVersion": "v1",
|
17 | 17 | "documentationLink": "https://cloud.google.com/dataplex/docs",
|
18 | 18 | "endpoints": [
|
|
902 | 902 | "type": "string"
|
903 | 903 | },
|
904 | 904 | "query": {
|
905 |
| - "description": "Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog (https://cloud.google.com/dataplex/docs/search-syntax).", |
| 905 | + "description": "Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/search-syntax).", |
906 | 906 | "location": "query",
|
907 | 907 | "type": "string"
|
908 | 908 | },
|
|
6973 | 6973 | ]
|
6974 | 6974 | },
|
6975 | 6975 | "create": {
|
6976 |
| - "description": "Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.", |
| 6976 | + "description": "Creates a metadata job. For example, use a metadata job to import metadata from a third-party system into Dataplex Universal Catalog.", |
6977 | 6977 | "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs",
|
6978 | 6978 | "httpMethod": "POST",
|
6979 | 6979 | "id": "dataplex.projects.locations.metadataJobs.create",
|
|
7211 | 7211 | }
|
7212 | 7212 | }
|
7213 | 7213 | },
|
7214 |
| - "revision": "20250729", |
| 7214 | + "revision": "20250805", |
7215 | 7215 | "rootUrl": "https://dataplex.googleapis.com/",
|
7216 | 7216 | "schemas": {
|
7217 | 7217 | "Empty": {
|
|
7567 | 7567 | "id": "GoogleCloudDataplexV1AspectTypeAuthorization",
|
7568 | 7568 | "properties": {
|
7569 | 7569 | "alternateUsePermission": {
|
7570 |
| - "description": "Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex owned AspectTypes, only settable for Dataplex owned Types.", |
| 7570 | + "description": "Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex Universal Catalog owned AspectTypes, only settable for Dataplex Universal Catalog owned Types.", |
7571 | 7571 | "type": "string"
|
7572 | 7572 | }
|
7573 | 7573 | },
|
|
8680 | 8680 | "description": "Profile information for the corresponding field."
|
8681 | 8681 | },
|
8682 | 8682 | "type": {
|
8683 |
| - "description": "The data type retrieved from the schema of the data source. For instance, for a BigQuery native table, it is the BigQuery Table Schema (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema). For a Dataplex Entity, it is the Entity Schema (https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3).", |
| 8683 | + "description": "The data type retrieved from the schema of the data source. For instance, for a BigQuery native table, it is the BigQuery Table Schema (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema). For a Dataplex Universal Catalog Entity, it is the Entity Schema (https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3).", |
8684 | 8684 | "type": "string"
|
8685 | 8685 | }
|
8686 | 8686 | },
|
|
8970 | 8970 | "properties": {
|
8971 | 8971 | "catalogPublishingStatus": {
|
8972 | 8972 | "$ref": "GoogleCloudDataplexV1DataScanCatalogPublishingStatus",
|
8973 |
| - "description": "Output only. The status of publishing the data scan to Catalog.", |
| 8973 | + "description": "Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.", |
8974 | 8974 | "readOnly": true
|
8975 | 8975 | },
|
8976 | 8976 | "columns": {
|
|
9437 | 9437 | "id": "GoogleCloudDataplexV1DataQualitySpec",
|
9438 | 9438 | "properties": {
|
9439 | 9439 | "catalogPublishingEnabled": {
|
9440 |
| - "description": "Optional. If set, the latest DataScan job result will be published to Dataplex Catalog.", |
| 9440 | + "description": "Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.", |
9441 | 9441 | "type": "boolean"
|
9442 | 9442 | },
|
9443 | 9443 | "postScanActions": {
|
|
9671 | 9671 | "type": "object"
|
9672 | 9672 | },
|
9673 | 9673 | "GoogleCloudDataplexV1DataScanCatalogPublishingStatus": {
|
9674 |
| - "description": "The status of publishing the data scan result to Catalog.", |
| 9674 | + "description": "The status of publishing the data scan result as Dataplex Universal Catalog metadata.", |
9675 | 9675 | "id": "GoogleCloudDataplexV1DataScanCatalogPublishingStatus",
|
9676 | 9676 | "properties": {
|
9677 | 9677 | "state": {
|
|
9698 | 9698 | "properties": {
|
9699 | 9699 | "catalogPublishingStatus": {
|
9700 | 9700 | "$ref": "GoogleCloudDataplexV1DataScanCatalogPublishingStatus",
|
9701 |
| - "description": "The status of publishing the data scan to Catalog." |
| 9701 | + "description": "The status of publishing the data scan as Dataplex Universal Catalog metadata." |
9702 | 9702 | },
|
9703 | 9703 | "createTime": {
|
9704 | 9704 | "description": "The time when the data scan job was created.",
|
|
10100 | 10100 | "id": "GoogleCloudDataplexV1DataSource",
|
10101 | 10101 | "properties": {
|
10102 | 10102 | "entity": {
|
10103 |
| - "description": "Immutable. The Dataplex 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}.", |
| 10103 | + "description": "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}.", |
10104 | 10104 | "type": "string"
|
10105 | 10105 | },
|
10106 | 10106 | "resource": {
|
|
10605 | 10605 | "type": "object"
|
10606 | 10606 | },
|
10607 | 10607 | "createTime": {
|
10608 |
| - "description": "Output only. The time when the entry was created in Dataplex.", |
| 10608 | + "description": "Output only. The time when the entry was created in Dataplex Universal Catalog.", |
10609 | 10609 | "format": "google-datetime",
|
10610 | 10610 | "readOnly": true,
|
10611 | 10611 | "type": "string"
|
|
10631 | 10631 | "type": "string"
|
10632 | 10632 | },
|
10633 | 10633 | "updateTime": {
|
10634 |
| - "description": "Output only. The time when the entry was last updated in Dataplex.", |
| 10634 | + "description": "Output only. The time when the entry was last updated in Dataplex Universal Catalog.", |
10635 | 10635 | "format": "google-datetime",
|
10636 | 10636 | "readOnly": true,
|
10637 | 10637 | "type": "string"
|
|
10955 | 10955 | "id": "GoogleCloudDataplexV1EntryTypeAuthorization",
|
10956 | 10956 | "properties": {
|
10957 | 10957 | "alternateUsePermission": {
|
10958 |
| - "description": "Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex owned Entry Types, only settable for Dataplex owned Types.", |
| 10958 | + "description": "Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex Universal Catalog owned Entry Types, only settable for Dataplex Universal Catalog owned Types.", |
10959 | 10959 | "type": "string"
|
10960 | 10960 | }
|
10961 | 10961 | },
|
|
11101 | 11101 | "id": "GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime",
|
11102 | 11102 | "properties": {
|
11103 | 11103 | "imageVersion": {
|
11104 |
| - "description": "Required. Dataplex Image version.", |
| 11104 | + "description": "Required. Dataplex Universal Catalog Image version.", |
11105 | 11105 | "type": "string"
|
11106 | 11106 | },
|
11107 | 11107 | "javaLibraries": {
|
|
11167 | 11167 | "id": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse",
|
11168 | 11168 | "properties": {
|
11169 | 11169 | "rule": {
|
11170 |
| - "description": "The data quality rules that Dataplex generates based on the results of a data profiling scan.", |
| 11170 | + "description": "The data quality rules that Dataplex Universal Catalog generates based on the results of a data profiling scan.", |
11171 | 11171 | "items": {
|
11172 | 11172 | "$ref": "GoogleCloudDataplexV1DataQualityRule"
|
11173 | 11173 | },
|
|
11419 | 11419 | "id": "GoogleCloudDataplexV1ImportItem",
|
11420 | 11420 | "properties": {
|
11421 | 11421 | "aspectKeys": {
|
11422 |
| - "description": "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 implicitly adds the keys for all of the required aspects of an entry.", |
| 11422 | + "description": "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.", |
11423 | 11423 | "items": {
|
11424 | 11424 | "type": "string"
|
11425 | 11425 | },
|
|
11434 | 11434 | "description": "Information about the entry link. User should provide either one of the entry or entry_link. While providing entry_link, user should not provide update_mask and aspect_keys."
|
11435 | 11435 | },
|
11436 | 11436 | "updateMask": {
|
11437 |
| - "description": "The fields to update, in paths that are relative to the Entry resource. Separate each field with a comma.In FULL entry sync mode, Dataplex includes the paths of all of the fields for an entry that can be modified, including aspects. This means that Dataplex replaces the existing entry with the entry in the metadata import file. All modifiable fields are updated, regardless of the fields that are listed in the update mask, and regardless of whether a field is present in the entry object.The update_mask field is ignored when an entry is created or re-created.In an aspect-only metadata job (when entry sync mode is NONE), set this value to aspects.Dataplex also determines which entries and aspects to modify by comparing the values and timestamps that you provide in the metadata import file with the values and timestamps that exist in your project. For more information, see Comparison logic (https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic).", |
| 11437 | + "description": "The fields to update, in paths that are relative to the Entry resource. Separate each field with a comma.In FULL entry sync mode, Dataplex Universal Catalog includes the paths of all of the fields for an entry that can be modified, including aspects. This means that Dataplex Universal Catalog replaces the existing entry with the entry in the metadata import file. All modifiable fields are updated, regardless of the fields that are listed in the update mask, and regardless of whether a field is present in the entry object.The update_mask field is ignored when an entry is created or re-created.In an aspect-only metadata job (when entry sync mode is NONE), set this value to aspects.Dataplex Universal Catalog also determines which entries and aspects to modify by comparing the values and timestamps that you provide in the metadata import file with the values and timestamps that exist in your project. For more information, see Comparison logic (https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic).", |
11438 | 11438 | "format": "google-fieldmask",
|
11439 | 11439 | "type": "string"
|
11440 | 11440 | }
|
|
11522 | 11522 | "The job cancellation was successful.",
|
11523 | 11523 | "The job completed successfully.",
|
11524 | 11524 | "The job is no longer running due to an error.",
|
11525 |
| - "The job was cancelled outside of Dataplex." |
| 11525 | + "The job was cancelled outside of Dataplex Universal Catalog." |
11526 | 11526 | ],
|
11527 | 11527 | "readOnly": true,
|
11528 | 11528 | "type": "string"
|
|
11536 | 11536 | ],
|
11537 | 11537 | "enumDescriptions": [
|
11538 | 11538 | "The trigger is unspecified.",
|
11539 |
| - "The job was triggered by Dataplex based on trigger spec from task definition.", |
| 11539 | + "The job was triggered by Dataplex Universal Catalog based on trigger spec from task definition.", |
11540 | 11540 | "The job was triggered by the explicit call of Task API."
|
11541 | 11541 | ],
|
11542 | 11542 | "readOnly": true,
|
|
11568 | 11568 | ],
|
11569 | 11569 | "enumDescriptions": [
|
11570 | 11570 | "The job execution trigger is unspecified.",
|
11571 |
| - "The job was triggered by Dataplex based on trigger spec from task definition.", |
| 11571 | + "The job was triggered by Dataplex Universal Catalog based on trigger spec from task definition.", |
11572 | 11572 | "The job was triggered by the explicit call of Task API."
|
11573 | 11573 | ],
|
11574 | 11574 | "type": "string"
|
|
12417 | 12417 | "id": "GoogleCloudDataplexV1MetadataJobExportJobSpec",
|
12418 | 12418 | "properties": {
|
12419 | 12419 | "outputPath": {
|
12420 |
| - "description": "Required. The root path of the Cloud Storage bucket to export the metadata to, in the format gs://{bucket}/. You can optionally specify a custom prefix after the bucket name, in the format gs://{bucket}/{prefix}/. The maximum length of the custom prefix is 128 characters. Dataplex constructs the object path for the exported files by using the bucket name and prefix that you provide, followed by a system-generated path.The bucket must be in the same VPC Service Controls perimeter as the job.", |
| 12420 | + "description": "Required. The root path of the Cloud Storage bucket to export the metadata to, in the format gs://{bucket}/. You can optionally specify a custom prefix after the bucket name, in the format gs://{bucket}/{prefix}/. The maximum length of the custom prefix is 128 characters. Dataplex Universal Catalog constructs the object path for the exported files by using the bucket name and prefix that you provide, followed by a system-generated path.The bucket must be in the same VPC Service Controls perimeter as the job.", |
12421 | 12421 | "type": "string"
|
12422 | 12422 | },
|
12423 | 12423 | "scope": {
|
|
12541 | 12541 | ],
|
12542 | 12542 | "enumDescriptions": [
|
12543 | 12543 | "Sync mode unspecified.",
|
12544 |
| - "All resources in the job's scope are modified. If a resource exists in Dataplex but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.This sync mode is supported for entries.", |
| 12544 | + "All resources in the job's scope are modified. If a resource exists in Dataplex Universal Catalog but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.This sync mode is supported for entries.", |
12545 | 12545 | "Only the resources that are explicitly included in the metadata import file are modified. Use this mode to modify a subset of resources while leaving unreferenced resources unchanged.This sync mode is supported for aspects.",
|
12546 | 12546 | "If entry sync mode is NONE, then aspects are modified according to the aspect sync mode. Other metadata that belongs to entries in the job's scope isn't modified.This sync mode is supported for entries."
|
12547 | 12547 | ],
|
|
12557 | 12557 | ],
|
12558 | 12558 | "enumDescriptions": [
|
12559 | 12559 | "Sync mode unspecified.",
|
12560 |
| - "All resources in the job's scope are modified. If a resource exists in Dataplex but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.This sync mode is supported for entries.", |
| 12560 | + "All resources in the job's scope are modified. If a resource exists in Dataplex Universal Catalog but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.This sync mode is supported for entries.", |
12561 | 12561 | "Only the resources that are explicitly included in the metadata import file are modified. Use this mode to modify a subset of resources while leaving unreferenced resources unchanged.This sync mode is supported for aspects.",
|
12562 | 12562 | "If entry sync mode is NONE, then aspects are modified according to the aspect sync mode. Other metadata that belongs to entries in the job's scope isn't modified.This sync mode is supported for entries."
|
12563 | 12563 | ],
|
|
12899 | 12899 | "type": "string"
|
12900 | 12900 | },
|
12901 | 12901 | "userManaged": {
|
12902 |
| - "description": "Required. Set to true if user-managed or false if managed by Dataplex. The default is false (managed by Dataplex). Set to falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields.", |
| 12902 | + "description": "Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). Set to falseto enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.", |
12903 | 12903 | "type": "boolean"
|
12904 | 12904 | }
|
12905 | 12905 | },
|
|
0 commit comments