Update a transfer configuration

Updates the display name of an existing transfer configuration in the BigQuery Data Transfer Service.

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

Java

Before trying this sample, follow the Java setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Java API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 com.google.api.gax.rpc. ApiException 
 
 ; 
 import 
  
 com.google.cloud.bigquery.datatransfer.v1. DataTransferServiceClient 
 
 ; 
 import 
  
 com.google.cloud.bigquery.datatransfer.v1. TransferConfig 
 
 ; 
 import 
  
 com.google.cloud.bigquery.datatransfer.v1. UpdateTransferConfigRequest 
 
 ; 
 import 
  
 com.google.protobuf. FieldMask 
 
 ; 
 import 
  
 com.google.protobuf.util. FieldMaskUtil 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 // Sample to update transfer config. 
 public 
  
 class 
 UpdateTransferConfig 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 configId 
  
 = 
  
 "MY_CONFIG_ID" 
 ; 
  
  TransferConfig 
 
  
 transferConfig 
  
 = 
  
  TransferConfig 
 
 . 
 newBuilder 
 () 
  
 . 
 setName 
 ( 
 configId 
 ) 
  
 . 
 setDisplayName 
 ( 
 "UPDATED_DISPLAY_NAME" 
 ) 
  
 . 
 build 
 (); 
  
  FieldMask 
 
  
 updateMask 
  
 = 
  
  FieldMaskUtil 
 
 . 
 fromString 
 ( 
 "display_name" 
 ); 
  
 updateTransferConfig 
 ( 
 transferConfig 
 , 
  
 updateMask 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 updateTransferConfig 
 ( 
  TransferConfig 
 
  
 transferConfig 
 , 
  
  FieldMask 
 
  
 updateMask 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 try 
  
 ( 
  DataTransferServiceClient 
 
  
 dataTransferServiceClient 
  
 = 
  
  DataTransferServiceClient 
 
 . 
 create 
 ()) 
  
 { 
  
  UpdateTransferConfigRequest 
 
  
 request 
  
 = 
  
  UpdateTransferConfigRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setTransferConfig 
 ( 
 transferConfig 
 ) 
  
 . 
  setUpdateMask 
 
 ( 
 updateMask 
 ) 
  
 . 
 build 
 (); 
  
  TransferConfig 
 
  
 updateConfig 
  
 = 
  
 dataTransferServiceClient 
 . 
 updateTransferConfig 
 ( 
 request 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Transfer config updated successfully :" 
  
 + 
  
 updateConfig 
 . 
  getDisplayName 
 
 ()); 
  
 } 
  
 catch 
  
 ( 
  ApiException 
 
  
 ex 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 print 
 ( 
 "Transfer config was not updated." 
  
 + 
  
 ex 
 . 
 toString 
 ()); 
  
 } 
  
 } 
 } 
 

Node.js

Before trying this sample, follow the Node.js setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Node.js API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  const 
  
 { 
 DataTransferServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/bigquery-data-transfer 
' 
 ). 
 v1 
 ; 
 const 
  
 { 
 status 
 } 
  
 = 
  
 require 
 ( 
 '@grpc/grpc-js' 
 ); 
 const 
  
 client 
  
 = 
  
 new 
  
  DataTransferServiceClient 
 
 (); 
 /** 
 * Updates a transfer configuration for a BigQuery data transfer. 
 * 
 * This sample shows how to update properties of an existing transfer configuration, such as its display name. 
 * An update mask is required to specify which fields to modify. 
 * 
 * @param {string} projectId The Google Cloud project ID, for example 'example-project-id' 
 * @param {string} location The location of the transfer config, for example 'us-central1' 
 * @param {string} configId The ID of the transfer config to update, for example '1234a-5678-9012b-3456c' 
 */ 
 async 
  
 function 
  
 updateTransferConfig 
 ( 
 projectId 
 , 
  
 location 
 , 
  
 configId 
 ) 
  
 { 
  
 const 
  
 transferConfig 
  
 = 
  
 { 
  
 name 
 : 
  
 `projects/ 
 ${ 
 projectId 
 } 
 /locations/ 
 ${ 
 location 
 } 
 /transferConfigs/ 
 ${ 
 configId 
 } 
 ` 
 , 
  
 displayName 
 : 
  
 'Example Data Transfer (Update)' 
 , 
  
 }; 
  
 const 
  
 request 
  
 = 
  
 { 
  
 transferConfig 
 , 
  
 updateMask 
 : 
  
 { 
  
 paths 
 : 
  
 [ 
 'display_name' 
 ], 
  
 }, 
  
 }; 
  
 try 
  
 { 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 client 
 . 
 updateTransferConfig 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 `Transfer config: 
 ${ 
 response 
 . 
 name 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Updated display name: 
 ${ 
 response 
 . 
 displayName 
 } 
 ` 
 ); 
  
 } 
  
 catch 
  
 ( 
 err 
 ) 
  
 { 
  
 if 
  
 ( 
 err 
 . 
 code 
  
 === 
  
 status 
 . 
 NOT_FOUND 
 ) 
  
 { 
  
 console 
 . 
 error 
 ( 
 `Transfer config not found: 
 ${ 
 transferConfig 
 . 
 name 
 } 
 ` 
 ); 
  
 } 
  
 else 
  
 { 
  
 console 
 . 
 error 
 ( 
 'An error occurred:' 
 , 
  
 err 
 ); 
  
 } 
  
 } 
 } 
 

Python

Before trying this sample, follow the Python setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Python API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 google.api_core.exceptions 
 from 
  
 google.cloud 
  
 import 
  bigquery_datatransfer_v1 
 
 from 
  
 google.protobuf 
  
 import 
 field_mask_pb2 
 client 
 = 
  bigquery_datatransfer_v1 
 
 . 
  DataTransferServiceClient 
 
 () 
 def 
  
 update_transfer_config 
 ( 
 project_id 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 transfer_config_id 
 : 
 str 
 , 
 ) 
 - 
> None 
 : 
  
 """Updates a data transfer configuration. 
 This sample shows how to update the display name for a transfer 
 configuration. 
 Args: 
 project_id: The Google Cloud project ID. 
 location: The geographic location of the transfer config, for example "us-central1" 
 transfer_config_id: The transfer configuration ID 
 """ 
 transfer_config_name 
 = 
 client 
 . 
  transfer_config_path 
 
 ( 
 project 
 = 
 f 
 " 
 { 
 project_id 
 } 
 /locations/ 
 { 
 location 
 } 
 " 
 , 
 transfer_config 
 = 
 transfer_config_id 
 , 
 ) 
 transfer_config 
 = 
  bigquery_datatransfer_v1 
 
 . 
  types 
 
 . 
  TransferConfig 
 
 ( 
 name 
 = 
 transfer_config_name 
 , 
 display_name 
 = 
 "My New Transfer Config display name" 
 , 
 ) 
 update_mask 
 = 
 field_mask_pb2 
 . 
 FieldMask 
 ( 
 paths 
 = 
 [ 
 "display_name" 
 ]) 
 try 
 : 
 response 
 = 
 client 
 . 
  update_transfer_config 
 
 ( 
 transfer_config 
 = 
 transfer_config 
 , 
 update_mask 
 = 
 update_mask 
 , 
 ) 
 print 
 ( 
 f 
 "Updated transfer config: 
 { 
 response 
 . 
 name 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "New display name: 
 { 
 response 
 . 
 display_name 
 } 
 " 
 ) 
 except 
 google 
 . 
 api_core 
 . 
 exceptions 
 . 
 NotFound 
 : 
 print 
 ( 
 f 
 "Error: Transfer config ' 
 { 
 transfer_config_name 
 } 
 ' not found." 
 ) 
 

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Create a Mobile Website
View Site in Mobile | Classic
Share by: