BigQuery Data Transfer Service run notifications

This page provides an overview of run notifications for the BigQuery Data Transfer Service.

There are two types of run notifications you can configure for the BigQuery Data Transfer Service:

  • Pub/Sub notifications: machine-readable notifications sent when a transfer run succeeds or fails
  • Email notifications: human-readable notifications sent when a transfer run fails

You can configure each type individually, or you can use both Pub/Sub and email run notifications.

Pub/Sub notifications

Pub/Sub notifications send information about transfer runs to a Pub/Sub topic. Pub/Sub notifications are triggered by completed transfer runs in the following states:

  • SUCCEEDED
  • FAILED
  • CANCELLED

You can send notifications to any Pub/Sub topic in any project for which you have sufficient permissions. Once received by the Pub/Sub topic, the resulting message can be sent to any number of subscribers to the topic.

Before you begin

Before configuring Pub/Sub transfer run notifications, you should:

  1. Enable the Pub/Sub API for the project that will receive notifications.

    Enable the API

  2. Have sufficient permissions on the project that will receive notifications:

    • If you own the project that will receive notifications, you most likely have the necessary permission.

    • If you plan to create topics for receiving notifications, you should have pubsub.topics.create permissions.

    • Whether you plan to use new or existing topics, you should have pubsub.topics.getIamPolicy and pubsub.topics.setIamPolicy permissions. If you create a topic, you typically have permission for it already. The following predefined IAM role has both pubsub.topics.getIamPolicy and pubsub.topics.setIamPolicy permissions: pubsub.admin. See Pub/Sub access control for more information.

  3. Have an existing Pub/Sub topic that you want to send notifications to.

Notification format

Notifications sent to the Pub/Sub topic consist of two parts:

  • Attributes: A set of key:value pairs describing the event.
  • Payload: A string that contains the metadata of the changed object.

Attributes

Attributes are key:value pairs contained in all notifications sent by BigQuery Data Transfer Service to your Pub/Sub topic. Notifications always contain the following set of key:value pairs, regardless of the notification's payload:

Attribute nameExampleDescription
eventTypeTRANSFER_RUN_FINISHEDThe type of event that has just occurred. TRANSFER_RUN_FINISHED is the only possible value.
payloadFormatJSON_API_V1The format of the object payload. JSON_API_V1 is the only possible value.

Payload

The payload is a string that contains the metadata of the transfer run. The type of payload is not configurable at this time and is provided to accommodate future API version changes.

Payload typeDescription
JSON_API_V1The payload will be a UTF-8 JSON-serialized string containing the resource representation of a TransferRun.

Email notifications

Email notifications send human-readable email messages when a transfer run fails. These messages are sent to the email of the transfer administrator - the account that set up the transfer. You cannot configure the content of the message, and you cannot configure the recipient of the message.

If you used a service account to authenticate a transfer configuration, then you might not have access to the email to receive transfer run notification emails. In such cases, we recommend that you set up Pub/Sub notifications to receive transfer run notifications.

To send transfer run email notifications to more users, set up email forwarding rules to distribute the messages. If you are using Gmail, you can Automatically forward Gmail messages to another account.

The email notification is sent by the BigQuery Data Transfer Service and contains details on the transfer configuration, the transfer run, and a link to the run history for the failed run. For example:

 From: bigquery-data-transfer-service-noreply@google.com To: TRANSFER_ADMIN Title: BigQuery Data Transfer Service — Transfer Run Failure — DISPLAY_NAME Transfer Configuration Display Name: DISPLAY_NAME Source: DATA_SOURCE Destination: PROJECT_ID Run Summary Run: RUN_NAME Schedule Time: SCHEDULE_TIME Run Time: RUN_TIME View Run History Google LLC 1600 Amphitheatre Parkway, Mountain View, CA 94043 This email was sent because you indicated you are willing to receive Run Notifications from the BigQuery Data Transfer Service. If you do not wish to receive such emails in the future, click View Transfer Configuration and un-check the "Send E-mail Notifications" option.

