fix: [bigquery-datatransfer] mark parent/name fields with the REQUIRE…

…D field_behavior annotation (#5233) * fix: mark parent/name fields with the REQUIRED field_behavior annotation docs: updated comments PiperOrigin-RevId: 624277410 Source-Link: googleapis/googleapis@2d881be Source-Link: googleapis/googleapis-gen@1d063f9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LWRhdGF0cmFuc2Zlci8uT3dsQm90LnlhbWwiLCJoIjoiMWQwNjNmOTM1M2FlZmZiOWE5NjhmMWEwMGYxZDEwNWIwYzE0YTQyZCJ9 * 🦉 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 <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Apr 18, 2024 · 29c939f · 29c939f
1 parent 1ffd246
commit 29c939f
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 28 deletions.
diff --git a/...oud-bigquery-datatransfer/protos/google/cloud/bigquery/datatransfer/v1/datatransfer.proto b/...oud-bigquery-datatransfer/protos/google/cloud/bigquery/datatransfer/v1/datatransfer.proto
@@ -867,12 +867,15 @@ message StartManualTransferRunsRequest {
     google.protobuf.Timestamp end_time = 2;
   }
 
-  // Transfer configuration name in the form:
+  // Required. Transfer configuration name in the form:
   // `projects/{project_id}/transferConfigs/{config_id}` or
   // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
-  string parent = 1 [(google.api.resource_reference) = {
-    type: "bigquerydatatransfer.googleapis.com/TransferConfig"
-  }];
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "bigquerydatatransfer.googleapis.com/TransferConfig"
+    }
+  ];
 
   // The requested time specification - this can be a time range or a specific
   // run_time.
