- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.17
- 2.2.6
- 2.1.23
- 2.0.27
public interface TransferRunOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDataSourceId()
public abstract String getDataSourceId()Output only. Data source id.
string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The dataSourceId. |
getDataSourceIdBytes()
public abstract ByteString getDataSourceIdBytes()Output only. Data source id.
string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for dataSourceId. |
getDestinationCase()
public abstract TransferRun.DestinationCase getDestinationCase()| Returns | |
|---|---|
| Type | Description |
TransferRun.DestinationCase |
|
getDestinationDatasetId()
public abstract String getDestinationDatasetId()Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The destinationDatasetId. |
getDestinationDatasetIdBytes()
public abstract ByteString getDestinationDatasetIdBytes()Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for destinationDatasetId. |
getEmailPreferences()
public abstract EmailPreferences getEmailPreferences()Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
EmailPreferences |
The emailPreferences. |
getEmailPreferencesOrBuilder()
public abstract EmailPreferencesOrBuilder getEmailPreferencesOrBuilder()Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
EmailPreferencesOrBuilder |
|
getEndTime()
public abstract Timestamp getEndTime()Output only. Time when transfer run ended. Parameter ignored by server for input requests.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The endTime. |
getEndTimeOrBuilder()
public abstract TimestampOrBuilder getEndTimeOrBuilder()Output only. Time when transfer run ended. Parameter ignored by server for input requests.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getErrorStatus()
public abstract Status getErrorStatus()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status |
The errorStatus. |
getErrorStatusOrBuilder()
public abstract StatusOrBuilder getErrorStatusOrBuilder()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getName()
public abstract String getName() Identifier. The resource name of the transfer run.
Transfer run names have the form
projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}.
The name is ignored when creating a transfer run.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Identifier. The resource name of the transfer run.
Transfer run names have the form
projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}.
The name is ignored when creating a transfer run.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNotificationPubsubTopic()
public abstract String getNotificationPubsubTopic()Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes.
The format for specifying a pubsub topic is:
projects/{project_id}/topics/{topic_id}
string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The notificationPubsubTopic. |
getNotificationPubsubTopicBytes()
public abstract ByteString getNotificationPubsubTopicBytes()Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes.
The format for specifying a pubsub topic is:
projects/{project_id}/topics/{topic_id}
string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for notificationPubsubTopic. |
getParams()
public abstract Struct getParams()Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Struct |
The params. |
getParamsOrBuilder()
public abstract StructOrBuilder getParamsOrBuilder()Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
getRunTime()
public abstract Timestamp getRunTime()For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The runTime. |
getRunTimeOrBuilder()
public abstract TimestampOrBuilder getRunTimeOrBuilder()For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getSchedule()
public abstract String getSchedule() Output only. Describes the schedule of this transfer run if it was
created as part of a regular schedule. For batch transfer runs that are
scheduled manually, this is empty.
NOTE: the system might choose to delay the schedule depending on the
current load, so schedule_time doesn't always match this.
string schedule = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The schedule. |
getScheduleBytes()
public abstract ByteString getScheduleBytes() Output only. Describes the schedule of this transfer run if it was
created as part of a regular schedule. For batch transfer runs that are
scheduled manually, this is empty.
NOTE: the system might choose to delay the schedule depending on the
current load, so schedule_time doesn't always match this.
string schedule = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for schedule. |
getScheduleTime()
public abstract Timestamp getScheduleTime()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The scheduleTime. |
getScheduleTimeOrBuilder()
public abstract TimestampOrBuilder getScheduleTimeOrBuilder()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getStartTime()
public abstract Timestamp getStartTime()Output only. Time when transfer run was started. Parameter ignored by server for input requests.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The startTime. |
getStartTimeOrBuilder()
public abstract TimestampOrBuilder getStartTimeOrBuilder()Output only. Time when transfer run was started. Parameter ignored by server for input requests.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getState()
public abstract TransferState getState()Data transfer run state. Ignored for input requests.
.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
| Returns | |
|---|---|
| Type | Description |
TransferState |
The state. |
getStateValue()
public abstract int getStateValue()Data transfer run state. Ignored for input requests.
.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. Last time the data transfer run state was updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Last time the data transfer run state was updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getUserId()
public abstract long getUserId()Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;
| Returns | |
|---|---|
| Type | Description |
long |
The userId. |
hasDestinationDatasetId()
public abstract boolean hasDestinationDatasetId()Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the destinationDatasetId field is set. |
hasEmailPreferences()
public abstract boolean hasEmailPreferences()Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the emailPreferences field is set. |
hasEndTime()
public abstract boolean hasEndTime()Output only. Time when transfer run ended. Parameter ignored by server for input requests.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the endTime field is set. |
hasErrorStatus()
public abstract boolean hasErrorStatus()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the errorStatus field is set. |
hasParams()
public abstract boolean hasParams()Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the params field is set. |
hasRunTime()
public abstract boolean hasRunTime()For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the runTime field is set. |
hasScheduleTime()
public abstract boolean hasScheduleTime()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the scheduleTime field is set. |
hasStartTime()
public abstract boolean hasStartTime()Output only. Time when transfer run was started. Parameter ignored by server for input requests.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the startTime field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. Last time the data transfer run state was updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |