Interface TransferRunOrBuilder (2.52.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.78.0 (latest)
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 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
publicinterface TransferRunOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
getDataSourceId()
publicabstractStringgetDataSourceId()Output only. Data source id.
string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The dataSourceId. |
getDataSourceIdBytes()
publicabstractByteStringgetDataSourceIdBytes()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()
publicabstractTransferRun.DestinationCasegetDestinationCase()| Returns | |
|---|---|
| Type | Description |
TransferRun.DestinationCase |
|
getDestinationDatasetId()
publicabstractStringgetDestinationDatasetId()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()
publicabstractByteStringgetDestinationDatasetIdBytes()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()
publicabstractEmailPreferencesgetEmailPreferences()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()
publicabstractEmailPreferencesOrBuildergetEmailPreferencesOrBuilder()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()
publicabstractTimestampgetEndTime()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()
publicabstractTimestampOrBuildergetEndTimeOrBuilder()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()
publicabstractStatusgetErrorStatus()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status |
The errorStatus. |
getErrorStatusOrBuilder()
publicabstractStatusOrBuildergetErrorStatusOrBuilder()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getName()
publicabstractStringgetName() 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()
publicabstractByteStringgetNameBytes() 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()
publicabstractStringgetNotificationPubsubTopic()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()
publicabstractByteStringgetNotificationPubsubTopicBytes()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()
publicabstractStructgetParams()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()
publicabstractStructOrBuildergetParamsOrBuilder()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()
publicabstractTimestampgetRunTime()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()
publicabstractTimestampOrBuildergetRunTimeOrBuilder()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()
publicabstractStringgetSchedule() 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()
publicabstractByteStringgetScheduleBytes() 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()
publicabstractTimestampgetScheduleTime()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The scheduleTime. |
getScheduleTimeOrBuilder()
publicabstractTimestampOrBuildergetScheduleTimeOrBuilder()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getStartTime()
publicabstractTimestampgetStartTime()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()
publicabstractTimestampOrBuildergetStartTimeOrBuilder()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()
publicabstractTransferStategetState()Data transfer run state. Ignored for input requests.
.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
| Returns | |
|---|---|
| Type | Description |
TransferState |
The state. |
getStateValue()
publicabstractintgetStateValue()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()
publicabstractTimestampgetUpdateTime()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()
publicabstractTimestampOrBuildergetUpdateTimeOrBuilder()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()
publicabstractlonggetUserId()Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;
| Returns | |
|---|---|
| Type | Description |
long |
The userId. |
hasDestinationDatasetId()
publicabstractbooleanhasDestinationDatasetId()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()
publicabstractbooleanhasEmailPreferences()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()
publicabstractbooleanhasEndTime()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()
publicabstractbooleanhasErrorStatus()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the errorStatus field is set. |
hasParams()
publicabstractbooleanhasParams()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()
publicabstractbooleanhasRunTime()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()
publicabstractbooleanhasScheduleTime()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()
publicabstractbooleanhasStartTime()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()
publicabstractbooleanhasUpdateTime()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. |