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

Class TransferRun

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.bigquery.datatransfer.v1.TransferRun
All Implemented Interfaces:
TransferRunOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TransferRun extends com.google.protobuf.GeneratedMessage implements TransferRunOrBuilder
 Represents a data transfer run.
Protobuf type google.cloud.bigquery.datatransfer.v1.TransferRun
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • SCHEDULE_TIME_FIELD_NUMBER

      public static final int SCHEDULE_TIME_FIELD_NUMBER
      See Also:

    • RUN_TIME_FIELD_NUMBER

      public static final int RUN_TIME_FIELD_NUMBER
      See Also:

    • ERROR_STATUS_FIELD_NUMBER

      public static final int ERROR_STATUS_FIELD_NUMBER
      See Also:

    • START_TIME_FIELD_NUMBER

      public static final int START_TIME_FIELD_NUMBER
      See Also:

    • END_TIME_FIELD_NUMBER

      public static final int END_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • PARAMS_FIELD_NUMBER

      public static final int PARAMS_FIELD_NUMBER
      See Also:

    • DESTINATION_DATASET_ID_FIELD_NUMBER

      public static final int DESTINATION_DATASET_ID_FIELD_NUMBER
      See Also:

    • DATA_SOURCE_ID_FIELD_NUMBER

      public static final int DATA_SOURCE_ID_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • USER_ID_FIELD_NUMBER

      public static final int USER_ID_FIELD_NUMBER
      See Also:

    • SCHEDULE_FIELD_NUMBER

      public static final int SCHEDULE_FIELD_NUMBER
      See Also:

    • NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

      public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
      See Also:

    • EMAIL_PREFERENCES_FIELD_NUMBER

      public static final int EMAIL_PREFERENCES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDestinationCase

      public TransferRun.DestinationCase getDestinationCase()
      Specified by:
      getDestinationCase in interface TransferRunOrBuilder

    • getName

      public 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];
      Specified by:
      getName in interface TransferRunOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface TransferRunOrBuilder
      Returns:
      The bytes for name.

    • hasScheduleTime

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

    • getScheduleTime

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

    • getScheduleTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder()
       Minimum time after which a transfer run can be started.
      .google.protobuf.Timestamp schedule_time = 3;
      Specified by:
      getScheduleTimeOrBuilder in interface TransferRunOrBuilder

    • hasRunTime

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

    • getRunTime

      public 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;
      Specified by:
      getRunTime in interface TransferRunOrBuilder
      Returns:
      The runTime.

    • getRunTimeOrBuilder

      public 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;
      Specified by:
      getRunTimeOrBuilder in interface TransferRunOrBuilder

    • hasErrorStatus

      public boolean hasErrorStatus()
       Status of the transfer run.
      .google.rpc.Status error_status = 21;
      Specified by:
      hasErrorStatus in interface TransferRunOrBuilder
      Returns:
      Whether the errorStatus field is set.

    • getErrorStatus

      public Status getErrorStatus()
       Status of the transfer run.
      .google.rpc.Status error_status = 21;
      Specified by:
      getErrorStatus in interface TransferRunOrBuilder
      Returns:
      The errorStatus.

    • getErrorStatusOrBuilder

      public StatusOrBuilder getErrorStatusOrBuilder()
       Status of the transfer run.
      .google.rpc.Status error_status = 21;
      Specified by:
      getErrorStatusOrBuilder in interface TransferRunOrBuilder

    • hasStartTime

      public 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];
      Specified by:
      hasStartTime in interface TransferRunOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public 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];
      Specified by:
      getStartTime in interface TransferRunOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public 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];
      Specified by:
      getStartTimeOrBuilder in interface TransferRunOrBuilder

    • 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];
      Specified by:
      hasEndTime in interface TransferRunOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public 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];
      Specified by:
      getEndTime in interface TransferRunOrBuilder
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      public 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];
      Specified by:
      getEndTimeOrBuilder in interface TransferRunOrBuilder

    • hasUpdateTime

      public 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];
      Specified by:
      hasUpdateTime in interface TransferRunOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface TransferRunOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface TransferRunOrBuilder

    • hasParams

      public 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];
      Specified by:
      hasParams in interface TransferRunOrBuilder
      Returns:
      Whether the params field is set.

    • getParams

      public 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];
      Specified by:
      getParams in interface TransferRunOrBuilder
      Returns:
      The params.

    • getParamsOrBuilder

      public 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];
      Specified by:
      getParamsOrBuilder in interface TransferRunOrBuilder

    • hasDestinationDatasetId

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

    • getDestinationDatasetId

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

    • getDestinationDatasetIdBytes

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

    • getDataSourceId

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

    • getDataSourceIdBytes

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

    • getStateValue

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

    • getState

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

    • getUserId

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

    • 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];
      Specified by:
      getSchedule in interface TransferRunOrBuilder
      Returns:
      The schedule.

    • getScheduleBytes

      public 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];
      Specified by:
      getScheduleBytes in interface TransferRunOrBuilder
      Returns:
      The bytes for schedule.

    • 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_id}/topics/{topic_id}`
      string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNotificationPubsubTopic in interface TransferRunOrBuilder
      Returns:
      The notificationPubsubTopic.

    • getNotificationPubsubTopicBytes

      public 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_id}/topics/{topic_id}`
      string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNotificationPubsubTopicBytes in interface TransferRunOrBuilder
      Returns:
      The bytes for notificationPubsubTopic.

    • 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];
      Specified by:
      hasEmailPreferences in interface TransferRunOrBuilder
      Returns:
      Whether the emailPreferences field is set.

    • 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];
      Specified by:
      getEmailPreferences in interface TransferRunOrBuilder
      Returns:
      The emailPreferences.

    • 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];
      Specified by:
      getEmailPreferencesOrBuilder in interface TransferRunOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TransferRun parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferRun parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferRun parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferRun parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferRun parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferRun parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferRun parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferRun parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferRun parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferRun parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferRun parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferRun parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TransferRun.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TransferRun.Builder newBuilder()

    • newBuilder

      public static TransferRun.Builder newBuilder(TransferRun prototype)

    • toBuilder

      public TransferRun.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TransferRun.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TransferRun getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TransferRun> parser()

    • getParserForType

      public com.google.protobuf.Parser<TransferRun> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public TransferRun getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder