DataSource (BigQuery Data Transfer API v1 (Rev. 144) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.bigquerydatatransfer.v1.model.DataSource

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class DataSource
extends com.google.api.client.json.GenericJson
```
Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery Data Transfer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

DataSource()

Constructors
Constructor and Description
`DataSource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataSource`	`clone()`
`java.lang.String`	`getAuthorizationType()` Indicates the type of authorization.
`java.lang.String`	`getClientId()` Data source client id which should be used to receive refresh token.
`java.lang.String`	`getDataRefreshType()` 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.
`java.lang.Integer`	`getDefaultDataRefreshWindowDays()` Default data refresh window on days.
`java.lang.String`	`getDefaultSchedule()` Default data transfer schedule.
`java.lang.String`	`getDescription()` User friendly data source description string.
`java.lang.String`	`getDisplayName()` User friendly data source name.
`java.lang.String`	`getHelpUrl()` Url for the help document for this data source.
`java.lang.Boolean`	`getManualRunsDisabled()` Disables backfilling and manual run scheduling for the data source.
`java.lang.String`	`getMinimumScheduleInterval()` The minimum interval for scheduler to schedule runs.
`java.lang.String`	`getName()` Output only.
`java.util.List<DataSourceParameter>`	`getParameters()` Data source parameters.
`java.util.List<java.lang.String>`	`getScopes()` Api auth scopes for which refresh token needs to be obtained.
`java.lang.Boolean`	`getSupportsCustomSchedule()` Specifies whether the data source supports a user defined schedule, or operates on the default schedule.
`java.lang.Boolean`	`getSupportsMultipleTransfers()` Deprecated.
`java.lang.String`	`getTransferType()` Deprecated.
`java.lang.Integer`	`getUpdateDeadlineSeconds()` The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
`DataSource`	`set(java.lang.String fieldName, java.lang.Object value)`
`DataSource`	`setAuthorizationType(java.lang.String authorizationType)` Indicates the type of authorization.
`DataSource`	`setClientId(java.lang.String clientId)` Data source client id which should be used to receive refresh token.
`DataSource`	`setDataRefreshType(java.lang.String dataRefreshType)` Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported.
`DataSource`	`setDataSourceId(java.lang.String dataSourceId)` Data source id.
`DataSource`	`setDefaultDataRefreshWindowDays(java.lang.Integer defaultDataRefreshWindowDays)` Default data refresh window on days.
`DataSource`	`setDefaultSchedule(java.lang.String defaultSchedule)` Default data transfer schedule.
`DataSource`	`setDescription(java.lang.String description)` User friendly data source description string.
`DataSource`	`setDisplayName(java.lang.String displayName)` User friendly data source name.
`DataSource`	`setHelpUrl(java.lang.String helpUrl)` Url for the help document for this data source.
`DataSource`	`setManualRunsDisabled(java.lang.Boolean manualRunsDisabled)` Disables backfilling and manual run scheduling for the data source.
`DataSource`	`setMinimumScheduleInterval(java.lang.String minimumScheduleInterval)` The minimum interval for scheduler to schedule runs.
`DataSource`	`setName(java.lang.String name)` Output only.
`DataSource`	`setParameters(java.util.List<DataSourceParameter> parameters)` Data source parameters.
`DataSource`	`setScopes(java.util.List<java.lang.String> scopes)` Api auth scopes for which refresh token needs to be obtained.
`DataSource`	`setSupportsCustomSchedule(java.lang.Boolean supportsCustomSchedule)` Specifies whether the data source supports a user defined schedule, or operates on the default schedule.
`DataSource`	`setSupportsMultipleTransfers(java.lang.Boolean supportsMultipleTransfers)` Deprecated.
`DataSource`	`setTransferType(java.lang.String transferType)` Deprecated.
`DataSource`	`setUpdateDeadlineSeconds(java.lang.Integer updateDeadlineSeconds)` The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - DataSource
```
public DataSource()
```
- Method Detail
  - getAuthorizationType
```
public java.lang.String getAuthorizationType()
```
    Indicates the type of authorization.
    
    Returns:
    
    value or null for none
  - setAuthorizationType
```
public DataSource setAuthorizationType(java.lang.String authorizationType)
```
    Indicates the type of authorization.
    
    Parameters:
    
    authorizationType - authorizationType or null for none
  - getClientId
```
public java.lang.String getClientId()
```
    Data source client id which should be used to receive refresh token.
    
    Returns:
    
    value or null for none
  - setClientId
```
public DataSource setClientId(java.lang.String clientId)
```
    Data source client id which should be used to receive refresh token.
    
    Parameters:
    
    clientId - clientId or null for none
  - getDataRefreshType
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
  - setDataRefreshType
```
public DataSource setDataRefreshType(java.lang.String dataRefreshType)
```
    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.
    
    Parameters:
    
    dataRefreshType - dataRefreshType or null for none
  - getDataSourceId
```
public java.lang.String getDataSourceId()
```
    Data source id.
    
    Returns:
    
    value or null for none
  - setDataSourceId
```
public DataSource setDataSourceId(java.lang.String dataSourceId)
```
    Data source id.
    
    Parameters:
    
    dataSourceId - dataSourceId or null for none
  - getDefaultDataRefreshWindowDays
```
public java.lang.Integer getDefaultDataRefreshWindowDays()
```
    Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
    
    Returns:
    
    value or null for none
  - setDefaultDataRefreshWindowDays
```
public DataSource setDefaultDataRefreshWindowDays(java.lang.Integer defaultDataRefreshWindowDays)
```
    Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
    
    Parameters:
    
    defaultDataRefreshWindowDays - defaultDataRefreshWindowDays or null for none
  - getDefaultSchedule
```
public 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`.
    
    Returns:
    
    value or null for none
  - setDefaultSchedule
```
public DataSource setDefaultSchedule(java.lang.String defaultSchedule)
```
    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`.
    
    Parameters:
    
    defaultSchedule - defaultSchedule or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    User friendly data source description string.
    
    Returns:
    
    value or null for none
  - setDescription
```
public DataSource setDescription(java.lang.String description)
```
    User friendly data source description string.
    
    Parameters:
    
    description - description or null for none
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    User friendly data source name.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public DataSource setDisplayName(java.lang.String displayName)
```
    User friendly data source name.
    
    Parameters:
    
    displayName - displayName or null for none
  - getHelpUrl
```
public java.lang.String getHelpUrl()
```
    Url for the help document for this data source.
    
    Returns:
    
    value or null for none
  - setHelpUrl
```
public DataSource setHelpUrl(java.lang.String helpUrl)
```
    Url for the help document for this data source.
    
    Parameters:
    
    helpUrl - helpUrl or null for none
  - getManualRunsDisabled
```
public java.lang.Boolean getManualRunsDisabled()
```
    Disables backfilling and manual run scheduling for the data source.
    
    Returns:
    
    value or null for none
  - setManualRunsDisabled
```
public DataSource setManualRunsDisabled(java.lang.Boolean manualRunsDisabled)
```
    Disables backfilling and manual run scheduling for the data source.
    
    Parameters:
    
    manualRunsDisabled - manualRunsDisabled or null for none
  - getMinimumScheduleInterval
```
public java.lang.String getMinimumScheduleInterval()
```
    The minimum interval for scheduler to schedule runs.
    
    Returns:
    
    value or null for none
  - setMinimumScheduleInterval
```
public DataSource setMinimumScheduleInterval(java.lang.String minimumScheduleInterval)
```
    The minimum interval for scheduler to schedule runs.
    
    Parameters:
    
    minimumScheduleInterval - minimumScheduleInterval or null for none
  - getName
```
public java.lang.String getName()
```
    Output only. Data source resource name.
    
    Returns:
    
    value or null for none
  - setName
```
public DataSource setName(java.lang.String name)
```
    Output only. Data source resource name.
    
    Parameters:
    
    name - name or null for none
  - getParameters
```
public java.util.List<DataSourceParameter> getParameters()
```
    Data source parameters.
    
    Returns:
    
    value or null for none
  - setParameters
```
public DataSource setParameters(java.util.List<DataSourceParameter> parameters)
```
    Data source parameters.
    
    Parameters:
    
    parameters - parameters or null for none
  - getScopes
```
public java.util.List<java.lang.String> getScopes()
```
    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
    
    Returns:
    
    value or null for none
  - setScopes
```
public DataSource setScopes(java.util.List<java.lang.String> scopes)
```
    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
    
    Parameters:
    
    scopes - scopes or null for none
  - getSupportsCustomSchedule
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setSupportsCustomSchedule
```
public DataSource setSupportsCustomSchedule(java.lang.Boolean supportsCustomSchedule)
```
    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.
    
    Parameters:
    
    supportsCustomSchedule - supportsCustomSchedule or null for none
  - getSupportsMultipleTransfers
```
public java.lang.Boolean getSupportsMultipleTransfers()
```
    Deprecated. This field has no effect.
    
    Returns:
    
    value or null for none
  - setSupportsMultipleTransfers
```
public DataSource setSupportsMultipleTransfers(java.lang.Boolean supportsMultipleTransfers)
```
    Deprecated. This field has no effect.
    
    Parameters:
    
    supportsMultipleTransfers - supportsMultipleTransfers or null for none
  - getTransferType
```
public java.lang.String getTransferType()
```
    Deprecated. This field has no effect.
    
    Returns:
    
    value or null for none
  - setTransferType
```
public DataSource setTransferType(java.lang.String transferType)
```
    Deprecated. This field has no effect.
    
    Parameters:
    
    transferType - transferType or null for none
  - getUpdateDeadlineSeconds
```
public java.lang.Integer getUpdateDeadlineSeconds()
```
    The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
    
    Returns:
    
    value or null for none
  - setUpdateDeadlineSeconds
```
public DataSource setUpdateDeadlineSeconds(java.lang.Integer updateDeadlineSeconds)
```
    The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
    
    Parameters:
    
    updateDeadlineSeconds - updateDeadlineSeconds or null for none
  - set
```
public DataSource set(java.lang.String fieldName,
                      java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public DataSource clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

BigQuery Data Transfer API v1 (revision 144)

Class DataSource

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

DataSource

Method Detail

getAuthorizationType

setAuthorizationType

getClientId

setClientId

getDataRefreshType

setDataRefreshType

getDataSourceId

setDataSourceId

getDefaultDataRefreshWindowDays

setDefaultDataRefreshWindowDays

getDefaultSchedule

setDefaultSchedule

getDescription

setDescription

getDisplayName

setDisplayName

getHelpUrl

setHelpUrl

getManualRunsDisabled

setManualRunsDisabled

getMinimumScheduleInterval

setMinimumScheduleInterval

getName

setName

getParameters

setParameters

getScopes

setScopes

getSupportsCustomSchedule

setSupportsCustomSchedule

getSupportsMultipleTransfers

setSupportsMultipleTransfers

getTransferType

setTransferType

getUpdateDeadlineSeconds

setUpdateDeadlineSeconds

set

clone