public final class DataSource extends GeneratedMessageV3 implements DataSourceOrBuilder
Defines the properties and custom parameters for a data source.
Protobuf type google.cloud.bigquery.datatransfer.v1.DataSource
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
AUTHORIZATION_TYPE_FIELD_NUMBER
public static final int AUTHORIZATION_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CLIENT_ID_FIELD_NUMBER
public static final int CLIENT_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DATA_REFRESH_TYPE_FIELD_NUMBER
public static final int DATA_REFRESH_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DATA_SOURCE_ID_FIELD_NUMBER
public static final int DATA_SOURCE_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEFAULT_DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
public static final int DEFAULT_DATA_REFRESH_WINDOW_DAYS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEFAULT_SCHEDULE_FIELD_NUMBER
public static final int DEFAULT_SCHEDULE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
HELP_URL_FIELD_NUMBER
public static final int HELP_URL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MANUAL_RUNS_DISABLED_FIELD_NUMBER
public static final int MANUAL_RUNS_DISABLED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MINIMUM_SCHEDULE_INTERVAL_FIELD_NUMBER
public static final int MINIMUM_SCHEDULE_INTERVAL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SCOPES_FIELD_NUMBER
public static final int SCOPES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SUPPORTS_CUSTOM_SCHEDULE_FIELD_NUMBER
public static final int SUPPORTS_CUSTOM_SCHEDULE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SUPPORTS_MULTIPLE_TRANSFERS_FIELD_NUMBER
public static final int SUPPORTS_MULTIPLE_TRANSFERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TRANSFER_TYPE_FIELD_NUMBER
public static final int TRANSFER_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_DEADLINE_SECONDS_FIELD_NUMBER
public static final int UPDATE_DEADLINE_SECONDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static DataSource getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DataSource.Builder newBuilder()
newBuilder(DataSource prototype)
public static DataSource.Builder newBuilder(DataSource prototype)
public static DataSource parseDelimitedFrom(InputStream input)
public static DataSource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DataSource parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataSource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DataSource parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataSource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataSource parseFrom(CodedInputStream input)
public static DataSource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataSource parseFrom(InputStream input)
public static DataSource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DataSource parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataSource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DataSource> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAuthorizationType()
public DataSource.AuthorizationType getAuthorizationType()
Indicates the type of authorization.
.google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType authorization_type = 14;
getAuthorizationTypeValue()
public int getAuthorizationTypeValue()
Indicates the type of authorization.
.google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType authorization_type = 14;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for authorizationType.
|
getClientId()
public String getClientId()
Data source client id which should be used to receive refresh token.
string client_id = 5;
| Returns |
|---|
| Type | Description |
String | The clientId.
|
getClientIdBytes()
public ByteString getClientIdBytes()
Data source client id which should be used to receive refresh token.
string client_id = 5;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for clientId.
|
getDataRefreshType()
public 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;
getDataRefreshTypeValue()
public 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;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for dataRefreshType.
|
getDataSourceId()
public String getDataSourceId()
Data source id.
string data_source_id = 2;
| Returns |
|---|
| Type | Description |
String | The dataSourceId.
|
getDataSourceIdBytes()
public ByteString getDataSourceIdBytes()
Data source id.
string data_source_id = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for dataSourceId.
|
getDefaultDataRefreshWindowDays()
public int getDefaultDataRefreshWindowDays()
Default data refresh window on days.
Only meaningful when data_refresh_type = SLIDING_WINDOW.
int32 default_data_refresh_window_days = 16;
| Returns |
|---|
| Type | Description |
int | The defaultDataRefreshWindowDays.
|
getDefaultInstanceForType()
public DataSource getDefaultInstanceForType()
getDefaultSchedule()
public 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;
| Returns |
|---|
| Type | Description |
String | The defaultSchedule.
|
getDefaultScheduleBytes()
public 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for defaultSchedule.
|
getDescription()
public String getDescription()
User friendly data source description string.
string description = 4;
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
User friendly data source description string.
string description = 4;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getDisplayName()
public String getDisplayName()
User friendly data source name.
string display_name = 3;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
User friendly data source name.
string display_name = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getHelpUrl()
public String getHelpUrl()
Url for the help document for this data source.
string help_url = 13;
| Returns |
|---|
| Type | Description |
String | The helpUrl.
|
getHelpUrlBytes()
public ByteString getHelpUrlBytes()
Url for the help document for this data source.
string help_url = 13;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for helpUrl.
|
getManualRunsDisabled()
public boolean getManualRunsDisabled()
Disables backfilling and manual run scheduling
for the data source.
bool manual_runs_disabled = 17;
| Returns |
|---|
| Type | Description |
boolean | The manualRunsDisabled.
|
getMinimumScheduleInterval()
public Duration getMinimumScheduleInterval()
The minimum interval for scheduler to schedule runs.
.google.protobuf.Duration minimum_schedule_interval = 18;
| Returns |
|---|
| Type | Description |
Duration | The minimumScheduleInterval.
|
getMinimumScheduleIntervalOrBuilder()
public DurationOrBuilder getMinimumScheduleIntervalOrBuilder()
The minimum interval for scheduler to schedule runs.
.google.protobuf.Duration minimum_schedule_interval = 18;
getName()
Output only. Data source resource name.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. Data source resource name.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParameters(int index)
public DataSourceParameter getParameters(int index)
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;
| Parameter |
|---|
| Name | Description |
index | int
|
getParametersCount()
public int getParametersCount()
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;
| Returns |
|---|
| Type | Description |
int | |
getParametersList()
public List<DataSourceParameter> getParametersList()
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;
getParametersOrBuilder(int index)
public DataSourceParameterOrBuilder getParametersOrBuilder(int index)
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;
| Parameter |
|---|
| Name | Description |
index | int
|
getParametersOrBuilderList()
public List<? extends DataSourceParameterOrBuilder> getParametersOrBuilderList()
Data source parameters.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter parameters = 12;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.bigquery.datatransfer.v1.DataSourceParameterOrBuilder> | |
getParserForType()
public Parser<DataSource> getParserForType()
Overrides
getScopes(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The scopes at the given index.
|
getScopesBytes(int index)
public 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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the scopes at the given index.
|
getScopesCount()
public 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;
| Returns |
|---|
| Type | Description |
int | The count of scopes.
|
getScopesList()
public 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;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSupportsCustomSchedule()
public 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;
| Returns |
|---|
| Type | Description |
boolean | The supportsCustomSchedule.
|
getSupportsMultipleTransfers() (deprecated)
public boolean getSupportsMultipleTransfers()
Deprecated. google.cloud.bigquery.datatransfer.v1.DataSource.supports_multiple_transfers is
deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=386
Deprecated. This field has no effect.
bool supports_multiple_transfers = 8 [deprecated = true];
| Returns |
|---|
| Type | Description |
boolean | The supportsMultipleTransfers.
|
getTransferType() (deprecated)
public TransferType getTransferType()
Deprecated. google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See
google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=383
Deprecated. This field has no effect.
.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];
getTransferTypeValue() (deprecated)
public int getTransferTypeValue()
Deprecated. google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type is deprecated. See
google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=383
Deprecated. This field has no effect.
.google.cloud.bigquery.datatransfer.v1.TransferType transfer_type = 7 [deprecated = true];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for transferType.
|
getUpdateDeadlineSeconds()
public 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;
| Returns |
|---|
| Type | Description |
int | The updateDeadlineSeconds.
|
hasMinimumScheduleInterval()
public boolean hasMinimumScheduleInterval()
The minimum interval for scheduler to schedule runs.
.google.protobuf.Duration minimum_schedule_interval = 18;
| Returns |
|---|
| Type | Description |
boolean | Whether the minimumScheduleInterval field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DataSource.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataSource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public DataSource.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
