public final class DataSource extends com.google.protobuf.GeneratedMessageV3 implements DataSourceOrBuilder
Defines the properties and custom parameters for a data source.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
Defines the properties and custom parameters for a data source.
|
static class |
DataSource.DataRefreshType
Represents how the data source supports data auto refresh.
|
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 |
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 |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
DataSource.AuthorizationType |
getAuthorizationType()
Indicates the type of authorization.
|
int |
getAuthorizationTypeValue()
Indicates the type of authorization.
|
String |
getClientId()
Data source client id which should be used to receive refresh token.
|
com.google.protobuf.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.
|
String |
getDataSourceId()
Data source id.
|
com.google.protobuf.ByteString |
getDataSourceIdBytes()
Data source id.
|
int |
getDefaultDataRefreshWindowDays()
Default data refresh window on days.
|
static DataSource |
getDefaultInstance() |
DataSource |
getDefaultInstanceForType() |
String |
getDefaultSchedule()
Default data transfer schedule.
|
com.google.protobuf.ByteString |
getDefaultScheduleBytes()
Default data transfer schedule.
|
String |
getDescription()
User friendly data source description string.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
User friendly data source description string.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
User friendly data source name.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
User friendly data source name.
|
String |
getHelpUrl()
Url for the help document for this data source.
|
com.google.protobuf.ByteString |
getHelpUrlBytes()
Url for the help document for this data source.
|
boolean |
getManualRunsDisabled()
Disables backfilling and manual run scheduling
for the data source.
|
com.google.protobuf.Duration |
getMinimumScheduleInterval()
The minimum interval for scheduler to schedule runs.
|
com.google.protobuf.DurationOrBuilder |
getMinimumScheduleIntervalOrBuilder()
The minimum interval for scheduler to schedule runs.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
DataSourceParameter |
getParameters(int index)
Data source parameters.
|
int |
getParametersCount()
Data source parameters.
|
List<DataSourceParameter> |
getParametersList()
Data source parameters.
|
DataSourceParameterOrBuilder |
getParametersOrBuilder(int index)
Data source parameters.
|
List<? extends DataSourceParameterOrBuilder> |
getParametersOrBuilderList()
Data source parameters.
|
com.google.protobuf.Parser<DataSource> |
getParserForType() |
String |
getScopes(int index)
Api auth scopes for which refresh token needs to be obtained.
|
com.google.protobuf.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.
|
com.google.protobuf.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()
Deprecated.
google.cloud.bigquery.datatransfer.v1.DataSource.supports_multiple_transfers is
deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=383
|
TransferType |
getTransferType()
Deprecated.
google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See
google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=380
|
int |
getTransferTypeValue()
Deprecated.
google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See
google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=380
|
int |
getUpdateDeadlineSeconds()
The number of seconds to wait for an update from the data source
before the Data Transfer Service marks the transfer as FAILED.
|
int |
hashCode() |
boolean |
hasMinimumScheduleInterval()
The minimum interval for scheduler to schedule runs.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static DataSource.Builder |
newBuilder() |
static DataSource.Builder |
newBuilder(DataSource prototype) |
DataSource.Builder |
newBuilderForType() |
protected DataSource.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static DataSource |
parseDelimitedFrom(InputStream input) |
static DataSource |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(byte[] data) |
static DataSource |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(ByteBuffer data) |
static DataSource |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(com.google.protobuf.ByteString data) |
static DataSource |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(com.google.protobuf.CodedInputStream input) |
static DataSource |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DataSource |
parseFrom(InputStream input) |
static DataSource |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<DataSource> |
parser() |
DataSource.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, 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_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
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance 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()
Output only. Data source resource name.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getName in interface DataSourceOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. Data source resource name.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getNameBytes in interface DataSourceOrBuilderpublic String getDataSourceId()
Data source id.
string data_source_id = 2;getDataSourceId in interface DataSourceOrBuilderpublic com.google.protobuf.ByteString getDataSourceIdBytes()
Data source id.
string data_source_id = 2;getDataSourceIdBytes in interface DataSourceOrBuilderpublic String getDisplayName()
User friendly data source name.
string display_name = 3;getDisplayName in interface DataSourceOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
User friendly data source name.
string display_name = 3;getDisplayNameBytes in interface DataSourceOrBuilderpublic String getDescription()
User friendly data source description string.
string description = 4;getDescription in interface DataSourceOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
User friendly data source description string.
string description = 4;getDescriptionBytes in interface DataSourceOrBuilderpublic String getClientId()
Data source client id which should be used to receive refresh token.
string client_id = 5;getClientId in interface DataSourceOrBuilderpublic com.google.protobuf.ByteString getClientIdBytes()
Data source client id which should be used to receive refresh token.
string client_id = 5;getClientIdBytes in interface DataSourceOrBuilderpublic com.google.protobuf.ProtocolStringList getScopesList()
Api auth scopes for which refresh token needs to be obtained. 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. 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 String getScopes(int index)
Api auth scopes for which refresh token needs to be obtained. 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 DataSourceOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getScopesBytes(int index)
Api auth scopes for which refresh token needs to be obtained. 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 DataSourceOrBuilderindex - The index of the value to return.@Deprecated public int getTransferTypeValue()
Deprecated. This field has no effect.
.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];
getTransferTypeValue in interface DataSourceOrBuilder@Deprecated public TransferType getTransferType()
Deprecated. This field has no effect.
.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];
getTransferType in interface DataSourceOrBuilder@Deprecated public boolean getSupportsMultipleTransfers()
Deprecated. This field has no effect.
bool supports_multiple_transfers = 8 [deprecated = true];getSupportsMultipleTransfers in interface DataSourceOrBuilderpublic int getUpdateDeadlineSeconds()
The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
int32 update_deadline_seconds = 9;getUpdateDeadlineSeconds in interface DataSourceOrBuilderpublic 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 com.google.protobuf.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 List<DataSourceParameter> getParametersList()
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;
getParametersList in interface DataSourceOrBuilderpublic 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 String getHelpUrl()
Url for the help document for this data source.
string help_url = 13;getHelpUrl in interface DataSourceOrBuilderpublic com.google.protobuf.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 com.google.protobuf.Duration getMinimumScheduleInterval()
The minimum interval for scheduler to schedule runs.
.google.protobuf.Duration minimum_schedule_interval = 18;getMinimumScheduleInterval in interface DataSourceOrBuilderpublic com.google.protobuf.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 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 DataSource parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSource parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSource parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSource parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSource parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSource parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DataSource parseFrom(InputStream input) throws IOException
IOExceptionpublic static DataSource parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static DataSource parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static DataSource parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static DataSource parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static DataSource parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic DataSource.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static DataSource.Builder newBuilder()
public static DataSource.Builder newBuilder(DataSource prototype)
public DataSource.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected DataSource.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static DataSource getDefaultInstance()
public static com.google.protobuf.Parser<DataSource> parser()
public com.google.protobuf.Parser<DataSource> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public DataSource getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.