diff --git a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/catalog.proto b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/catalog.proto index 76bf4dda7a6..36c4cc73305 100644 --- a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/catalog.proto +++ b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/catalog.proto @@ -1220,7 +1220,7 @@ message UpdateEntryRequest { // specified path. For example, to attach an aspect to a field that is // specified by the `schema` aspect, the path should have the format // `Schema.`. - // * `*` - matches aspects of the given type for all + // * `@*` - matches aspects of the given type for all // paths. // * `*@path` - matches aspects of all types on the given path. // @@ -1356,6 +1356,8 @@ message SearchEntriesRequest { ]; // 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). string query = 2 [(google.api.field_behavior) = REQUIRED]; // Optional. Number of results in the search page. If <=0, then defaults @@ -1368,6 +1370,10 @@ message SearchEntriesRequest { string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. Specifies the ordering of results. + // Supported values are: + // * `relevance` (default) + // * `last_modified_timestamp` + // * `last_modified_timestamp asc` string order_by = 5 [(google.api.field_behavior) = OPTIONAL]; // Optional. The scope under which the search should be operating. It must @@ -1452,9 +1458,9 @@ message ImportItem { // 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 that belong to the specified - // aspect type for all paths. - // + // * `@*` : 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}`. diff --git a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/datascans.proto b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/datascans.proto index 54a6aca13bc..fc792f4577a 100644 --- a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/datascans.proto +++ b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/datascans.proto @@ -19,6 +19,7 @@ package google.cloud.dataplex.v1; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; +import "google/api/field_info.proto"; import "google/api/resource.proto"; import "google/cloud/dataplex/v1/data_discovery.proto"; import "google/cloud/dataplex/v1/data_profile.proto"; @@ -182,9 +183,9 @@ message UpdateDataScanRequest { // Only fields specified in `update_mask` are updated. DataScan data_scan = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. Mask of fields to update. + // Optional. Mask of fields to update. google.protobuf.FieldMask update_mask = 2 - [(google.api.field_behavior) = REQUIRED]; + [(google.api.field_behavior) = OPTIONAL]; // Optional. Only validate the request, but do not perform mutations. // The default is `false`. @@ -203,6 +204,11 @@ message DeleteDataScanRequest { type: "dataplex.googleapis.com/DataScan" } ]; + + // Optional. If set to true, any child resources of this data scan will also + // be deleted. (Otherwise, the request will only work if the data scan has no + // child resources.) + bool force = 2 [(google.api.field_behavior) = OPTIONAL]; } // Get dataScan request. @@ -443,26 +449,34 @@ message DataScan { // Status of the data scan execution. message ExecutionStatus { - // The time when the latest DataScanJob started. - google.protobuf.Timestamp latest_job_start_time = 4; + // Optional. The time when the latest DataScanJob started. + google.protobuf.Timestamp latest_job_start_time = 4 + [(google.api.field_behavior) = OPTIONAL]; - // The time when the latest DataScanJob ended. - google.protobuf.Timestamp latest_job_end_time = 5; + // Optional. The time when the latest DataScanJob ended. + google.protobuf.Timestamp latest_job_end_time = 5 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The time when the DataScanJob execution was created. google.protobuf.Timestamp latest_job_create_time = 6 [(google.api.field_behavior) = OPTIONAL]; } - // Output only. The relative resource name of the scan, of the form: - // `projects/{project}/locations/{location_id}/dataScans/{datascan_id}`, + // Output only. Identifier. The relative resource name of the scan, of the + // form: `projects/{project}/locations/{location_id}/dataScans/{datascan_id}`, // where `project` refers to a *project_id* or *project_number* and // `location_id` refers to a GCP region. - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + string name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.field_behavior) = IDENTIFIER + ]; // 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. - string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + string uid = 2 [ + (google.api.field_info).format = UUID4, + (google.api.field_behavior) = OUTPUT_ONLY + ]; // Optional. Description of the scan. // @@ -565,14 +579,21 @@ message DataScanJob { PENDING = 7; } - // Output only. The relative resource name of the DataScanJob, of the form: + // Output only. Identifier. The relative resource name of the DataScanJob, of + // the form: // `projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}`, // where `project` refers to a *project_id* or *project_number* and // `location_id` refers to a GCP region. - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + string name = 1 [ + (google.api.field_behavior) = OUTPUT_ONLY, + (google.api.field_behavior) = IDENTIFIER + ]; // Output only. System generated globally unique ID for the DataScanJob. - string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + string uid = 2 [ + (google.api.field_info).format = UUID4, + (google.api.field_behavior) = OUTPUT_ONLY + ]; // Output only. The time when the DataScanJob was created. google.protobuf.Timestamp create_time = 8 diff --git a/packages/google-cloud-dataplex/protos/protos.d.ts b/packages/google-cloud-dataplex/protos/protos.d.ts index e309b56ecfb..be72b699309 100644 --- a/packages/google-cloud-dataplex/protos/protos.d.ts +++ b/packages/google-cloud-dataplex/protos/protos.d.ts @@ -28404,6 +28404,9 @@ export namespace google { /** DeleteDataScanRequest name */ name?: (string|null); + + /** DeleteDataScanRequest force */ + force?: (boolean|null); } /** Represents a DeleteDataScanRequest. */ @@ -28418,6 +28421,9 @@ export namespace google { /** DeleteDataScanRequest name. */ public name: string; + /** DeleteDataScanRequest force. */ + public force: boolean; + /** * Creates a new DeleteDataScanRequest instance using the specified properties. * @param [properties] Properties to set diff --git a/packages/google-cloud-dataplex/protos/protos.js b/packages/google-cloud-dataplex/protos/protos.js index 20ea000baa6..55da3d4847c 100644 --- a/packages/google-cloud-dataplex/protos/protos.js +++ b/packages/google-cloud-dataplex/protos/protos.js @@ -69310,6 +69310,7 @@ * @memberof google.cloud.dataplex.v1 * @interface IDeleteDataScanRequest * @property {string|null} [name] DeleteDataScanRequest name + * @property {boolean|null} [force] DeleteDataScanRequest force */ /** @@ -69335,6 +69336,14 @@ */ DeleteDataScanRequest.prototype.name = ""; + /** + * DeleteDataScanRequest force. + * @member {boolean} force + * @memberof google.cloud.dataplex.v1.DeleteDataScanRequest + * @instance + */ + DeleteDataScanRequest.prototype.force = false; + /** * Creates a new DeleteDataScanRequest instance using the specified properties. * @function create @@ -69361,6 +69370,8 @@ writer = $Writer.create(); if (message.name != null && Object.hasOwnProperty.call(message, "name")) writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); + if (message.force != null && Object.hasOwnProperty.call(message, "force")) + writer.uint32(/* id 2, wireType 0 =*/16).bool(message.force); return writer; }; @@ -69399,6 +69410,10 @@ message.name = reader.string(); break; } + case 2: { + message.force = reader.bool(); + break; + } default: reader.skipType(tag & 7); break; @@ -69437,6 +69452,9 @@ if (message.name != null && message.hasOwnProperty("name")) if (!$util.isString(message.name)) return "name: string expected"; + if (message.force != null && message.hasOwnProperty("force")) + if (typeof message.force !== "boolean") + return "force: boolean expected"; return null; }; @@ -69454,6 +69472,8 @@ var message = new $root.google.cloud.dataplex.v1.DeleteDataScanRequest(); if (object.name != null) message.name = String(object.name); + if (object.force != null) + message.force = Boolean(object.force); return message; }; @@ -69470,10 +69490,14 @@ if (!options) options = {}; var object = {}; - if (options.defaults) + if (options.defaults) { object.name = ""; + object.force = false; + } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; + if (message.force != null && message.hasOwnProperty("force")) + object.force = message.force; return object; }; diff --git a/packages/google-cloud-dataplex/protos/protos.json b/packages/google-cloud-dataplex/protos/protos.json index 940f473fced..472c048e1e6 100644 --- a/packages/google-cloud-dataplex/protos/protos.json +++ b/packages/google-cloud-dataplex/protos/protos.json @@ -8918,7 +8918,7 @@ "type": "google.protobuf.FieldMask", "id": 2, "options": { - "(google.api.field_behavior)": "REQUIRED" + "(google.api.field_behavior)": "OPTIONAL" } }, "validateOnly": { @@ -8939,6 +8939,13 @@ "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "dataplex.googleapis.com/DataScan" } + }, + "force": { + "type": "bool", + "id": 2, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } } } }, @@ -9168,13 +9175,14 @@ "type": "string", "id": 1, "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" + "(google.api.field_behavior)": "IDENTIFIER" } }, "uid": { "type": "string", "id": 2, "options": { + "(google.api.field_info).format": "UUID4", "(google.api.field_behavior)": "OUTPUT_ONLY" } }, @@ -9313,11 +9321,17 @@ "fields": { "latestJobStartTime": { "type": "google.protobuf.Timestamp", - "id": 4 + "id": 4, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } }, "latestJobEndTime": { "type": "google.protobuf.Timestamp", - "id": 5 + "id": 5, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } }, "latestJobCreateTime": { "type": "google.protobuf.Timestamp", @@ -9356,13 +9370,14 @@ "type": "string", "id": 1, "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" + "(google.api.field_behavior)": "IDENTIFIER" } }, "uid": { "type": "string", "id": 2, "options": { + "(google.api.field_info).format": "UUID4", "(google.api.field_behavior)": "OUTPUT_ONLY" } }, diff --git a/packages/google-cloud-dataplex/samples/generated/v1/catalog_service.search_entries.js b/packages/google-cloud-dataplex/samples/generated/v1/catalog_service.search_entries.js index d2a3d980ded..ff91e97bdeb 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/catalog_service.search_entries.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/catalog_service.search_entries.js @@ -35,6 +35,8 @@ function main(name, query) { // const name = 'abc123' /** * 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). */ // const query = 'abc123' /** @@ -50,6 +52,10 @@ function main(name, query) { // const pageToken = 'abc123' /** * Optional. Specifies the ordering of results. + * Supported values are: + * * `relevance` (default) + * * `last_modified_timestamp` + * * `last_modified_timestamp asc` */ // const orderBy = 'abc123' /** diff --git a/packages/google-cloud-dataplex/samples/generated/v1/catalog_service.update_entry.js b/packages/google-cloud-dataplex/samples/generated/v1/catalog_service.update_entry.js index b8eb05b145e..bf332f1409c 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/catalog_service.update_entry.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/catalog_service.update_entry.js @@ -59,7 +59,7 @@ function main(entry) { * specified path. For example, to attach an aspect to a field that is * specified by the `schema` aspect, the path should have the format * `Schema.`. - * * `*` - matches aspects of the given type for all + * * `@*` - matches aspects of the given type for all * paths. * * `*@path` - matches aspects of all types on the given path. * The service will not remove existing aspects matching the syntax unless diff --git a/packages/google-cloud-dataplex/samples/generated/v1/data_scan_service.delete_data_scan.js b/packages/google-cloud-dataplex/samples/generated/v1/data_scan_service.delete_data_scan.js index fdbd0d18eeb..72c267afb0a 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/data_scan_service.delete_data_scan.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/data_scan_service.delete_data_scan.js @@ -35,6 +35,12 @@ function main(name) { * `location_id` refers to a GCP region. */ // const name = 'abc123' + /** + * Optional. If set to true, any child resources of this data scan will also + * be deleted. (Otherwise, the request will only work if the data scan has no + * child resources.) + */ + // const force = true // Imports the Dataplex library const {DataScanServiceClient} = require('@google-cloud/dataplex').v1; diff --git a/packages/google-cloud-dataplex/samples/generated/v1/data_scan_service.update_data_scan.js b/packages/google-cloud-dataplex/samples/generated/v1/data_scan_service.update_data_scan.js index a1ff3edbf48..d6bd5ddd484 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/data_scan_service.update_data_scan.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/data_scan_service.update_data_scan.js @@ -20,7 +20,7 @@ 'use strict'; -function main(dataScan, updateMask) { +function main(dataScan) { // [START dataplex_v1_generated_DataScanService_UpdateDataScan_async] /** * This snippet has been automatically generated and should be regarded as a code template only. @@ -34,7 +34,7 @@ function main(dataScan, updateMask) { */ // const dataScan = {} /** - * Required. Mask of fields to update. + * Optional. Mask of fields to update. */ // const updateMask = {} /** @@ -53,7 +53,6 @@ function main(dataScan, updateMask) { // Construct request const request = { dataScan, - updateMask, }; // Run request diff --git a/packages/google-cloud-dataplex/samples/generated/v1/snippet_metadata_google.cloud.dataplex.v1.json b/packages/google-cloud-dataplex/samples/generated/v1/snippet_metadata_google.cloud.dataplex.v1.json index 12bf2d8d0fe..49f7fde7884 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/snippet_metadata_google.cloud.dataplex.v1.json +++ b/packages/google-cloud-dataplex/samples/generated/v1/snippet_metadata_google.cloud.dataplex.v1.json @@ -1046,7 +1046,7 @@ "segments": [ { "start": 25, - "end": 83, + "end": 89, "type": "FULL" } ], @@ -3266,7 +3266,7 @@ "segments": [ { "start": 25, - "end": 65, + "end": 64, "type": "FULL" } ], @@ -3314,7 +3314,7 @@ "segments": [ { "start": 25, - "end": 57, + "end": 63, "type": "FULL" } ], @@ -3326,6 +3326,10 @@ { "name": "name", "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" } ], "resultType": ".google.longrunning.Operation", diff --git a/packages/google-cloud-dataplex/src/v1/catalog_service_client.ts b/packages/google-cloud-dataplex/src/v1/catalog_service_client.ts index 3c1c0d808d5..1e573d0066c 100644 --- a/packages/google-cloud-dataplex/src/v1/catalog_service_client.ts +++ b/packages/google-cloud-dataplex/src/v1/catalog_service_client.ts @@ -1288,7 +1288,7 @@ export class CatalogServiceClient { * specified path. For example, to attach an aspect to a field that is * specified by the `schema` aspect, the path should have the format * `Schema.`. - * * `*` - matches aspects of the given type for all + * * `@*` - matches aspects of the given type for all * paths. * * `*@path` - matches aspects of all types on the given path. * @@ -4251,6 +4251,8 @@ export class CatalogServiceClient { * following form: `projects/{project}/locations/{location}`. * @param {string} request.query * 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). * @param {number} [request.pageSize] * Optional. Number of results in the search page. If <=0, then defaults * to 10. Max limit for page_size is 1000. Throws an invalid argument for @@ -4260,6 +4262,10 @@ export class CatalogServiceClient { * this to retrieve the subsequent page. * @param {string} [request.orderBy] * Optional. Specifies the ordering of results. + * Supported values are: + * * `relevance` (default) + * * `last_modified_timestamp` + * * `last_modified_timestamp asc` * @param {string} [request.scope] * Optional. The scope under which the search should be operating. It must * either be `organizations/` or `projects/`. If it is @@ -4355,6 +4361,8 @@ export class CatalogServiceClient { * following form: `projects/{project}/locations/{location}`. * @param {string} request.query * 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). * @param {number} [request.pageSize] * Optional. Number of results in the search page. If <=0, then defaults * to 10. Max limit for page_size is 1000. Throws an invalid argument for @@ -4364,6 +4372,10 @@ export class CatalogServiceClient { * this to retrieve the subsequent page. * @param {string} [request.orderBy] * Optional. Specifies the ordering of results. + * Supported values are: + * * `relevance` (default) + * * `last_modified_timestamp` + * * `last_modified_timestamp asc` * @param {string} [request.scope] * Optional. The scope under which the search should be operating. It must * either be `organizations/` or `projects/`. If it is @@ -4413,6 +4425,8 @@ export class CatalogServiceClient { * following form: `projects/{project}/locations/{location}`. * @param {string} request.query * 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). * @param {number} [request.pageSize] * Optional. Number of results in the search page. If <=0, then defaults * to 10. Max limit for page_size is 1000. Throws an invalid argument for @@ -4422,6 +4436,10 @@ export class CatalogServiceClient { * this to retrieve the subsequent page. * @param {string} [request.orderBy] * Optional. Specifies the ordering of results. + * Supported values are: + * * `relevance` (default) + * * `last_modified_timestamp` + * * `last_modified_timestamp asc` * @param {string} [request.scope] * Optional. The scope under which the search should be operating. It must * either be `organizations/` or `projects/`. If it is diff --git a/packages/google-cloud-dataplex/src/v1/data_scan_service_client.ts b/packages/google-cloud-dataplex/src/v1/data_scan_service_client.ts index 6fe72a281f6..13a01a7b500 100644 --- a/packages/google-cloud-dataplex/src/v1/data_scan_service_client.ts +++ b/packages/google-cloud-dataplex/src/v1/data_scan_service_client.ts @@ -1316,8 +1316,8 @@ export class DataScanServiceClient { * Required. DataScan resource to be updated. * * Only fields specified in `update_mask` are updated. - * @param {google.protobuf.FieldMask} request.updateMask - * Required. Mask of fields to update. + * @param {google.protobuf.FieldMask} [request.updateMask] + * Optional. Mask of fields to update. * @param {boolean} [request.validateOnly] * Optional. Only validate the request, but do not perform mutations. * The default is `false`. @@ -1460,6 +1460,10 @@ export class DataScanServiceClient { * `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}` * where `project` refers to a *project_id* or *project_number* and * `location_id` refers to a GCP region. + * @param {boolean} [request.force] + * Optional. If set to true, any child resources of this data scan will also + * be deleted. (Otherwise, the request will only work if the data scan has no + * child resources.) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array.