Recurso REST: projects.locations.dataSources

Recurso: DataSource

Representa os metadados da fonte de dados. Os metadados são suficientes para renderizar a interface do usuário e solicitar tokens OAuth adequados.

Representação JSON 

{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "description": string,
  "clientId": string,
  "scopes": [
    string
  ],
  "transferType": enum(TransferType),
  "supportsMultipleTransfers": boolean,
  "updateDeadlineSeconds": number,
  "defaultSchedule": string,
  "supportsCustomSchedule": boolean,
  "parameters": [
    {
      object(DataSourceParameter)
    }
  ],
  "helpUrl": string,
  "authorizationType": enum(AuthorizationType),
  "dataRefreshType": enum(DataRefreshType),
  "defaultDataRefreshWindowDays": number,
  "manualRunsDisabled": boolean,
  "minimumScheduleInterval": string,
  "partnerLegalName": string,
  "redirectUrl": string
}
Campos
name

string

Apenas saída. Nome do recurso de fonte de dados.

dataSourceId

string

Código da fonte de dados.
displayName

string

Nome da fonte de dados amigável.
description

string

String de descrição da fonte de dados amigável.
clientId

string

ID do cliente da fonte de dados que precisa ser usado para recebimento do token de atualização.
scopes[]

string

Escopos de autenticação da API que precisam ser usados para recebimento do token de atualização. Esses são os escopos necessários para que uma fonte de dados prepare os dados e faça a ingestão deles no BigQuery. Por exemplo, https://www.googleapis.com/auth/bigquery

transferType
(deprecated)

enum(TransferType)

Obsoleto. Esse campo não tem efeito.
supportsMultipleTransfers
(deprecated)

boolean

Obsoleto. Esse campo não tem efeito.
updateDeadlineSeconds

number

O número de segundos a aguardar por uma atualização da fonte de dados antes que o serviço de transferência de dados marque a transferência como FAILED.
defaultSchedule

string

Horário padrão da transferência de dados. Exemplos de programações válidas incluem: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 e first sunday of quarter 00:00.

supportsCustomSchedule

boolean

Especifica se a fonte de dados é compatível com uma programação definida pelo usuário ou se opera na programação padrão. Quando definido como true, o usuário pode substituir a programação padrão.

parameters[]

object(DataSourceParameter)

Parâmetros da fonte de dados.

helpUrl

string

URL para o documento de ajuda para essa fonte de dados.
authorizationType

enum(AuthorizationType)

Indica o tipo de autorização.
dataRefreshType

enum(DataRefreshType)

Especifica se (e como) a fonte de dados é compatível com atualização automática de dados nos últimos dias. Em algumas fontes, os dados só ficam completos alguns dias depois. Por isso, é útil atualizá-los automaticamente.

defaultDataRefreshWindowDays

number

Janela de atualização de dados padrão em dias. Significativa apenas quando dataRefreshType = SLIDING_WINDOW.

manualRunsDisabled

boolean

Desativa o preenchimento e a programação de execução manual da fonte de dados.

minimumScheduleInterval

string (Duration format)

O intervalo mínimo para o programador agendar as execuções.

Uma duração em segundos com até nove dígitos fracionários, que termina com "s". Exemplo: "3.5s".
redirectUrl

string

URL de redirecionamento para concluir a configuração do config de transferência para fontes de dados de terceiros.

Métodos

checkValidCreds

 Retorna verdadeiro se existirem credenciais válidas para a fonte de dados e o usuário solicitante.

get

 Recupera uma fonte de dados compatível e retorna suas configurações, que podem ser usadas para renderização da interface do usuário.

list

 Lista as fontes de dados compatíveis e retorna as configurações delas, que podem ser usadas para renderização da IU.