/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/bigquery/datatransfer/v1/transfer.proto
package com.google.cloud.bigquery.datatransfer.v1;
public interface TransferConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.bigquery.datatransfer.v1.TransferConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The resource name of the transfer config.
* Transfer config names have the form
* `projects/{project_id}/locations/{region}/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;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The resource name of the transfer config.
* Transfer config names have the form
* `projects/{project_id}/locations/{region}/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;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The BigQuery target dataset id.
*
*
* string destination_dataset_id = 2;
*
* @return Whether the destinationDatasetId field is set.
*/
boolean hasDestinationDatasetId();
/**
*
*
*
* The BigQuery target dataset id.
*
*
* string destination_dataset_id = 2;
*
* @return The destinationDatasetId.
*/
java.lang.String getDestinationDatasetId();
/**
*
*
*
* The BigQuery target dataset id.
*
*
* string destination_dataset_id = 2;
*
* @return The bytes for destinationDatasetId.
*/
com.google.protobuf.ByteString getDestinationDatasetIdBytes();
/**
*
*
*
* User specified display name for the data transfer.
*
*
* string display_name = 3;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* User specified display name for the data transfer.
*
*
* string display_name = 3;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Data source ID. This cannot be changed once data transfer is created. The
* full list of available data source IDs can be returned through an API call:
* https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
*
*
* string data_source_id = 5;
*
* @return The dataSourceId.
*/
java.lang.String getDataSourceId();
/**
*
*
*
* Data source ID. This cannot be changed once data transfer is created. The
* full list of available data source IDs can be returned through an API call:
* https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
*
*
* string data_source_id = 5;
*
* @return The bytes for dataSourceId.
*/
com.google.protobuf.ByteString getDataSourceIdBytes();
/**
*
*
*
* Parameters specific to each data source. For more information see the
* bq tab in the 'Setting up a data transfer' section for each data source.
* For example the parameters for Cloud Storage transfers are listed here:
* https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
*
*
* .google.protobuf.Struct params = 9;
*
* @return Whether the params field is set.
*/
boolean hasParams();
/**
*
*
*
* Parameters specific to each data source. For more information see the
* bq tab in the 'Setting up a data transfer' section for each data source.
* For example the parameters for Cloud Storage transfers are listed here:
* https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
*
*
* .google.protobuf.Struct params = 9;
*
* @return The params.
*/
com.google.protobuf.Struct getParams();
/**
*
*
*
* Parameters specific to each data source. For more information see the
* bq tab in the 'Setting up a data transfer' section for each data source.
* For example the parameters for Cloud Storage transfers are listed here:
* https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
*
*
* .google.protobuf.Struct params = 9;
*/
com.google.protobuf.StructOrBuilder getParamsOrBuilder();
/**
*
*
*
* 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.
* The specified times are in UTC.
* Examples of valid format:
* `1st,3rd monday of month 15:30`,
* `every wed,fri of jan,jun 13:15`, and
* `first sunday of quarter 00:00`.
* See more explanation about the format here:
* https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
* NOTE: The minimum interval time between recurring transfers depends on the
* data source; refer to the documentation for your data source.
*
*
* string schedule = 7;
*
* @return The schedule.
*/
java.lang.String getSchedule();
/**
*
*
*
* 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.
* The specified times are in UTC.
* Examples of valid format:
* `1st,3rd monday of month 15:30`,
* `every wed,fri of jan,jun 13:15`, and
* `first sunday of quarter 00:00`.
* See more explanation about the format here:
* https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
* NOTE: The minimum interval time between recurring transfers depends on the
* data source; refer to the documentation for your data source.
*
*
* string schedule = 7;
*
* @return The bytes for schedule.
*/
com.google.protobuf.ByteString getScheduleBytes();
/**
*
*
*
* Options customizing the data transfer schedule.
*
*
* .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
*
* @return Whether the scheduleOptions field is set.
*/
boolean hasScheduleOptions();
/**
*
*
*
* Options customizing the data transfer schedule.
*
*
* .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
*
* @return The scheduleOptions.
*/
com.google.cloud.bigquery.datatransfer.v1.ScheduleOptions getScheduleOptions();
/**
*
*
*
* Options customizing the data transfer schedule.
*
*
* .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
*/
com.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsOrBuilder getScheduleOptionsOrBuilder();
/**
*
*
*
* The number of days to look back to automatically refresh the data.
* 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
* to use the default value.
*
*
* int32 data_refresh_window_days = 12;
*
* @return The dataRefreshWindowDays.
*/
int getDataRefreshWindowDays();
/**
*
*
*
* Is this config disabled. When set to true, no runs are scheduled
* for a given transfer.
*
*
* bool disabled = 13;
*
* @return The disabled.
*/
boolean getDisabled();
/**
*
*
*
* Output only. Data transfer modification time. Ignored by server on input.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Data transfer modification time. Ignored by server on input.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. Data transfer modification time. Ignored by server on input.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Output only. Next time when data transfer will run.
*
*
*
* .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the nextRunTime field is set.
*/
boolean hasNextRunTime();
/**
*
*
*
* Output only. Next time when data transfer will run.
*
*
*
* .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The nextRunTime.
*/
com.google.protobuf.Timestamp getNextRunTime();
/**
*
*
*
* Output only. Next time when data transfer will run.
*
*
*
* .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getNextRunTimeOrBuilder();
/**
*
*
*
* Output only. State of the most recently updated transfer run.
*
*
*
* .google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. State of the most recently updated transfer run.
*
*
*
* .google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.bigquery.datatransfer.v1.TransferState getState();
/**
*
*
*
* Deprecated. Unique ID of the user on whose behalf transfer is done.
*
*
* int64 user_id = 11;
*
* @return The userId.
*/
long getUserId();
/**
*
*
*
* Output only. Region in which BigQuery dataset is located.
*
*
* string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The datasetRegion.
*/
java.lang.String getDatasetRegion();
/**
*
*
*
* Output only. Region in which BigQuery dataset is located.
*
*
* string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for datasetRegion.
*/
com.google.protobuf.ByteString getDatasetRegionBytes();
/**
*
*
*
* Pub/Sub topic where notifications will be sent after transfer runs
* associated with this transfer config finish.
* The format for specifying a pubsub topic is:
* `projects/{project}/topics/{topic}`
*
*
* string notification_pubsub_topic = 15;
*
* @return The notificationPubsubTopic.
*/
java.lang.String getNotificationPubsubTopic();
/**
*
*
*
* Pub/Sub topic where notifications will be sent after transfer runs
* associated with this transfer config finish.
* The format for specifying a pubsub topic is:
* `projects/{project}/topics/{topic}`
*
*
* string notification_pubsub_topic = 15;
*
* @return The bytes for notificationPubsubTopic.
*/
com.google.protobuf.ByteString getNotificationPubsubTopicBytes();
/**
*
*
*
* Email notifications will be sent according to these preferences
* to the email address of the user who owns this transfer config.
*
*
* .google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;
*
* @return Whether the emailPreferences field is set.
*/
boolean hasEmailPreferences();
/**
*
*
*
* Email notifications will be sent according to these preferences
* to the email address of the user who owns this transfer config.
*
*
* .google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;
*
* @return The emailPreferences.
*/
com.google.cloud.bigquery.datatransfer.v1.EmailPreferences getEmailPreferences();
/**
*
*
*
* Email notifications will be sent according to these preferences
* to the email address of the user who owns this transfer config.
*
*
* .google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;
*/
com.google.cloud.bigquery.datatransfer.v1.EmailPreferencesOrBuilder
getEmailPreferencesOrBuilder();
/**
*
*
*
* Output only. Information about the user whose credentials are used to
* transfer data. Populated only for `transferConfigs.get` requests. In case
* the user information is not available, this field will not be populated.
*
*
*
* optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the ownerInfo field is set.
*/
boolean hasOwnerInfo();
/**
*
*
*
* Output only. Information about the user whose credentials are used to
* transfer data. Populated only for `transferConfigs.get` requests. In case
* the user information is not available, this field will not be populated.
*
*
*
* optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The ownerInfo.
*/
com.google.cloud.bigquery.datatransfer.v1.UserInfo getOwnerInfo();
/**
*
*
*
* Output only. Information about the user whose credentials are used to
* transfer data. Populated only for `transferConfigs.get` requests. In case
* the user information is not available, this field will not be populated.
*
*
*
* optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.bigquery.datatransfer.v1.UserInfoOrBuilder getOwnerInfoOrBuilder();
public com.google.cloud.bigquery.datatransfer.v1.TransferConfig.DestinationCase
getDestinationCase();
}