/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/bigquery/datatransfer/v1/transfer.proto
package com.google.cloud.bigquery.datatransfer.v1;
public interface TransferRunOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.bigquery.datatransfer.v1.TransferRun)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The name.
*/
java.lang.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;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Minimum time after which a transfer run can be started.
*
*
* .google.protobuf.Timestamp schedule_time = 3;
*
* @return Whether the scheduleTime field is set.
*/
boolean hasScheduleTime();
/**
*
*
*
* Minimum time after which a transfer run can be started.
*
*
* .google.protobuf.Timestamp schedule_time = 3;
*
* @return The scheduleTime.
*/
com.google.protobuf.Timestamp getScheduleTime();
/**
*
*
*
* Minimum time after which a transfer run can be started.
*
*
* .google.protobuf.Timestamp schedule_time = 3;
*/
com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder();
/**
*
*
*
* For batch transfer runs, specifies the date and time of the data should be
* ingested.
*
*
* .google.protobuf.Timestamp run_time = 10;
*
* @return Whether the runTime field is set.
*/
boolean hasRunTime();
/**
*
*
*
* For batch transfer runs, specifies the date and time of the data should be
* ingested.
*
*
* .google.protobuf.Timestamp run_time = 10;
*
* @return The runTime.
*/
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;
*/
com.google.protobuf.TimestampOrBuilder getRunTimeOrBuilder();
/**
*
*
*
* Status of the transfer run.
*
*
* .google.rpc.Status error_status = 21;
*
* @return Whether the errorStatus field is set.
*/
boolean hasErrorStatus();
/**
*
*
*
* Status of the transfer run.
*
*
* .google.rpc.Status error_status = 21;
*
* @return The errorStatus.
*/
com.google.rpc.Status getErrorStatus();
/**
*
*
*
* Status of the transfer run.
*
*
* .google.rpc.Status error_status = 21;
*/
com.google.rpc.StatusOrBuilder getErrorStatusOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the startTime field is set.
*/
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];
*
*
* @return The startTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the endTime field is set.
*/
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];
*
*
* @return The endTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder();
/**
*
*
*
* Output only. Last time the data transfer run state was updated.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
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];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* 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];
*
* @return Whether the params field is set.
*/
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];
*
* @return The params.
*/
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];
*/
com.google.protobuf.StructOrBuilder getParamsOrBuilder();
/**
*
*
*
* Output only. The BigQuery target dataset id.
*
*
* string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return Whether the destinationDatasetId field is set.
*/
boolean hasDestinationDatasetId();
/**
*
*
*
* Output only. The BigQuery target dataset id.
*
*
* string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The destinationDatasetId.
*/
java.lang.String getDestinationDatasetId();
/**
*
*
*
* Output only. The BigQuery target dataset id.
*
*
* string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for destinationDatasetId.
*/
com.google.protobuf.ByteString getDestinationDatasetIdBytes();
/**
*
*
*
* Output only. Data source id.
*
*
* string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The dataSourceId.
*/
java.lang.String getDataSourceId();
/**
*
*
*
* Output only. Data source id.
*
*
* string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for dataSourceId.
*/
com.google.protobuf.ByteString getDataSourceIdBytes();
/**
*
*
*
* Data transfer run state. Ignored for input requests.
*
*
* .google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Data transfer run state. Ignored for input requests.
*
*
* .google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
*
* @return The state.
*/
com.google.cloud.bigquery.datatransfer.v1.TransferState getState();
/**
*
*
*
* Deprecated. Unique ID of the user on whose behalf transfer is done.
*
*
* int64 user_id = 11;
*
* @return The userId.
*/
long getUserId();
/**
*
*
*
* 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];
*
* @return The schedule.
*/
java.lang.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];
*
* @return The bytes for schedule.
*/
com.google.protobuf.ByteString getScheduleBytes();
/**
*
*
*
* 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];
*
*
* @return The notificationPubsubTopic.
*/
java.lang.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];
*
*
* @return The bytes for notificationPubsubTopic.
*/
com.google.protobuf.ByteString getNotificationPubsubTopicBytes();
/**
*
*
*
* 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];
*
*
* @return Whether the emailPreferences field is set.
*/
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];
*
*
* @return The emailPreferences.
*/
com.google.cloud.bigquery.datatransfer.v1.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];
*
*/
com.google.cloud.bigquery.datatransfer.v1.EmailPreferencesOrBuilder
getEmailPreferencesOrBuilder();
public com.google.cloud.bigquery.datatransfer.v1.TransferRun.DestinationCase getDestinationCase();
}