public static final class TransferRun.Builder extends GeneratedMessageV3.Builder<TransferRun.Builder> implements TransferRunOrBuilderRepresents a data transfer run.
Protobuf type google.cloud.bigquery.datatransfer.v1.TransferRun
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferRun.BuilderImplements
TransferRunOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransferRun.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field | FieldDescriptor |
value | Object |
| Type | Description |
TransferRun.Builder |
build()
public TransferRun build()| Type | Description |
TransferRun |
buildPartial()
public TransferRun buildPartial()| Type | Description |
TransferRun |
clear()
public TransferRun.Builder clear()| Type | Description |
TransferRun.Builder |
clearDataSourceId()
public TransferRun.Builder clearDataSourceId()Output only. Data source id.
string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearDestination()
public TransferRun.Builder clearDestination()| Type | Description |
TransferRun.Builder |
clearDestinationDatasetId()
public TransferRun.Builder clearDestinationDatasetId()Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearEmailPreferences()
public TransferRun.Builder clearEmailPreferences()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];
| Type | Description |
TransferRun.Builder |
clearEndTime()
public TransferRun.Builder clearEndTime()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];
| Type | Description |
TransferRun.Builder |
clearErrorStatus()
public TransferRun.Builder clearErrorStatus()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Type | Description |
TransferRun.Builder |
clearField(Descriptors.FieldDescriptor field)
public TransferRun.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
field | FieldDescriptor |
| Type | Description |
TransferRun.Builder |
clearName()
public TransferRun.Builder clearName() 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;
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearNotificationPubsubTopic()
public TransferRun.Builder clearNotificationPubsubTopic() 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}/topics/{topic}
string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TransferRun.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
oneof | OneofDescriptor |
| Type | Description |
TransferRun.Builder |
clearParams()
public TransferRun.Builder clearParams()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];
| Type | Description |
TransferRun.Builder |
clearRunTime()
public TransferRun.Builder clearRunTime()For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Type | Description |
TransferRun.Builder |
clearSchedule()
public TransferRun.Builder clearSchedule() 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];
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearScheduleTime()
public TransferRun.Builder clearScheduleTime()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Type | Description |
TransferRun.Builder |
clearStartTime()
public TransferRun.Builder clearStartTime()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];
| Type | Description |
TransferRun.Builder |
clearState()
public TransferRun.Builder clearState()Data transfer run state. Ignored for input requests.
.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearUpdateTime()
public TransferRun.Builder clearUpdateTime()Output only. Last time the data transfer run state was updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
TransferRun.Builder |
clearUserId()
public TransferRun.Builder clearUserId()Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clone()
public TransferRun.Builder clone()| Type | Description |
TransferRun.Builder |
getDataSourceId()
public String getDataSourceId()Output only. Data source id.
string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
String | The dataSourceId. |
getDataSourceIdBytes()
public ByteString getDataSourceIdBytes()Output only. Data source id.
string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
ByteString | The bytes for dataSourceId. |
getDefaultInstanceForType()
public TransferRun getDefaultInstanceForType()| Type | Description |
TransferRun |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
Descriptor |
getDestinationCase()
public TransferRun.DestinationCase getDestinationCase()| Type | Description |
TransferRun.DestinationCase |
getDestinationDatasetId()
public String getDestinationDatasetId()Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
String | The destinationDatasetId. |
getDestinationDatasetIdBytes()
public ByteString getDestinationDatasetIdBytes()Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
ByteString | The bytes for destinationDatasetId. |
getEmailPreferences()
public 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];
| Type | Description |
EmailPreferences | The emailPreferences. |
getEmailPreferencesBuilder()
public EmailPreferences.Builder getEmailPreferencesBuilder()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];
| Type | Description |
EmailPreferences.Builder |
getEmailPreferencesOrBuilder()
public 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];
| Type | Description |
EmailPreferencesOrBuilder |
getEndTime()
public 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];
| Type | Description |
Timestamp | The endTime. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder()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];
| Type | Description |
Builder |
getEndTimeOrBuilder()
public 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];
| Type | Description |
TimestampOrBuilder |
getErrorStatus()
public Status getErrorStatus()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Type | Description |
com.google.rpc.Status | The errorStatus. |
getErrorStatusBuilder()
public Status.Builder getErrorStatusBuilder()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Type | Description |
com.google.rpc.Status.Builder |
getErrorStatusOrBuilder()
public StatusOrBuilder getErrorStatusOrBuilder()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Type | Description |
com.google.rpc.StatusOrBuilder |
getName()
public String getName() 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;
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes() 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;
| Type | Description |
ByteString | The bytes for name. |
getNotificationPubsubTopic()
public 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}/topics/{topic}
string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
String | The notificationPubsubTopic. |
getNotificationPubsubTopicBytes()
public 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}/topics/{topic}
string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
ByteString | The bytes for notificationPubsubTopic. |
getParams()
public 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];
| Type | Description |
Struct | The params. |
getParamsBuilder()
public Struct.Builder getParamsBuilder()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];
| Type | Description |
Builder |
getParamsOrBuilder()
public 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];
| Type | Description |
StructOrBuilder |
getRunTime()
public Timestamp getRunTime()For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Type | Description |
Timestamp | The runTime. |
getRunTimeBuilder()
public Timestamp.Builder getRunTimeBuilder()For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Type | Description |
Builder |
getRunTimeOrBuilder()
public TimestampOrBuilder getRunTimeOrBuilder()For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Type | Description |
TimestampOrBuilder |
getSchedule()
public 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];
| Type | Description |
String | The schedule. |
getScheduleBytes()
public 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];
| Type | Description |
ByteString | The bytes for schedule. |
getScheduleTime()
public Timestamp getScheduleTime()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Type | Description |
Timestamp | The scheduleTime. |
getScheduleTimeBuilder()
public Timestamp.Builder getScheduleTimeBuilder()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Type | Description |
Builder |
getScheduleTimeOrBuilder()
public TimestampOrBuilder getScheduleTimeOrBuilder()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Type | Description |
TimestampOrBuilder |
getStartTime()
public 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];
| Type | Description |
Timestamp | The startTime. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder()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];
| Type | Description |
Builder |
getStartTimeOrBuilder()
public 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];
| Type | Description |
TimestampOrBuilder |
getState()
public TransferState getState()Data transfer run state. Ignored for input requests.
.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
| Type | Description |
TransferState | The state. |
getStateValue()
public int getStateValue()Data transfer run state. Ignored for input requests.
.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
| Type | Description |
int | The enum numeric value on the wire for state. |
getUpdateTime()
public 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];
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Last time the data transfer run state was updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
Builder |
getUpdateTimeOrBuilder()
public 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];
| Type | Description |
TimestampOrBuilder |
getUserId()
public long getUserId()Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;
| Type | Description |
long | The userId. |
hasDestinationDatasetId()
public boolean hasDestinationDatasetId()Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
boolean | Whether the destinationDatasetId field is set. |
hasEmailPreferences()
public 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];
| Type | Description |
boolean | Whether the emailPreferences field is set. |
hasEndTime()
public 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];
| Type | Description |
boo |