Recurso de REST: projects.locations.dataSourceDefinitions

Recurso: DataSourceDefinition

Representa la definición de la fuente de datos.

Representación JSON 

{
  "name": string,
  "dataSource": {
    object(DataSource)
  },
  "transferRunPubsubTopic": string,
  "runTimeOffset": string,
  "supportEmail": string,
  "serviceAccount": string,
  "disabled": boolean,
  "transferConfigPubsubTopic": string,
  "supportedLocationIds": [
    string
  ]
}
Campos
name

string

Es el nombre de recurso de la definición de fuente de datos. Los nombres de definiciones de fuentes de datos tienen el formato projects/{projectId}/locations/{location}/dataSourceDefinitions/{dataSourceId}.

dataSource

object(DataSource)

Son los metadatos de la fuente de datos.

transferRunPubsubTopic

string

Es el tema de Pub/Sub que se usa para transmitir un mensaje cuando se crea una ejecución de transferencia. Tanto este tema como transferConfigPubsubTopic se pueden establecer como un tema personalizado. De forma predeterminada, ambos temas se generan de manera automática si ninguno se proporciona cuando se crea la definición. Sin embargo, si un tema se establece de forma manual, el otro también debe establecerse de esa manera. La única diferencia es que transferRunPubsubTopic debe ser un tema de Pub/Sub que no esté vacío, pero transferConfigPubsubTopic puede establecerse como vacío. Los comentarios sobre “{location}” para transferConfigPubsubTopic también se aplican aquí.

runTimeOffset

string (Duration format)

Es la duración que se debe agregar a scheduleTime para calcular el tiempo de ejecución cuando el trabajo está programado. Solo se aplica a ejecuciones de transferencias programadas de forma automática. Se usa con el fin de iniciar una ejecución anticipada en una fuente de datos que admite la actualización continua de los datos para compensar los desplazamientos de zonas horarias desconocidas. Usa un número negativo a fin de iniciar la ejecución tardía para las fuentes de datos que no admiten una actualización continua de los datos.

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

string

Indica la compatibilidad con la dirección de correo electrónico de la marca del cliente de OAuth, que contiene los datos de la pantalla de consentimiento.

serviceAccount

string

Cuando se especifique la cuenta de servicio, BigQuery compartirá el conjunto de datos creado con la cuenta de servicio dada. Asimismo, esta cuenta de servicio podrá realizar actualizaciones de estado y registros de mensajes para las ejecuciones de transferencia de datos del dataSourceId correspondiente.

disabled

boolean

¿La fuente de datos está inhabilitada? Si es verdadero, dataSource no será visible. Además, la API dejará de mostrar la configuración de las transferencias de datos o las ejecuciones asociadas con la fuente de datos. Esta configuración tiene mayor prioridad que whitelisted_project_ids.

transferConfigPubsubTopic

string

Es el tema de Pub/Sub que se usa con el fin de transmitir un mensaje para la configuración de la transferencia. Si está vacío, no se transmitirá un mensaje. Tanto este tema como transferRunPubsubTopic se generan de forma automática si ninguno de ellos se proporciona cuando se crea la definición. Se recomienda proporcionar transferConfigPubsubTopic si se proporciona un transferRunPubsubTopic que es propiedad del usuario. De lo contrario, se establecerá como vacío. Si se encuentra “{location}” en el valor, significa que la fuente de datos desea manejar el mensaje por separado para conjuntos de datos en diferentes regiones. Reemplazaremos {location} por la ubicación real del conjunto de datos, como el nombre real del tema. Por ejemplo, projects/connector/topics/scheduler-{location} podría convertirse en projects/connector/topics/scheduler-us. Si no se encuentra “{location}”, usaremos el valor de entrada como nombre del tema.

supportedLocationIds[]

string

Son los location_ids admitidos que se usan para decidir en qué ubicaciones se deben crear los temas de Pub/Sub. Si se usan temas personalizados de Pub/Sub y contienen “{location}”, se usarán location_ids para validar los temas mediante el reemplazo de “{location}” por la ubicación individual en la lista. Los valores válidos son el campo “locationId” de la respuesta de GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations. Además, si la fuente de datos necesita compatibilidad con todas las regiones disponibles, se puede establecer supportedLocationIds en “global” (un elemento de una sola string). Cuando se especifica “global” debe suceder lo siguiente: 1) la implementación de la fuente de datos debe almacenar en etapa intermedia los datos en la región adecuada del conjunto de datos de destino; 2) el desarrollador de fuentes de datos debe tener en cuenta las implicaciones (p. ej., latencia del tráfico de red, posible costo asociado con tráfico entre regiones, etc.) de admitir la región “global”.

Métodos

create

 Crea una definición de fuente de datos.

delete

 Borra una definición de fuente de datos. El usuario primero debe borrar todas las opciones de configuración de transferencia asociadas con esta definición de fuente de datos (si hay alguna) en TODAS las regiones a fin de poder borrar la definición de la fuente de datos.

get

 Recupera una definición de fuente de datos existente.

list

 Enumera las definiciones de la fuente de datos admitidas.

patch

 Actualiza una definición de fuente de datos existente.