Recurso de REST: projects.dataSources

Recurso: DataSource
Métodos

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

Representación JSON
{ "name": string, "dataSourceId": string, "displayName": string, "description": string, "clientId": string, "scopes": [ string ], "transferType": enum (`TransferType`), "supportsMultipleTransfers": boolean, "updateDeadlineSeconds": integer, "defaultSchedule": string, "supportsCustomSchedule": boolean, "parameters": [ { object (`DataSourceParameter`) } ], "helpUrl": string, "authorizationType": enum (`AuthorizationType`), "dataRefreshType": enum (`DataRefreshType`), "defaultDataRefreshWindowDays": integer, "manualRunsDisabled": boolean, "minimumScheduleInterval": string }


{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "description": string,
  "clientId": string,
  "scopes": [
    string
  ],
  "transferType": enum (TransferType),
  "supportsMultipleTransfers": boolean,
  "updateDeadlineSeconds": integer,
  "defaultSchedule": string,
  "supportsCustomSchedule": boolean,
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],
  "helpUrl": string,
  "authorizationType": enum (AuthorizationType),
  "dataRefreshType": enum (DataRefreshType),
  "defaultDataRefreshWindowDays": integer,
  "manualRunsDisabled": boolean,
  "minimumScheduleInterval": 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)` Este elemento está obsoleto. Obsoleto. Este campo no tiene efecto.
`supportsMultipleTransfers (deprecated)`	`boolean` Este elemento está obsoleto. Obsoleto. Este campo no tiene efecto.
`updateDeadlineSeconds`	`integer` 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`	`integer` 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"`.

TransferType

OBSOLETO. Representa el tipo de transferencia de datos.

Enums
`TRANSFER_TYPE_UNSPECIFIED`	Es un marcador de posición de tipo de transferencia no válida o desconocida.
`BATCH`	Indica una transferencia de datos por lotes.
`STREAMING`	Indica una transferencia de datos de transmisión. En la actualidad, la fuente de datos de transmisión no admite varias opciones de configuración de transferencia por proyecto.

DataSourceParameter

Representa un parámetro de fuente de datos con reglas de validación, de modo que los parámetros se puedan renderizar en la IU. Estos parámetros proporcionan fuentes de datos admitidas y, además, incluyen toda la información necesaria para el procesamiento y la validación. Por lo tanto, cualquiera que use esta API puede decidir generar formularios genéricos de IU o formularios de fuentes de datos personalizadas específicos.

Representación JSON

Representación JSON
{ "paramId": string, "displayName": string, "description": string, "type": enum (`Type`), "required": boolean, "repeated": boolean, "validationRegex": string, "allowedValues": [ string ], "minValue": number, "maxValue": number, "fields": [ { object (`DataSourceParameter`) } ], "validationDescription": string, "validationHelpUrl": string, "immutable": boolean, "recurse": boolean, "deprecated": boolean }


{
  "paramId": string,
  "displayName": string,
  "description": string,
  "type": enum (Type),
  "required": boolean,
  "repeated": boolean,
  "validationRegex": string,
  "allowedValues": [
    string
  ],
  "minValue": number,
  "maxValue": number,
  "fields": [
    {
      object (DataSourceParameter)
    }
  ],
  "validationDescription": string,
  "validationHelpUrl": string,
  "immutable": boolean,
  "recurse": boolean,
  "deprecated": boolean
}

Campos
`paramId`	`string` Es el identificador de parámetro.
`displayName`	`string` Es el nombre visible del parámetro en la interfaz de usuario.
`description`	`string` Es la descripción del parámetro.
`type`	`enum (Type)` Es el tipo de parámetro.
`required`	`boolean` El parámetro es obligatorio.
`repeated`	`boolean` Obsoleto. Este campo no tiene efecto.
`validationRegex`	`string` Es una expresión regular que se puede usar a fin de validar parámetros.
`allowedValues[]`	`string` Son todos los valores posibles del parámetro.
`minValue`	`number` Especifica el valor mínimo permitido de los valores de números enteros y dobles.
`maxValue`	`number` Especifica el valor máximo permitido de los valores de números enteros y dobles.
`fields[]`	`object (DataSourceParameter)` Obsoleto. Este campo no tiene efecto.
`validationDescription`	`string` Es una descripción de los requisitos para este campo, en caso de que la entrada del usuario no cumpla con los patrones regex, o con los valores mínimos o máximos.
`validationHelpUrl`	`string` Es una URL a un documento de ayuda a fin de explicar con más detalle los requisitos para la asignación de nombres.
`immutable`	`boolean` No se puede cambiar después de la creación inicial.
`recurse`	`boolean` Obsoleto. Este campo no tiene efecto.
`deprecated`	`boolean` Si es verdadero, no debe usarse en transferencias nuevas y no debe ser visible para los usuarios.

Tipo

Es el tipo de parámetro.

Enums
`TYPE_UNSPECIFIED`	Indica un tipo no especificado.
`STRING`	Indica el parámetro de la string.
`INTEGER`	Indica un parámetro de número entero (64 bits). Se serializará en JSON como una string.
`DOUBLE`	Indica un parámetro de punto flotante de doble precisión.
`BOOLEAN`	Indica un parámetro booleano.
`RECORD`	Obsoleto. Este campo no tiene efecto.
`PLUS_PAGE`	Es el ID de una página de Google+.

AuthorizationType

Es el tipo de autorización necesaria para esta fuente de datos.

Enums
`AUTHORIZATION_TYPE_UNSPECIFIED`	Indica un tipo no especificado.
`AUTHORIZATION_CODE`	Usa códigos de autorización de OAuth 2 que se puedan intercambiar por un token de actualización en el backend.
`GOOGLE_PLUS_AUTHORIZATION_CODE`	Muestra un código de autorización para una página de Google+ determinada, que se puede intercambiar por un token de actualización en el backend.
`FIRST_PARTY_OAUTH`	Usa OAuth de origen en función de las LOA de los clientes. OAuth de origen no requiere un token de actualización para obtener un token de acceso sin conexión. En su lugar, usa una aserción de JWT firmada por el cliente para recuperar un token de acceso.

DataRefreshType

Representa la forma en que la fuente de datos admite la actualización automática de datos.

Enums
`DATA_REFRESH_TYPE_UNSPECIFIED`	La fuente de datos no admitirá la actualización automática de datos, que es el valor predeterminado.
`SLIDING_WINDOW`	La fuente de datos admite la actualización automática de datos, y las ejecuciones se programarán para los últimos días. No permite establecer valores personalizados para cada configuración de transferencia.
`CUSTOM_SLIDING_WINDOW`	La fuente de datos admite la actualización automática de datos, y las ejecuciones se programarán para los últimos días. Permite establecer valores personalizados para cada configuración de transferencia.

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.

Recurso de REST: projects.dataSources

Recurso: DataSource

TransferType

DataSourceParameter

Tipo

AuthorizationType

DataRefreshType

Métodos

`checkValidCreds`

`get`

`list`