Recurso de REST: projects.locations.dataSources

Recurso: DataSource

Representa los metadatos de la fuente de datos. Los metadatos son suficientes para renderizar la IU y solicitar tokens de OAuth adecuados.

Representación 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

Solo salida. Es el nombre del recurso de la fuente de datos.

dataSourceId

string

Es el ID de la fuente de datos.

displayName

string

Es el nombre de la fuente de datos fácil de usar.

description

string

Es la string de descripción de fuente de datos fácil de usar.

clientId

string

Es el ID de cliente de la fuente de datos que se debe usar para recibir un token de actualización.

scopes[]

string

Son los permisos de autenticación de la API para los que se debe obtener un token de actualización. Estos son los permisos que necesita una fuente de datos para preparar datos y transferirlos a BigQuery, p. ej., https://www.googleapis.com/auth/bigquery

transferType
(deprecated)

enum(TransferType)

Obsoleto. Este campo no tiene efecto.
supportsMultipleTransfers
(deprecated)

boolean

Obsoleto. Este campo no tiene efecto.
updateDeadlineSeconds

number

Es la cantidad de segundos en que se espera una actualización de la fuente de datos antes de que el Servicio de transferencia de datos marque la transferencia como FALLIDA.

defaultSchedule

string

Es la programación predeterminada de transferencia de datos. Algunos ejemplos de programaciones válidas son los siguientes: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 y first sunday of quarter 00:00.

supportsCustomSchedule

boolean

Especifica si la fuente de datos admite una programación definida por el usuario o si opera con la programación predeterminada. Cuando se establece en true, el usuario puede anular la programación predeterminada.

parameters[]

object(DataSourceParameter)

Son los parámetros de la fuente de datos.

helpUrl

string

Es la URL del documento de ayuda de esta fuente de datos.

authorizationType

enum(AuthorizationType)

Indica el tipo de autorización.

dataRefreshType

enum(DataRefreshType)

Especifica si la fuente de datos admite la actualización automática de datos de los últimos días y cómo se admite. Para algunas fuentes de datos, puede que los datos no se completen hasta unos días después, por lo que resulta útil actualizar los datos de forma automática.

defaultDataRefreshWindowDays

number

Es el período de actualización de datos predeterminado en días. Solo tiene sentido cuando dataRefreshType = SLIDING_WINDOW.

manualRunsDisabled

boolean

Inhabilita el reabastecimiento y la programación de ejecución manual de la fuente de datos.

minimumScheduleInterval

string (Duration format)

Es el intervalo mínimo para que el programador programe las ejecuciones.

Es una duración en segundos con hasta nueve dígitos decimales, terminados en “s”. Ejemplo: "3.5s".
redirectUrl

string

Es la URL de redireccionamiento que completa la configuración de transferencia para fuentes de datos de terceros.

Métodos

checkValidCreds

 Muestra verdadero si existen credenciales válidas para la fuente de datos determinada y el usuario solicitante.

get

 Recupera una fuente de datos admitida y muestra su configuración, que se puede usar para la renderización de la IU.

list

 Enumera las fuentes de datos admitidas y muestra sus opciones de configuración, que se pueden usar para la renderización de la IU.