@@ -900,8 +903,9 @@ message StartManualTransferRunsResponse {
 // A request to enroll a set of data sources so they are visible in the
 // BigQuery UI's `Transfer` tab.
 message EnrollDataSourcesRequest {
-  // The name of the project resource in the form: `projects/{project_id}`
-  string name = 1;
+  // Required. The name of the project resource in the form:
+  // `projects/{project_id}`
+  string name = 1 [(google.api.field_behavior) = REQUIRED];
 
   // Data sources that are enrolled. It is required to provide at least one
   // data source id.
@@ -911,8 +915,9 @@ message EnrollDataSourcesRequest {
 // A request to unenroll a set of data sources so they are no longer visible in
 // the BigQuery UI's `Transfer` tab.
 message UnenrollDataSourcesRequest {
-  // The name of the project resource in the form: `projects/{project_id}`
-  string name = 1;
+  // Required. The name of the project resource in the form:
+  // `projects/{project_id}`
+  string name = 1 [(google.api.field_behavior) = REQUIRED];
 
   // Data sources that are unenrolled. It is required to provide at least one
   // data source id.

diff --git a/...e-cloud-bigquery-datatransfer/protos/google/cloud/bigquery/datatransfer/v1/transfer.proto b/...e-cloud-bigquery-datatransfer/protos/google/cloud/bigquery/datatransfer/v1/transfer.proto
@@ -117,14 +117,14 @@ message TransferConfig {
     pattern: "projects/{project}/locations/{location}/transferConfigs/{transfer_config}"
   };
 
-  // The resource name of the transfer config.
+  // Identifier. The resource name of the transfer config.
   // Transfer config names have the form either
   // `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or
   // `projects/{project_id}/transferConfigs/{config_id}`,
   // where `config_id` is usually a UUID, even though it is not
   // guaranteed or required. The name is ignored when creating a transfer
   // config.
-  string name = 1;
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // The desination of the transfer config.
   oneof destination {
@@ -231,11 +231,11 @@ message TransferRun {
     pattern: "projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}"
   };
 
-  // The resource name of the transfer run.
+  // Identifier. The resource name of the transfer run.
   // Transfer run names have the form
   // `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.
   // The name is ignored when creating a transfer run.
-  string name = 1;
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Minimum time after which a transfer run can be started.
   google.protobuf.Timestamp schedule_time = 3;

diff --git a/packages/google-cloud-bigquery-datatransfer/protos/protos.json b/packages/google-cloud-bigquery-datatransfer/protos/protos.json
diff --git a/...d-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js b/...d-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js
@@ -20,7 +20,7 @@
 
 'use strict';
 
-function main() {
+function main(name) {
   // [START bigquerydatatransfer_v1_generated_DataTransferService_EnrollDataSources_async]
   /**
    * This snippet has been automatically generated and should be regarded as a code template only.
@@ -29,7 +29,8 @@ function main() {
    * TODO(developer): Uncomment these variables before running the sample.
    */
   /**
-   *  The name of the project resource in the form: `projects/{project_id}`
+   *  Required. The name of the project resource in the form:
+   *  `projects/{project_id}`
    */
   // const name = 'abc123'
   /**
@@ -47,6 +48,7 @@ function main() {
   async function callEnrollDataSources() {
     // Construct request
     const request = {
+      name,
     };
 
     // Run request

diff --git a/...ery-datatransfer/samples/generated/v1/data_transfer_service.start_manual_transfer_runs.js b/...ery-datatransfer/samples/generated/v1/data_transfer_service.start_manual_transfer_runs.js
@@ -20,7 +20,7 @@
 
 'use strict';
 
-function main() {
+function main(parent) {
   // [START bigquerydatatransfer_v1_generated_DataTransferService_StartManualTransferRuns_async]
   /**
    * This snippet has been automatically generated and should be regarded as a code template only.
@@ -29,7 +29,7 @@ function main() {
    * TODO(developer): Uncomment these variables before running the sample.
    */
   /**
-   *  Transfer configuration name in the form:
+   *  Required. Transfer configuration name in the form:
    *  `projects/{project_id}/transferConfigs/{config_id}` or
    *  `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
    */
@@ -58,6 +58,7 @@ function main() {
   async function callStartManualTransferRuns() {
     // Construct request
     const request = {
+      parent,
     };
 
     // Run request

diff --git a/...bigquery-datatransfer/samples/generated/v1/data_transfer_service.unenroll_data_sources.js b/...bigquery-datatransfer/samples/generated/v1/data_transfer_service.unenroll_data_sources.js
@@ -20,7 +20,7 @@
 
 'use strict';
 
-function main() {
+function main(name) {
   // [START bigquerydatatransfer_v1_generated_DataTransferService_UnenrollDataSources_async]
   /**
    * This snippet has been automatically generated and should be regarded as a code template only.
@@ -29,7 +29,8 @@ function main() {
    * TODO(developer): Uncomment these variables before running the sample.
    */
   /**
-   *  The name of the project resource in the form: `projects/{project_id}`
+   *  Required. The name of the project resource in the form:
+   *  `projects/{project_id}`
    */
   // const name = 'abc123'
   /**
@@ -47,6 +48,7 @@ function main() {
   async function callUnenrollDataSources() {
     // Construct request
     const request = {
+      name,
     };
 
     // Run request

diff --git a/...transfer/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datatransfer.v1.json b/...transfer/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datatransfer.v1.json
@@ -402,7 +402,7 @@
             "segments": [
                 {
                     "start": 25,
-                    "end": 68,
+                    "end": 69,
                     "type": "FULL"
                 }
             ],
@@ -678,7 +678,7 @@
             "segments": [
                 {
                     "start": 25,
-                    "end": 57,
+                    "end": 59,
                     "type": "FULL"
                 }
             ],
@@ -722,7 +722,7 @@
             "segments": [
                 {
                     "start": 25,
-                    "end": 57,
+                    "end": 59,
                     "type": "FULL"
                 }
             ],

diff --git a/packages/google-cloud-bigquery-datatransfer/src/v1/data_transfer_service_client.ts b/packages/google-cloud-bigquery-datatransfer/src/v1/data_transfer_service_client.ts
@@ -1137,7 +1137,7 @@ export class DataTransferServiceClient {
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
-   *   Transfer configuration name in the form:
+   *   Required. Transfer configuration name in the form:
    *   `projects/{project_id}/transferConfigs/{config_id}` or
    *   `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
    * @param {google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRange} request.requestedTimeRange
@@ -1553,7 +1553,8 @@ export class DataTransferServiceClient {
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.name
-   *   The name of the project resource in the form: `projects/{project_id}`
+   *   Required. The name of the project resource in the form:
+   *   `projects/{project_id}`
    * @param {string[]} request.dataSourceIds
    *   Data sources that are enrolled. It is required to provide at least one
    *   data source id.
@@ -1656,7 +1657,8 @@ export class DataTransferServiceClient {
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.name
-   *   The name of the project resource in the form: `projects/{project_id}`
+   *   Required. The name of the project resource in the form:
+   *   `projects/{project_id}`
    * @param {string[]} request.dataSourceIds
    *   Data sources that are unenrolled. It is required to provide at least one
    *   data source id.