public final class DataSourceDefinition extends GeneratedMessageV3 implements DataSourceDefinitionOrBuilder
Represents the data source definition.
Protobuf type google.cloud.bigquery.datatransfer.v1.DataSourceDefinition
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
DATA_SOURCE_FIELD_NUMBER
public static final int DATA_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RUN_TIME_OFFSET_FIELD_NUMBER
public static final int RUN_TIME_OFFSET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUPPORTED_LOCATION_IDS_FIELD_NUMBER
public static final int SUPPORTED_LOCATION_IDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUPPORT_EMAIL_FIELD_NUMBER
public static final int SUPPORT_EMAIL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TRANSFER_CONFIG_PUBSUB_TOPIC_FIELD_NUMBER
public static final int TRANSFER_CONFIG_PUBSUB_TOPIC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TRANSFER_RUN_PUBSUB_TOPIC_FIELD_NUMBER
public static final int TRANSFER_RUN_PUBSUB_TOPIC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DataSourceDefinition getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DataSourceDefinition.Builder newBuilder()
newBuilder(DataSourceDefinition prototype)
public static DataSourceDefinition.Builder newBuilder(DataSourceDefinition prototype)
public static DataSourceDefinition parseDelimitedFrom(InputStream input)
public static DataSourceDefinition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DataSourceDefinition parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataSourceDefinition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DataSourceDefinition parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataSourceDefinition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataSourceDefinition parseFrom(CodedInputStream input)
public static DataSourceDefinition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataSourceDefinition parseFrom(InputStream input)
public static DataSourceDefinition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DataSourceDefinition parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataSourceDefinition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DataSourceDefinition> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDataSource()
public DataSource getDataSource()
Data source metadata.
.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;
getDataSourceOrBuilder()
public DataSourceOrBuilder getDataSourceOrBuilder()
Data source metadata.
.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;
getDefaultInstanceForType()
public DataSourceDefinition getDefaultInstanceForType()
getDisabled()
public boolean getDisabled()
Is data source disabled? If true, data_source is not visible.
API will also stop returning any data transfer configs and/or runs
associated with the data source. This setting has higher priority
than whitelisted_project_ids.
bool disabled = 5;
getName()
The resource name of the data source definition.
Data source definition names have the form
projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}.
string name = 21;
| Returns |
| Type |
Description |
String |
|
getNameBytes()
public ByteString getNameBytes()
The resource name of the data source definition.
Data source definition names have the form
projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}.
string name = 21;
getParserForType()
public Parser<DataSourceDefinition> getParserForType()
Overrides
getRunTimeOffset()
public Duration getRunTimeOffset()
Duration which should be added to schedule_time to calculate
run_time when job is scheduled. Only applicable for automatically
scheduled transfer runs. Used to start a run early on a data source that
supports continuous data refresh to compensate for unknown timezone
offsets. Use a negative number to start a run late for data sources not
supporting continuous data refresh.
.google.protobuf.Duration run_time_offset = 16;
getRunTimeOffsetOrBuilder()
public DurationOrBuilder getRunTimeOffsetOrBuilder()
Duration which should be added to schedule_time to calculate
run_time when job is scheduled. Only applicable for automatically
scheduled transfer runs. Used to start a run early on a data source that
supports continuous data refresh to compensate for unknown timezone
offsets. Use a negative number to start a run late for data sources not
supporting continuous data refresh.
.google.protobuf.Duration run_time_offset = 16;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServiceAccount()
public String getServiceAccount()
When service account is specified, BigQuery will share created dataset
with the given service account. Also, this service account will be
eligible to perform status updates and message logging for data transfer
runs for the corresponding data_source_id.
string service_account = 2;
| Returns |
| Type |
Description |
String |
|
getServiceAccountBytes()
public ByteString getServiceAccountBytes()
When service account is specified, BigQuery will share created dataset
with the given service account. Also, this service account will be
eligible to perform status updates and message logging for data transfer
runs for the corresponding data_source_id.
string service_account = 2;
getSupportEmail()
public String getSupportEmail()
Support e-mail address of the OAuth client's Brand, which contains the
consent screen data.
string support_email = 22;
| Returns |
| Type |
Description |
String |
|
getSupportEmailBytes()
public ByteString getSupportEmailBytes()
Support e-mail address of the OAuth client's Brand, which contains the
consent screen data.
string support_email = 22;
getSupportedLocationIds(int index)
public String getSupportedLocationIds(int index)
Supported location_ids used for deciding in which locations Pub/Sub topics
need to be created. If custom Pub/Sub topics are used and they contains
'{location}', the location_ids will be used for validating the topics by
replacing the '{location}' with the individual location in the list. The
valid values are the "location_id" field of the response of GET
https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations
In addition, if the data source needs to support all available regions,
supported_location_ids can be set to "global" (a single string element).
When "global" is specified:
1) the data source implementation is supposed to stage the data in proper
region of the destination dataset;
2) Data source developer should be aware of the implications (e.g., network
traffic latency, potential charge associated with cross-region traffic,
etc.) of supporting the "global" region;
repeated string supported_location_ids = 23;
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
String |
|
getSupportedLocationIdsBytes(int index)
public ByteString getSupportedLocationIdsBytes(int index)
Supported location_ids used for deciding in which locations Pub/Sub topics
need to be created. If custom Pub/Sub topics are used and they contains
'{location}', the location_ids will be used for validating the topics by
replacing the '{location}' with the individual location in the list. The
valid values are the "location_id" field of the response of GET
https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations
In addition, if the data source needs to support all available regions,
supported_location_ids can be set to "global" (a single string element).
When "global" is specified:
1) the data source implementation is supposed to stage the data in proper
region of the destination dataset;
2) Data source developer should be aware of the implications (e.g., network
traffic latency, potential charge associated with cross-region traffic,
etc.) of supporting the "global" region;
repeated string supported_location_ids = 23;
| Parameter |
| Name |
Description |
index |
int
|
getSupportedLocationIdsCount()
public int getSupportedLocationIdsCount()
Supported location_ids used for deciding in which locations Pub/Sub topics
need to be created. If custom Pub/Sub topics are used and they contains
'{location}', the location_ids will be used for validating the topics by
replacing the '{location}' with the individual location in the list. The
valid values are the "location_id" field of the response of GET
https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations
In addition, if the data source needs to support all available regions,
supported_location_ids can be set to "global" (a single string element).
When "global" is specified:
1) the data source implementation is supposed to stage the data in proper
region of the destination dataset;
2) Data source developer should be aware of the implications (e.g., network
traffic latency, potential charge associated with cross-region traffic,
etc.) of supporting the "global" region;
repeated string supported_location_ids = 23;
| Returns |
| Type |
Description |
int |
|
getSupportedLocationIdsList()
public ProtocolStringList getSupportedLocationIdsList()
Supported location_ids used for deciding in which locations Pub/Sub topics
need to be created. If custom Pub/Sub topics are used and they contains
'{location}', the location_ids will be used for validating the topics by
replacing the '{location}' with the individual location in the list. The
valid values are the "location_id" field of the response of GET
https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations
In addition, if the data source needs to support all available regions,
supported_location_ids can be set to "global" (a single string element).
When "global" is specified:
1) the data source implementation is supposed to stage the data in proper
region of the destination dataset;
2) Data source developer should be aware of the implications (e.g., network
traffic latency, potential charge associated with cross-region traffic,
etc.) of supporting the "global" region;
repeated string supported_location_ids = 23;
getTransferConfigPubsubTopic()
public String getTransferConfigPubsubTopic()
The Pub/Sub topic to use for broadcasting a message for transfer config. If
empty, a message will not be broadcasted. Both this topic and
transfer_run_pubsub_topic are auto-generated if none of them is provided
when creating the definition. It is recommended to provide
transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is
provided. Otherwise, it will be set to empty. If "{location}" is found in
the value, then that means, data source wants to handle message separately
for datasets in different regions. We will replace {location} with the
actual dataset location, as the actual topic name. For example,
projects/connector/topics/scheduler-{location} could become
projects/connector/topics/scheduler-us. If "{location}" is not found, then
we will use the input value as topic name.
string transfer_config_pubsub_topic = 12;
| Returns |
| Type |
Description |
String |
|
getTransferConfigPubsubTopicBytes()
public ByteString getTransferConfigPubsubTopicBytes()
The Pub/Sub topic to use for broadcasting a message for transfer config. If
empty, a message will not be broadcasted. Both this topic and
transfer_run_pubsub_topic are auto-generated if none of them is provided
when creating the definition. It is recommended to provide
transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is
provided. Otherwise, it will be set to empty. If "{location}" is found in
the value, then that means, data source wants to handle message separately
for datasets in different regions. We will replace {location} with the
actual dataset location, as the actual topic name. For example,
projects/connector/topics/scheduler-{location} could become
projects/connector/topics/scheduler-us. If "{location}" is not found, then
we will use the input value as topic name.
string transfer_config_pubsub_topic = 12;
getTransferRunPubsubTopic()
public String getTransferRunPubsubTopic()
The Pub/Sub topic to be used for broadcasting a message when a transfer run
is created. Both this topic and transfer_config_pubsub_topic can be
set to a custom topic. By default, both topics are auto-generated if none
of them is provided when creating the definition. However, if one topic is
manually set, the other topic has to be manually set as well. The only
difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub
topic, but transfer_config_pubsub_topic can be set to empty. The comments
about "{location}" for transfer_config_pubsub_topic apply here too.
string transfer_run_pubsub_topic = 13;
| Returns |
| Type |
Description |
String |
|
getTransferRunPubsubTopicBytes()
public ByteString getTransferRunPubsubTopicBytes()
The Pub/Sub topic to be used for broadcasting a message when a transfer run
is created. Both this topic and transfer_config_pubsub_topic can be
set to a custom topic. By default, both topics are auto-generated if none
of them is provided when creating the definition. However, if one topic is
manually set, the other topic has to be manually set as well. The only
difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub
topic, but transfer_config_pubsub_topic can be set to empty. The comments
about "{location}" for transfer_config_pubsub_topic apply here too.
string transfer_run_pubsub_topic = 13;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasDataSource()
public boolean hasDataSource()
Data source metadata.
.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;
hasRunTimeOffset()
public boolean hasRunTimeOffset()
Duration which should be added to schedule_time to calculate
run_time when job is scheduled. Only applicable for automatically
scheduled transfer runs. Used to start a run early on a data source that
supports continuous data refresh to compensate for unknown timezone
offsets. Use a negative number to start a run late for data sources not
supporting continuous data refresh.
.google.protobuf.Duration run_time_offset = 16;
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DataSourceDefinition.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataSourceDefinition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
toBuilder()
public DataSourceDefinition.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
