Skip to content

Commit

Permalink
docs: update unenrollDataSources API documentation
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 608888275
  • Loading branch information
Google APIs authored and Copybara-Service committed Feb 21, 2024
1 parent f959299 commit 1608c32
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
3 changes: 2 additions & 1 deletion google/cloud/bigquery/datatransfer/v1/datatransfer.proto
Expand Up @@ -240,7 +240,8 @@ service DataTransferService {
// Unenroll data sources in a user project. This allows users to remove
// transfer configurations for these data sources. They will no longer appear
// in the ListDataSources RPC and will also no longer appear in the [BigQuery
// UI](https://console.cloud.google.com/bigquery).
// UI](https://console.cloud.google.com/bigquery). Data transfers
// configurations of unenrolled data sources will not be scheduled.
rpc UnenrollDataSources(UnenrollDataSourcesRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
Expand Down
17 changes: 8 additions & 9 deletions google/cloud/bigquery/datatransfer/v1/transfer.proto
Expand Up @@ -87,13 +87,13 @@ message ScheduleOptions {
// Specifies time to start scheduling transfer runs. The first run will be
// scheduled at or after the start time according to a recurrence pattern
// defined in the schedule string. The start time can be changed at any
// moment. The time when a data transfer can be trigerred manually is not
// moment. The time when a data transfer can be triggered manually is not
// limited by this option.
google.protobuf.Timestamp start_time = 1;

// Defines time to stop scheduling transfer runs. A transfer run cannot be
// scheduled at or after the end time. The end time can be changed at any
// moment. The time when a data transfer can be trigerred manually is not
// moment. The time when a data transfer can be triggered manually is not
// limited by this option.
google.protobuf.Timestamp end_time = 2;
}
Expand Down Expand Up @@ -148,8 +148,7 @@ message TransferConfig {

// Data transfer schedule.
// If the data source does not support a custom schedule, this should be
// empty. If it is empty, the default value for the data source will be
// used.
// empty. If it is empty, the default value for the data source will be used.
// The specified times are in UTC.
// Examples of valid format:
// `1st,3rd monday of month 15:30`,
Expand All @@ -169,12 +168,12 @@ message TransferConfig {
// For example, if `data_refresh_window_days = 10`, then every day
// BigQuery reingests data for [today-10, today-1], rather than ingesting data
// for just [today-1].
// Only valid if the data source supports the feature. Set the value to 0
// Only valid if the data source supports the feature. Set the value to 0
// to use the default value.
int32 data_refresh_window_days = 12;

// Is this config disabled. When set to true, no runs are scheduled
// for a given transfer.
// Is this config disabled. When set to true, no runs will be scheduled for
// this transfer config.
bool disabled = 13;

// Output only. Data transfer modification time. Ignored by server on input.
Expand All @@ -198,7 +197,7 @@ message TransferConfig {
// associated with this transfer config finish.
//
// The format for specifying a pubsub topic is:
// `projects/{project}/topics/{topic}`
// `projects/{project_id}/topics/{topic_id}`
string notification_pubsub_topic = 15;

// Email notifications will be sent according to these preferences
Expand Down Expand Up @@ -296,7 +295,7 @@ message TransferRun {
// transfer run finishes.
//
// The format for specifying a pubsub topic is:
// `projects/{project}/topics/{topic}`
// `projects/{project_id}/topics/{topic_id}`
string notification_pubsub_topic = 23
[(google.api.field_behavior) = OUTPUT_ONLY];

Expand Down

0 comments on commit 1608c32

Please sign in to comment.