Recurso de REST: projects.transferConfigs

Recurso: TransferConfig

Representa una configuración de transferencia de datos. Una configuración de transferencia contiene todos los metadatos necesarios para realizar una transferencia de datos. Por ejemplo, destinationDatasetId especifica donde se deben almacenar los datos. Cuando se crea una configuración de transferencia nueva, se crea el destinationDatasetId especificado cuando es necesario y se comparte con la cuenta de servicio de la fuente de datos adecuada.

Representación JSON 

{
  "name": string,
  "destinationDatasetId": string,
  "displayName": string,
  "dataSourceId": string,
  "params": {
    object
  },
  "schedule": string,
  "dataRefreshWindowDays": number,
  "disabled": boolean,
  "updateTime": string,
  "nextRunTime": string,
  "state": enum(TransferState),
  "userId": string,
  "datasetRegion": string,
  "partnerToken": string,
  "partnerConnectionInfo": {
    object
  }
}
Campos
name

string

Es el nombre de recurso de la configuración de transferencia. Los nombres de la configuración de transferencia tienen el formato projects/{projectId}/locations/{region}/transferConfigs/{configId}. El nombre se genera de forma automática en función del configId especificado en CreateTransferConfigRequest, junto con projectId y la región. Si no se proporciona configId, que suele ser un uuid, aunque no esté garantizado ni sea obligatorio, se generará para configId.

destinationDatasetId

string

Es el ID del conjunto de datos de destino de BigQuery.

displayName

string

Es el nombre visible del usuario especificado para la transferencia de datos.

dataSourceId

string

Es el ID de la fuente de datos. No se puede cambiar una vez que se crea la transferencia de datos.

params

object (Struct format)

Son parámetros específicos de transferencia de datos.

schedule

string

Indica el programa de transferencia de datos. Si la fuente de datos no admite un programa personalizado, debería estar vacío. Si está vacío, se usará el valor predeterminado para la fuente de datos. Las horas especificadas están en UTC. Ejemplos de formato válido: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 y first sunday of quarter 00:00. Consulta más explicaciones sobre el formato aquí: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTA: El nivel de detalle debe ser de al menos 8 horas o menos frecuente.

dataRefreshWindowDays

number

Es la cantidad de días hacia atrás para actualizar los datos de forma automática. Por ejemplo, si dataRefreshWindowDays = 10, BigQuery transfiere datos para [today-10, today-1] todos los días, en lugar de transferir datos por solo [today-1]. Solo es válido si la fuente de datos admite la función. Establece el valor en 0 para usar el valor predeterminado.

disabled

boolean

Esta configuración está inhabilitada. Cuando se configura como verdadero, no se programan ejecuciones para una transferencia determinada.

updateTime

string (Timestamp format)

Solo salida. Hora de modificación de la transferencia de datos. Se ignora el servidor en la entrada.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".
nextRunTime

string (Timestamp format)

Solo salida. La próxima vez que se ejecutará la transferencia de datos.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".
state

enum(TransferState)

Solo salida. Es el estado de la ejecución de transferencia con la actualización más reciente.

userId

string (int64 format)

Obsoleto. Es el ID único del usuario en cuyo nombre se realizó la transferencia.

datasetRegion

string

Solo salida. Es la región en la que se encuentra el conjunto de datos de BigQuery.

partnerToken

string

Es un identificador único que se usa para identificar una configuración de transferencia almacenada del lado del socio externo. El token es opaco para DTS y solo los socios lo pueden interpretar. La fuente de datos de socios debe crear una asignación entre el ID de configuración y el token para validar que una configuración o ejecución de transferencia es legítima.

partnerConnectionInfo

object (Struct format)

Indica una configuración de transferencia administrada por fuentes de datos de socios. Se almacena como pares clave-valor y se usa solo con fines de visualización de la IU de DTS. Hay dos motivos por los que no querrías almacenarlos junto con “params”: la información de conexión la proporciona el socio y no es editable en la IU de DTS, que es diferente del parámetro inmutable. Resultaría confuso agregar otro valor booleano a DataSourceParameter para diferenciarlos. - La información de conexión puede ser cualquier par clave-valor arbitrario. Agregarlos a los campos de parámetros requiere que el socio les proporcione una definición en la definición de fuente de datos. Es recomendable que los socios eviten este procedimiento.

Métodos

create

 Crea una configuración de transferencia de datos nueva.

delete

 Borra una configuración de transferencia de datos, incluidas las ejecuciones y los registros de las transferencias asociadas.

get

 Muestra información sobre una configuración de transferencia de datos.

list

 Muestra información sobre todas las transferencias de datos del proyecto.

patch

 Actualiza una configuración de transferencia de datos.

scheduleRuns

 Crea ejecuciones de transferencia para un intervalo de tiempo [start_time, end_time].