Package com.google.cloud.bigquery.datatransfer.v1

Interface TransferRunOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TransferRun, TransferRun.Builder
    public interface TransferRunOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.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;
        Returns:
        The bytes for name.

      • hasScheduleTime

        boolean hasScheduleTime()
         Minimum time after which a transfer run can be started.
        .google.protobuf.Timestamp schedule_time = 3;
        Returns:
        Whether the scheduleTime field is set.

      • getScheduleTime

        com.google.protobuf.Timestamp getScheduleTime()
         Minimum time after which a transfer run can be started.
        .google.protobuf.Timestamp schedule_time = 3;
        Returns:
        The scheduleTime.

      • getScheduleTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder()
         Minimum time after which a transfer run can be started.
        .google.protobuf.Timestamp schedule_time = 3;

      • hasRunTime

        boolean hasRunTime()
         For batch transfer runs, specifies the date and time of the data should be
 ingested.
        .google.protobuf.Timestamp run_time = 10;
        Returns:
        Whether the runTime field is set.

      • getRunTime

        com.google.protobuf.Timestamp getRunTime()
         For batch transfer runs, specifies the date and time of the data should be
 ingested.
        .google.protobuf.Timestamp run_time = 10;
        Returns:
        The runTime.

      • getRunTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getRunTimeOrBuilder()
         For batch transfer runs, specifies the date and time of the data should be
 ingested.
        .google.protobuf.Timestamp run_time = 10;

      • hasErrorStatus

        boolean hasErrorStatus()
         Status of the transfer run.
        .google.rpc.Status error_status = 21;
        Returns:
        Whether the errorStatus field is set.

      • getErrorStatus

        com.google.rpc.Status getErrorStatus()
         Status of the transfer run.
        .google.rpc.Status error_status = 21;
        Returns:
        The errorStatus.

      • getErrorStatusOrBuilder

        com.google.rpc.StatusOrBuilder getErrorStatusOrBuilder()
         Status of the transfer run.
        .google.rpc.Status error_status = 21;

      • hasStartTime

        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:
        Whether the startTime field is set.

      • getStartTime

        com.google.protobuf.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:
        The startTime.

      • getStartTimeOrBuilder

        com.google.protobuf.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];

      • hasEndTime

        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:
        Whether the endTime field is set.

      • getEndTime

        com.google.protobuf.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:
        The endTime.

      • getEndTimeOrBuilder

        com.google.protobuf.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];

      • hasUpdateTime

        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:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.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:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.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];

      • hasParams

        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:
        Whether the params field is set.

      • getParams

        com.google.protobuf.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:
        The params.

      • getParamsOrBuilder

        com.google.protobuf.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];

      • hasDestinationDatasetId

        boolean hasDestinationDatasetId()
         Output only. The BigQuery target dataset id.
        string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the destinationDatasetId field is set.

      • getDestinationDatasetId

        String getDestinationDatasetId()
         Output only. The BigQuery target dataset id.
        string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The destinationDatasetId.

      • getDestinationDatasetIdBytes

        com.google.protobuf.ByteString getDestinationDatasetIdBytes()
         Output only. The BigQuery target dataset id.
        string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for destinationDatasetId.

      • getDataSourceId

        String getDataSourceId()
         Output only. Data source id.
        string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The dataSourceId.

      • getDataSourceIdBytes

        com.google.protobuf.ByteString getDataSourceIdBytes()
         Output only. Data source id.
        string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for dataSourceId.

      • getStateValue

        int getStateValue()
         Data transfer run state. Ignored for input requests.
        .google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
        Returns:
        The enum numeric value on the wire for state.

      • getState

        TransferState getState()
         Data transfer run state. Ignored for input requests.
        .google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
        Returns:
        The state.

      • getUserId

        long getUserId()
         Deprecated. Unique ID of the user on whose behalf transfer is done.
        int64 user_id = 11;
        Returns:
        The userId.

      • getSchedule

        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:
        The schedule.

      • getScheduleBytes

        com.google.protobuf.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:
        The bytes for schedule.

      • getNotificationPubsubTopic

        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];
        Returns:
        The notificationPubsubTopic.

      • getNotificationPubsubTopicBytes

        com.google.protobuf.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];
        Returns:
        The bytes for notificationPubsubTopic.

      • hasEmailPreferences

        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:
        Whether the emailPreferences field is set.

      • getEmailPreferences

        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:
        The emailPreferences.

      • getEmailPreferencesOrBuilder

        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];