public final class DataSource extends GeneratedMessageV3 implements DataSourceOrBuilder
Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.Protobuf type
google.cloud.bigquery.datatransfer.v1.DataSource| Modifier and Type | Class and Description |
|---|---|
static class |
DataSource.AuthorizationType
The type of authorization needed for this data source.
|
static class |
DataSource.Builder
Represents data source metadata.
|
static class |
DataSource.DataRefreshType
Represents how the data source supports data auto refresh.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
AUTHORIZATION_TYPE_FIELD_NUMBER |
static int |
CLIENT_ID_FIELD_NUMBER |
static int |
DATA_REFRESH_TYPE_FIELD_NUMBER |
static int |
DATA_SOURCE_ID_FIELD_NUMBER |
static int |
DEFAULT_DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER |
static int |
DEFAULT_SCHEDULE_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
HELP_URL_FIELD_NUMBER |
static int |
MANUAL_RUNS_DISABLED_FIELD_NUMBER |
static int |
MINIMUM_SCHEDULE_INTERVAL_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PARAMETERS_FIELD_NUMBER |
static int |
SCOPES_FIELD_NUMBER |
static int |
SUPPORTS_CUSTOM_SCHEDULE_FIELD_NUMBER |
static int |
SUPPORTS_MULTIPLE_TRANSFERS_FIELD_NUMBER |
static int |
TRANSFER_TYPE_FIELD_NUMBER |
static int |
UPDATE_DEADLINE_SECONDS_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCode| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
DataSource.AuthorizationType |
getAuthorizationType()
Indicates the type of authorization.
|
int |
getAuthorizationTypeValue()
Indicates the type of authorization.
|
java.lang.String |
getClientId()
Data source client id which should be used to receive refresh token.
|
ByteString |
getClientIdBytes()
Data source client id which should be used to receive refresh token.
|
DataSource.DataRefreshType |
getDataRefreshType()
Specifies whether the data source supports automatic data refresh for the
past few days, and how it's supported.
|
int |
getDataRefreshTypeValue()
Specifies whether the data source supports automatic data refresh for the
past few days, and how it's supported.
|
java.lang.String |
getDataSourceId()
Data source id.
|
ByteString |
getDataSourceIdBytes()
Data source id.
|
int |
getDefaultDataRefreshWindowDays()
Default data refresh window on days.
|
static DataSource |
getDefaultInstance() |
DataSource |
getDefaultInstanceForType() |
java.lang.String |
getDefaultSchedule()
Default data transfer schedule.
|
ByteString |
getDefaultScheduleBytes()
Default data transfer schedule.
|
java.lang.String |
getDescription()
User friendly data source description string.
|
ByteString |
getDescriptionBytes()
User friendly data source description string.
|
static Descriptors.Descriptor |
getDescriptor() |
java.lang.String |
getDisplayName()
User friendly data source name.
|
ByteString |
getDisplayNameBytes()
User friendly data source name.
|
java.lang.String |
getHelpUrl()
Url for the help document for this data source.
|
ByteString |
getHelpUrlBytes()
Url for the help document for this data source.
|
boolean |
getManualRunsDisabled()
Disables backfilling and manual run scheduling
for the data source.
|
Duration |
getMinimumScheduleInterval()
The minimum interval for scheduler to schedule runs.
|
DurationOrBuilder |
getMinimumScheduleIntervalOrBuilder()
The minimum interval for scheduler to schedule runs.
|
java.lang.String |
getName()
Output only.
|
ByteString |
getNameBytes()
Output only.
|
DataSourceParameter |
getParameters(int index)
Data source parameters.
|
int |
getParametersCount()
Data source parameters.
|
java.util.List<DataSourceParameter> |
getParametersList()
Data source parameters.
|
DataSourceParameterOrBuilder |
getParametersOrBuilder(int index)
Data source parameters.
|
java.util.List<? extends DataSourceParameterOrBuilder> |
getParametersOrBuilderList()
Data source parameters.
|
Parser<DataSource> |
getParserForType() |
java.lang.String |
getScopes(int index)
Api auth scopes for which refresh token needs to be obtained.
|
ByteString |
getScopesBytes(int index)
Api auth scopes for which refresh token needs to be obtained.
|
int |
getScopesCount()
Api auth scopes for which refresh token needs to be obtained.
|
ProtocolStringList |
getScopesList()
Api auth scopes for which refresh token needs to be obtained.
|
int |
getSerializedSize() |
boolean |
getSupportsCustomSchedule()
Specifies whether the data source supports a user defined schedule, or
operates on the default schedule.
|
boolean |
getSupportsMultipleTransfers()
Indicates whether the data source supports multiple transfers
to different BigQuery targets.
|
TransferType |
getTransferType()
Deprecated.
|
int |
getTransferTypeValue()
Deprecated.
|
UnknownFieldSet |
getUnknownFields() |
int |
getUpdateDeadlineSeconds()
The number of seconds to wait for an update from the data source
before BigQuery marks the transfer as failed.
|
int |
hashCode() |
boolean |
hasMinimumScheduleInterval()
The minimum interval for scheduler to schedule runs.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static DataSource.Builder |
newBuilder() |
static DataSource.Builder |
newBuilder(DataSource prototype) |
DataSource.Builder |
newBuilderForType() |
protected DataSource.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
static DataSource |
parseDelimitedFrom(java.io.InputStream input) |
static DataSource |
parseDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(byte[] data) |
static DataSource |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(java.nio.ByteBuffer data) |
static DataSource |
parseFrom(java.nio.ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(ByteString data) |
static DataSource |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(CodedInputStream input) |
static DataSource |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(java.io.InputStream input) |
static DataSource |
parseFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<DataSource> |
parser() |
DataSource.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int NAME_FIELD_NUMBER
public static final int DATA_SOURCE_ID_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int CLIENT_ID_FIELD_NUMBER
public static final int SCOPES_FIELD_NUMBER
public static final int TRANSFER_TYPE_FIELD_NUMBER
public static final int SUPPORTS_MULTIPLE_TRANSFERS_FIELD_NUMBER
public static final int UPDATE_DEADLINE_SECONDS_FIELD_NUMBER
public static final int DEFAULT_SCHEDULE_FIELD_NUMBER
public static final int SUPPORTS_CUSTOM_SCHEDULE_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
public static final int HELP_URL_FIELD_NUMBER
public static final int AUTHORIZATION_TYPE_FIELD_NUMBER
public static final int DATA_REFRESH_TYPE_FIELD_NUMBER
public static final int DEFAULT_DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
public static final int MANUAL_RUNS_DISABLED_FIELD_NUMBER
public static final int MINIMUM_SCHEDULE_INTERVAL_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public java.lang.String getName()
Output only. Data source resource name.
string name = 1;getName in interface DataSourceOrBuilderpublic ByteString getNameBytes()
Output only. Data source resource name.
string name = 1;getNameBytes in interface DataSourceOrBuilderpublic java.lang.String getDataSourceId()
Data source id.
string data_source_id = 2;getDataSourceId in interface DataSourceOrBuilderpublic ByteString getDataSourceIdBytes()
Data source id.
string data_source_id = 2;getDataSourceIdBytes in interface DataSourceOrBuilderpublic java.lang.String getDisplayName()
User friendly data source name.
string display_name = 3;getDisplayName in interface DataSourceOrBuilderpublic ByteString getDisplayNameBytes()
User friendly data source name.
string display_name = 3;getDisplayNameBytes in interface DataSourceOrBuilderpublic java.lang.String getDescription()
User friendly data source description string.
string description = 4;getDescription in interface DataSourceOrBuilderpublic ByteString getDescriptionBytes()
User friendly data source description string.
string description = 4;getDescriptionBytes in interface DataSourceOrBuilderpublic java.lang.String getClientId()
Data source client id which should be used to receive refresh token. When not supplied, no offline credentials are populated for data transfer.
string client_id = 5;getClientId in interface DataSourceOrBuilderpublic ByteString getClientIdBytes()
Data source client id which should be used to receive refresh token. When not supplied, no offline credentials are populated for data transfer.
string client_id = 5;getClientIdBytes in interface DataSourceOrBuilderpublic ProtocolStringList getScopesList()
Api auth scopes for which refresh token needs to be obtained. Only valid when `client_id` is specified. Ignored otherwise. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
repeated string scopes = 6;getScopesList in interface DataSourceOrBuilderpublic int getScopesCount()
Api auth scopes for which refresh token needs to be obtained. Only valid when `client_id` is specified. Ignored otherwise. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
repeated string scopes = 6;getScopesCount in interface DataSourceOrBuilderpublic java.lang.String getScopes(int index)
Api auth scopes for which refresh token needs to be obtained. Only valid when `client_id` is specified. Ignored otherwise. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
repeated string scopes = 6;getScopes in interface DataSourceOrBuilderpublic ByteString getScopesBytes(int index)
Api auth scopes for which refresh token needs to be obtained. Only valid when `client_id` is specified. Ignored otherwise. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
repeated string scopes = 6;getScopesBytes in interface DataSourceOrBuilderpublic int getTransferTypeValue()
Deprecated. This field has no effect.
.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7;getTransferTypeValue in interface DataSourceOrBuilderpublic TransferType getTransferType()
Deprecated. This field has no effect.
.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7;getTransferType in interface DataSourceOrBuilderpublic boolean getSupportsMultipleTransfers()
Indicates whether the data source supports multiple transfers to different BigQuery targets.
bool supports_multiple_transfers = 8;getSupportsMultipleTransfers in interface DataSourceOrBuilderpublic int getUpdateDeadlineSeconds()
The number of seconds to wait for an update from the data source before BigQuery marks the transfer as failed.
int32 update_deadline_seconds = 9;getUpdateDeadlineSeconds in interface DataSourceOrBuilderpublic java.lang.String getDefaultSchedule()
Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`.
string default_schedule = 10;getDefaultSchedule in interface DataSourceOrBuilderpublic ByteString getDefaultScheduleBytes()
Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`.
string default_schedule = 10;getDefaultScheduleBytes in interface DataSourceOrBuilderpublic boolean getSupportsCustomSchedule()
Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule.
bool supports_custom_schedule = 11;getSupportsCustomSchedule in interface DataSourceOrBuilderpublic java.util.List<DataSourceParameter> getParametersList()
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;getParametersList in interface DataSourceOrBuilderpublic java.util.List<? extends DataSourceParameterOrBuilder> getParametersOrBuilderList()
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;getParametersOrBuilderList in interface DataSourceOrBuilderpublic int getParametersCount()
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;getParametersCount in interface DataSourceOrBuilderpublic DataSourceParameter getParameters(int index)
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;getParameters in interface DataSourceOrBuilderpublic DataSourceParameterOrBuilder getParametersOrBuilder(int index)
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;getParametersOrBuilder in interface DataSourceOrBuilderpublic java.lang.String getHelpUrl()
Url for the help document for this data source.
string help_url = 13;getHelpUrl in interface DataSourceOrBuilderpublic ByteString getHelpUrlBytes()
Url for the help document for this data source.
string help_url = 13;getHelpUrlBytes in interface DataSourceOrBuilderpublic int getAuthorizationTypeValue()
Indicates the type of authorization.
.google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType authorization_type = 14;getAuthorizationTypeValue in interface DataSourceOrBuilderpublic DataSource.AuthorizationType getAuthorizationType()
Indicates the type of authorization.
.google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType authorization_type = 14;getAuthorizationType in interface DataSourceOrBuilderpublic int getDataRefreshTypeValue()
Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
.google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType data_refresh_type = 15;getDataRefreshTypeValue in interface DataSourceOrBuilderpublic DataSource.DataRefreshType getDataRefreshType()
Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
.google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType data_refresh_type = 15;getDataRefreshType in interface DataSourceOrBuilderpublic int getDefaultDataRefreshWindowDays()
Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
int32 default_data_refresh_window_days = 16;getDefaultDataRefreshWindowDays in interface DataSourceOrBuilderpublic boolean getManualRunsDisabled()
Disables backfilling and manual run scheduling for the data source.
bool manual_runs_disabled = 17;getManualRunsDisabled in interface DataSourceOrBuilderpublic boolean hasMinimumScheduleInterval()
The minimum interval for scheduler to schedule runs.
.google.protobuf.Duration minimum_schedule_interval = 18;hasMinimumScheduleInterval in interface DataSourceOrBuilderpublic Duration getMinimumScheduleInterval()
The minimum interval for scheduler to schedule runs.
.google.protobuf.Duration minimum_schedule_interval = 18;getMinimumScheduleInterval in interface DataSourceOrBuilderpublic DurationOrBuilder getMinimumScheduleIntervalOrBuilder()
The minimum interval for scheduler to schedule runs.
.google.protobuf.Duration minimum_schedule_interval = 18;getMinimumScheduleIntervalOrBuilder in interface DataSourceOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws java.io.IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static DataSource parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DataSource parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DataSource parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DataSource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DataSource parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DataSource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DataSource parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static DataSource parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static DataSource parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static DataSource parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static DataSource parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static DataSource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic DataSource.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static DataSource.Builder newBuilder()
public static DataSource.Builder newBuilder(DataSource prototype)
public DataSource.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected DataSource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static DataSource getDefaultInstance()
public static Parser<DataSource> parser()
public Parser<DataSource> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public DataSource getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilder