com.google.cloud.bigquery.datatransfer.v1

Interface TransferConfigOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

TransferConfig, TransferConfig.Builder

public interface TransferConfigOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getDataRefreshWindowDays() The number of days to look back to automatically refresh the data.
java.lang.String	getDatasetRegion() Output only.
ByteString	getDatasetRegionBytes() Output only.
java.lang.String	getDataSourceId() Data source id.
ByteString	getDataSourceIdBytes() Data source id.
java.lang.String	getDestinationDatasetId() The BigQuery target dataset id.
ByteString	getDestinationDatasetIdBytes() The BigQuery target dataset id.
boolean	getDisabled() Is this config disabled.
java.lang.String	getDisplayName() User specified display name for the data transfer.
ByteString	getDisplayNameBytes() User specified display name for the data transfer.
java.lang.String	getName() The resource name of the transfer config.
ByteString	getNameBytes() The resource name of the transfer config.
Timestamp	getNextRunTime() Output only.
TimestampOrBuilder	getNextRunTimeOrBuilder() Output only.
Struct	getParams() Data transfer specific parameters.
StructOrBuilder	getParamsOrBuilder() Data transfer specific parameters.
java.lang.String	getSchedule() Data transfer schedule.
ByteString	getScheduleBytes() Data transfer schedule.
TransferState	getState() Output only.
int	getStateValue() Output only.
Timestamp	getUpdateTime() Output only.
TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
long	getUserId() Output only.
boolean	hasNextRunTime() Output only.
boolean	hasParams() Data transfer specific parameters.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

java.lang.String getName()

 The resource name of the transfer config.
 Transfer config names have the form
 `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;

getNameBytes

ByteString getNameBytes()

 The resource name of the transfer config.
 Transfer config names have the form
 `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;

getDestinationDatasetId

java.lang.String getDestinationDatasetId()

 The BigQuery target dataset id.
 

string destination_dataset_id = 2;

getDestinationDatasetIdBytes

ByteString getDestinationDatasetIdBytes()

 The BigQuery target dataset id.
 

string destination_dataset_id = 2;

getDisplayName

java.lang.String getDisplayName()

 User specified display name for the data transfer.
 

string display_name = 3;

getDisplayNameBytes

ByteString getDisplayNameBytes()

 User specified display name for the data transfer.
 

string display_name = 3;

getDataSourceId

java.lang.String getDataSourceId()

 Data source id. Cannot be changed once data transfer is created.
 

string data_source_id = 5;

getDataSourceIdBytes

ByteString getDataSourceIdBytes()

 Data source id. Cannot be changed once data transfer is created.
 

string data_source_id = 5;

hasParams

boolean hasParams()

 Data transfer specific parameters.
 

.google.protobuf.Struct params = 9;

getParams

Struct getParams()

 Data transfer specific parameters.
 

.google.protobuf.Struct params = 9;

getParamsOrBuilder

StructOrBuilder getParamsOrBuilder()

 Data transfer specific parameters.
 

.google.protobuf.Struct params = 9;

getSchedule

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 granularity should be at least 8 hours, or less frequent.
 

string schedule = 7;

getScheduleBytes

ByteString getScheduleBytes()

 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 granularity should be at least 8 hours, or less frequent.
 

string schedule = 7;

getDataRefreshWindowDays

int getDataRefreshWindowDays()

 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;

getDisabled

boolean getDisabled()

 Is this config disabled. When set to true, no runs are scheduled
 for a given transfer.
 

bool disabled = 13;

hasUpdateTime

boolean hasUpdateTime()

 Output only. Data transfer modification time. Ignored by server on input.
 

.google.protobuf.Timestamp update_time = 4;

getUpdateTime

Timestamp getUpdateTime()

 Output only. Data transfer modification time. Ignored by server on input.
 

.google.protobuf.Timestamp update_time = 4;

getUpdateTimeOrBuilder

TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Data transfer modification time. Ignored by server on input.
 

.google.protobuf.Timestamp update_time = 4;

hasNextRunTime

boolean hasNextRunTime()

 Output only. Next time when data transfer will run.
 

.google.protobuf.Timestamp next_run_time = 8;

getNextRunTime

Timestamp getNextRunTime()

 Output only. Next time when data transfer will run.
 

.google.protobuf.Timestamp next_run_time = 8;

getNextRunTimeOrBuilder

TimestampOrBuilder getNextRunTimeOrBuilder()

 Output only. Next time when data transfer will run.
 

.google.protobuf.Timestamp next_run_time = 8;

getStateValue

int getStateValue()

 Output only. State of the most recently updated transfer run.
 

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10;

getState

TransferState getState()

 Output only. State of the most recently updated transfer run.
 

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10;

getUserId

long getUserId()

 Output only. Unique ID of the user on whose behalf transfer is done.
 Applicable only to data sources that do not support service accounts.
 When set to 0, the data source service account credentials are used.
 May be negative. Note, that this identifier is not stable.
 It may change over time even for the same user.
 

int64 user_id = 11;

getDatasetRegion

java.lang.String getDatasetRegion()

 Output only. Region in which BigQuery dataset is located.
 

string dataset_region = 14;

getDatasetRegionBytes

ByteString getDatasetRegionBytes()

 Output only. Region in which BigQuery dataset is located.
 

string dataset_region = 14;