Turn on or edit notifications

To turn on notifications, or edit an existing one, choose one of the following:

Console

  1. Go to the BigQuery page in the Google Cloud console.

    Go to the BigQuery page

  2. In the navigation menu, click Data transfers.

  3. To turn on notifications for a new transfer, click Create transfer. To adjust notifications for an existing transfer, click the name of the transfer and then click Edit.

  4. In the Notification options section, click the toggles next to the notification types to enable.

    • Email notifications: When you enable this option, the transfer administrator receives an email notification when a transfer run fails.
    • Pub/Sub notifications: When you enable this option, choose your topic name or click Create a topic. This option configures Pub/Sub run notifications for your transfer.

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. 

importcom.google.api.gax.rpc.ApiException;importcom.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest;importcom.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient;importcom.google.cloud.bigquery.datatransfer.v1.ProjectName;importcom.google.cloud.bigquery.datatransfer.v1.TransferConfig;importcom.google.protobuf.Struct;importcom.google.protobuf.Value;importjava.io.IOException;importjava.util.HashMap;importjava.util.Map;// Sample to get run notificationpublicclassRunNotification{publicstaticvoidmain(String[]args)throwsIOException{// TODO(developer): Replace these variables before running the sample.finalStringprojectId="MY_PROJECT_ID";finalStringdatasetId="MY_DATASET_ID";finalStringpubsubTopicName="MY_TOPIC_NAME";finalStringquery="SELECT CURRENT_TIMESTAMP() as current_time, @run_time as intended_run_time, "+"@run_date as intended_run_date, 17 as some_integer";Map<String,Value>params=newHashMap<>();params.put("query",Value.newBuilder().setStringValue(query).build());params.put("destination_table_name_template",Value.newBuilder().setStringValue("my_destination_table_{run_date}").build());params.put("write_disposition",Value.newBuilder().setStringValue("WRITE_TRUNCATE").build());params.put("partitioning_field",Value.newBuilder().build());TransferConfigtransferConfig=TransferConfig.newBuilder().setDestinationDatasetId(datasetId).setDisplayName("Your Scheduled Query Name").setDataSourceId("scheduled_query").setParams(Struct.newBuilder().putAllFields(params).build()).setSchedule("every 24 hours").setNotificationPubsubTopic(pubsubTopicName).build();runNotification(projectId,transferConfig);}publicstaticvoidrunNotification(StringprojectId,TransferConfigtransferConfig)throwsIOException{try(DataTransferServiceClientdataTransferServiceClient=DataTransferServiceClient.create()){ProjectNameparent=ProjectName.of(projectId);CreateTransferConfigRequestrequest=CreateTransferConfigRequest.newBuilder().setParent(parent.toString()).setTransferConfig(transferConfig).build();TransferConfigconfig=dataTransferServiceClient.createTransferConfig(request);System.out.println("\nScheduled query with run notification created successfully :"+config.getName());}catch(ApiExceptionex){System.out.print("\nScheduled query with run notification was not created."+ex.toString());}}}

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. 

transfer_config_name="projects/1234/locations/us/transferConfigs/abcd"pubsub_topic="projects/PROJECT-ID/topics/TOPIC-ID"fromgoogle.cloudimportbigquery_datatransferfromgoogle.protobufimportfield_mask_pb2transfer_client=bigquery_datatransfer.DataTransferServiceClient()transfer_config=bigquery_datatransfer.TransferConfig(name=transfer_config_name)transfer_config.notification_pubsub_topic=pubsub_topicupdate_mask=field_mask_pb2.FieldMask(paths=["notification_pubsub_topic"])transfer_config=transfer_client.update_transfer_config({"transfer_config":transfer_config,"update_mask":update_mask})print(f"Updated config: '{transfer_config.name}'")print(f"Notification Pub/Sub topic: '{transfer_config.notification_pubsub_topic}'")

Run notification pricing

If you configure Pub/Sub run notifications, you will incur Pub/Sub charges. For more information, see the Pub/Sub Pricing page.

What's next