From 2396d77e8d2f93169f9e04b8235f20c7560e3c04 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 2 Feb 2023 10:55:30 -0500 Subject: [PATCH] docs: [dataplex] Improvements to DataScan API documentation (#9054) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: Improvements to DataScan API documentation PiperOrigin-RevId: 506348044 Source-Link: https://github.com/googleapis/googleapis/commit/4eb6d9e12b72bae548432230e85ee460641d7e5f Source-Link: https://github.com/googleapis/googleapis-gen/commit/830a4ab8c9836b377d43ff95b68d8372890e93c3 Copy-Tag: eyJwIjoiamF2YS1kYXRhcGxleC8uT3dsQm90LnlhbWwiLCJoIjoiODMwYTRhYjhjOTgzNmIzNzdkNDNmZjk1YjY4ZDgzNzI4OTBlOTNjMyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- java-dataplex/README.md | 6 +- .../dataplex/v1/DataScanServiceClient.java | 158 ++++++++-------- .../cloud/dataplex/v1/package-info.java | 4 + .../dataplex/v1/DataScanServiceGrpc.java | 114 ++++++++---- .../dataplex/v1/CreateDataScanRequest.java | 28 +-- .../v1/CreateDataScanRequestOrBuilder.java | 8 +- .../google/cloud/dataplex/v1/DataScan.java | 172 ++++++++++-------- .../google/cloud/dataplex/v1/DataScanJob.java | 32 ++-- .../dataplex/v1/DataScanJobOrBuilder.java | 8 +- .../cloud/dataplex/v1/DataScanOrBuilder.java | 14 +- .../cloud/dataplex/v1/DataScanType.java | 12 +- .../dataplex/v1/DeleteDataScanRequest.java | 28 +-- .../v1/DeleteDataScanRequestOrBuilder.java | 8 +- .../dataplex/v1/GetDataScanJobRequest.java | 55 +++--- .../v1/GetDataScanJobRequestOrBuilder.java | 14 +- .../cloud/dataplex/v1/GetDataScanRequest.java | 55 +++--- .../v1/GetDataScanRequestOrBuilder.java | 14 +- .../dataplex/v1/ListDataScanJobsRequest.java | 28 +-- .../v1/ListDataScanJobsRequestOrBuilder.java | 8 +- .../dataplex/v1/ListDataScanJobsResponse.java | 46 ++--- .../v1/ListDataScanJobsResponseOrBuilder.java | 10 +- .../dataplex/v1/ListDataScansRequest.java | 49 ++--- .../v1/ListDataScansRequestOrBuilder.java | 14 +- .../dataplex/v1/ListDataScansResponse.java | 46 ++--- .../v1/ListDataScansResponseOrBuilder.java | 10 +- .../cloud/dataplex/v1/RunDataScanRequest.java | 42 ++--- .../v1/RunDataScanRequestOrBuilder.java | 12 +- .../dataplex/v1/RunDataScanResponse.java | 24 +-- .../v1/RunDataScanResponseOrBuilder.java | 6 +- .../dataplex/v1/UpdateDataScanRequest.java | 24 +-- .../v1/UpdateDataScanRequestOrBuilder.java | 6 +- .../google/cloud/dataplex/v1/datascans.proto | 117 ++++++------ 32 files changed, 623 insertions(+), 549 deletions(-) diff --git a/java-dataplex/README.md b/java-dataplex/README.md index 695b20b50530..6632f1fc9588 100644 --- a/java-dataplex/README.md +++ b/java-dataplex/README.md @@ -19,20 +19,20 @@ If you are using Maven, add this to your pom.xml file: com.google.cloud google-cloud-dataplex - 1.6.0 + 1.7.0 ``` If you are using Gradle without BOM, add this to your dependencies: ```Groovy -implementation 'com.google.cloud:google-cloud-dataplex:1.6.0' +implementation 'com.google.cloud:google-cloud-dataplex:1.7.0' ``` If you are using SBT, add this to your dependencies: ```Scala -libraryDependencies += "com.google.cloud" % "google-cloud-dataplex" % "1.6.0" +libraryDependencies += "com.google.cloud" % "google-cloud-dataplex" % "1.7.0" ``` ## Authentication diff --git a/java-dataplex/google-cloud-dataplex/src/main/java/com/google/cloud/dataplex/v1/DataScanServiceClient.java b/java-dataplex/google-cloud-dataplex/src/main/java/com/google/cloud/dataplex/v1/DataScanServiceClient.java index 63d1f3ef0c6f..a637badd2df2 100644 --- a/java-dataplex/google-cloud-dataplex/src/main/java/com/google/cloud/dataplex/v1/DataScanServiceClient.java +++ b/java-dataplex/google-cloud-dataplex/src/main/java/com/google/cloud/dataplex/v1/DataScanServiceClient.java @@ -45,8 +45,12 @@ // AUTO-GENERATED DOCUMENTATION AND CLASS. /** - * This class provides the ability to make remote calls to the backing service through method calls - * that map to API methods. Sample code to get started: + * Service Description: DataScanService manages DataScan resources which can be configured to run + * various types of data scanning workload and generate enriched metadata (e.g. Data Profile, Data + * Quality) for the data source. + * + *

This class provides the ability to make remote calls to the backing service through method + * calls that map to API methods. Sample code to get started: * * 

{@code
  * // This snippet has been automatically generated and should be regarded as a code template only.
@@ -211,7 +215,7 @@ public final OperationsClient getHttpJsonOperationsClient() {
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Creates a dataScan resource.
+   * Creates a DataScan resource.
    *
    * 
Sample code:
    *
@@ -231,8 +235,8 @@ public final OperationsClient getHttpJsonOperationsClient() {
    * }
* * @param parent Required. The resource name of the parent location: - * projects/{project}/locations/{location_id} where `{project}` refers to a project_id or - * project_number and `location_id` refers to a GCP region. + * `projects/{project}/locations/{location_id}` where `project` refers to a + * *project_id* or *project_number* and `location_id` refers to a GCP region. * @param dataScan Required. DataScan resource. * @param dataScanId Required. DataScan identifier. *