public final class DataSourceDefinition extends com.google.protobuf.GeneratedMessageV3 implements DataSourceDefinitionOrBuilder
Represents the data source definition.Protobuf type
google.cloud.bigquery.datatransfer.v1.DataSourceDefinition| Modifier and Type | Class and Description |
|---|---|
static class |
DataSourceDefinition.Builder
Represents the data source definition.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
DATA_SOURCE_FIELD_NUMBER |
static int |
DISABLED_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
RUN_TIME_OFFSET_FIELD_NUMBER |
static int |
SERVICE_ACCOUNT_FIELD_NUMBER |
static int |
SUPPORT_EMAIL_FIELD_NUMBER |
static int |
SUPPORTED_LOCATION_IDS_FIELD_NUMBER |
static int |
TRANSFER_CONFIG_PUBSUB_TOPIC_FIELD_NUMBER |
static int |
TRANSFER_RUN_PUBSUB_TOPIC_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
DataSource |
getDataSource()
Data source metadata.
|
DataSourceOrBuilder |
getDataSourceOrBuilder()
Data source metadata.
|
static DataSourceDefinition |
getDefaultInstance() |
DataSourceDefinition |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getDisabled()
Is data source disabled? If true, data_source is not visible.
|
String |
getName()
The resource name of the data source definition.
|
com.google.protobuf.ByteString |
getNameBytes()
The resource name of the data source definition.
|
com.google.protobuf.Parser<DataSourceDefinition> |
getParserForType() |
com.google.protobuf.Duration |
getRunTimeOffset()
Duration which should be added to schedule_time to calculate
run_time when job is scheduled.
|
com.google.protobuf.DurationOrBuilder |
getRunTimeOffsetOrBuilder()
Duration which should be added to schedule_time to calculate
run_time when job is scheduled.
|
int |
getSerializedSize() |
String |
getServiceAccount()
When service account is specified, BigQuery will share created dataset
with the given service account.
|
com.google.protobuf.ByteString |
getServiceAccountBytes()
When service account is specified, BigQuery will share created dataset
with the given service account.
|
String |
getSupportedLocationIds(int index)
Supported location_ids used for deciding in which locations Pub/Sub topics
need to be created.
|
com.google.protobuf.ByteString |
getSupportedLocationIdsBytes(int index)
Supported location_ids used for deciding in which locations Pub/Sub topics
need to be created.
|
int |
getSupportedLocationIdsCount()
Supported location_ids used for deciding in which locations Pub/Sub topics
need to be created.
|
com.google.protobuf.ProtocolStringList |
getSupportedLocationIdsList()
Supported location_ids used for deciding in which locations Pub/Sub topics
need to be created.
|
String |
getSupportEmail()
Support e-mail address of the OAuth client's Brand, which contains the
consent screen data.
|
com.google.protobuf.ByteString |
getSupportEmailBytes()
Support e-mail address of the OAuth client's Brand, which contains the
consent screen data.
|
String |
getTransferConfigPubsubTopic()
The Pub/Sub topic to use for broadcasting a message for transfer config.
|
com.google.protobuf.ByteString |
getTransferConfigPubsubTopicBytes()
The Pub/Sub topic to use for broadcasting a message for transfer config.
|
String |
getTransferRunPubsubTopic()
The Pub/Sub topic to be used for broadcasting a message when a transfer run
is created.
|
com.google.protobuf.ByteString |
getTransferRunPubsubTopicBytes()
The Pub/Sub topic to be used for broadcasting a message when a transfer run
is created.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasDataSource()
Data source metadata.
|
int |
hashCode() |
boolean |
hasRunTimeOffset()
Duration which should be added to schedule_time to calculate
run_time when job is scheduled.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static DataSourceDefinition.Builder |
newBuilder() |
static DataSourceDefinition.Builder |
newBuilder(DataSourceDefinition prototype) |
DataSourceDefinition.Builder |
newBuilderForType() |
protected DataSourceDefinition.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static DataSourceDefinition |
parseDelimitedFrom(InputStream input) |
static DataSourceDefinition |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSourceDefinition |
parseFrom(byte[] data) |
static DataSourceDefinition |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSourceDefinition |
parseFrom(ByteBuffer data) |
static DataSourceDefinition |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSourceDefinition |
parseFrom(com.google.protobuf.ByteString data) |
static DataSourceDefinition |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSourceDefinition |
parseFrom(com.google.protobuf.CodedInputStream input) |
static DataSourceDefinition |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSourceDefinition |
parseFrom(InputStream input) |
static DataSourceDefinition |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<DataSourceDefinition> |
parser() |
DataSourceDefinition.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DATA_SOURCE_FIELD_NUMBER
public static final int TRANSFER_RUN_PUBSUB_TOPIC_FIELD_NUMBER
public static final int RUN_TIME_OFFSET_FIELD_NUMBER
public static final int SUPPORT_EMAIL_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
public static final int TRANSFER_CONFIG_PUBSUB_TOPIC_FIELD_NUMBER
public static final int SUPPORTED_LOCATION_IDS_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String 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;getName in interface DataSourceDefinitionOrBuilderpublic com.google.protobuf.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;getNameBytes in interface DataSourceDefinitionOrBuilderpublic boolean hasDataSource()
Data source metadata.
.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;hasDataSource in interface DataSourceDefinitionOrBuilderpublic DataSource getDataSource()
Data source metadata.
.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;getDataSource in interface DataSourceDefinitionOrBuilderpublic DataSourceOrBuilder getDataSourceOrBuilder()
Data source metadata.
.google.cloud.bigquery.datatransfer.v1.DataSource data_source = 1;getDataSourceOrBuilder in interface DataSourceDefinitionOrBuilderpublic 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;getTransferRunPubsubTopic in interface DataSourceDefinitionOrBuilderpublic com.google.protobuf.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;getTransferRunPubsubTopicBytes in interface DataSourceDefinitionOrBuilderpublic 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;hasRunTimeOffset in interface DataSourceDefinitionOrBuilderpublic com.google.protobuf.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;getRunTimeOffset in interface DataSourceDefinitionOrBuilderpublic com.google.protobuf.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;getRunTimeOffsetOrBuilder in interface DataSourceDefinitionOrBuilderpublic String getSupportEmail()
Support e-mail address of the OAuth client's Brand, which contains the consent screen data.
string support_email = 22;getSupportEmail in interface DataSourceDefinitionOrBuilderpublic com.google.protobuf.ByteString getSupportEmailBytes()
Support e-mail address of the OAuth client's Brand, which contains the consent screen data.
string support_email = 22;getSupportEmailBytes in interface DataSourceDefinitionOrBuilderpublic 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;getServiceAccount in interface DataSourceDefinitionOrBuilderpublic com.google.protobuf.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;getServiceAccountBytes in interface DataSourceDefinitionOrBuilderpublic 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;getDisabled in interface DataSourceDefinitionOrBuilderpublic 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;getTransferConfigPubsubTopic in interface DataSourceDefinitionOrBuilderpublic com.google.protobuf.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;getTransferConfigPubsubTopicBytes in interface DataSourceDefinitionOrBuilderpublic com.google.protobuf.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;getSupportedLocationIdsList in interface DataSourceDefinitionOrBuilderpublic 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;getSupportedLocationIdsCount in interface DataSourceDefinitionOrBuilderpublic 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;getSupportedLocationIds in interface DataSourceDefinitionOrBuilderpublic com.google.protobuf.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;getSupportedLocationIdsBytes in interface DataSourceDefinitionOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static DataSourceDefinition parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSourceDefinition parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSourceDefinition parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSourceDefinition parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSourceDefinition parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSourceDefinition parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSourceDefinition parseFrom(InputStream input) throws IOException
IOExceptionpublic static DataSourceDefinition parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static DataSourceDefinition parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static DataSourceDefinition parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static DataSourceDefinition parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static DataSourceDefinition parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic DataSourceDefinition.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static DataSourceDefinition.Builder newBuilder()
public static DataSourceDefinition.Builder newBuilder(DataSourceDefinition prototype)
public DataSourceDefinition.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected DataSourceDefinition.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static DataSourceDefinition getDefaultInstance()
public static com.google.protobuf.Parser<DataSourceDefinition> parser()
public com.google.protobuf.Parser<DataSourceDefinition> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public DataSourceDefinition getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.