Recurso REST: projects.locations.transferConfigs

Recurso: TransferConfig

Representa uma configuração de transferência de dados. Uma configuração de transferência contém todos os metadados necessários para realizar uma transferência de dados. Por exemplo, destinationDatasetId especifica o local em que os dados precisam ser armazenados. Quando uma nova configuração de transferência é criada, o destinationDatasetId especificado é criado quando necessário e compartilhado com a conta de serviço da fonte de dados apropriada.

Representação JSON 

{
  "name": string,
  "displayName": string,
  "dataSourceId": string,
  "params": {
    object
  },
  "schedule": string,
  "scheduleOptions": {
    object (ScheduleOptions)
  },
  "dataRefreshWindowDays": integer,
  "disabled": boolean,
  "updateTime": string,
  "nextRunTime": string,
  "state": enum (TransferState),
  "userId": string,
  "datasetRegion": string,
  "notificationPubsubTopic": string,
  "emailPreferences": {
    object (EmailPreferences)
  },
  "destinationDatasetId": string
}
Campos
name

string

O nome do recurso da configuração de transferência. Os nomes das configurações de transferência têm o formato projects/{projectId}/locations/{region}/transferConfigs/{configId}. O nome é gerado automaticamente com base no configId especificado em CreateTransferConfigRequest com o projectId e a região. Caso o configId não seja informado, geralmente um uuid, mesmo que não seja garantido ou necessário, será gerado para configId.
displayName

string

Nome de exibição especificado pelo usuário para a transferência de dados.
dataSourceId

string

Código da fonte de dados. Não pode ser alterado depois que a transferência de dados é criada.
params

object (Struct format)

Parâmetros específicos de transferência de dados.
schedule

string

Programação da transferência de dados. Se a fonte de dados não for compatível com um agendamento personalizado, este parâmetro precisa ficar vazio. Nesse caso, o valor padrão para a fonte de dados será usado. Os horários especificados estão em UTC. Exemplos de formato válido: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 e first sunday of quarter 00:00. Veja mais explicações sobre o formato em: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format OBSERVAÇÃO: a granularidade precisa ser de, pelo menos, 8 horas ou menos frequente.
scheduleOptions

object (ScheduleOptions)

Opções que personalizam a programação de transferência de dados
dataRefreshWindowDays

integer

O número de dias transcorridos para atualizar os dados automaticamente. Por exemplo, se dataRefreshWindowDays = 10, todos os dias o BigQuery receberá dados de [today-10, today-1], em vez de ingerir dados apenas de [today-1]. Válido apenas se a fonte de dados for compatível com o recurso. Defina o valor como 0 para usar o valor padrão.
disabled

boolean

Esta configuração está desativada. Quando definido como verdadeiro, nenhuma execução é planejada para uma determinada transferência.
updateTime

string (Timestamp format)

Apenas saída. Horário de modificação da transferência de dados. Ignorado pelo servidor na entrada.
nextRunTime

string (Timestamp format)

Apenas saída. A próxima vez que a transferência de dados será executada.
state

enum (TransferState)

Apenas saída. Estado da execução de transferência atualizada mais recentemente.
userId

string (int64 format)

Obsoleto. ID exclusivo do usuário que tem a transferência feita no nome dele.
datasetRegion

string

Apenas saída. Região na qual o conjunto de dados do BigQuery está localizado.
notificationPubsubTopic

string

Tópico do Pub/Sub em que as notificações serão enviadas quando as execuções de transferência associadas à configuração de transferência forem concluídas.
emailPreferences

object (EmailPreferences)

As notificações por e-mail serão enviadas de acordo com essas preferências para o endereço de e-mail do usuário proprietário dessa configuração de transferência.
destinationDatasetId

string

O ID do conjunto de dados de destino do BigQuery.

ScheduleOptions

Opções que personalizam a programação de transferência de dados

Representação JSON 

{
  "disableAutoScheduling": boolean,
  "startTime": string,
  "endTime": string
}
Campos
disableAutoScheduling

boolean

Se verdadeiro, a programação automática de execuções de transferência de dados desta configuração será desativada. As execuções podem ser iniciadas ad-hoc usando a API transferConfigs.startManualRuns. Quando a programação automática estiver desativada, o campo TransferConfig.schedule será ignorado.
startTime

string (Timestamp format)

Especifica o horário para iniciar a programação de execuções de transferência. A primeira execução será programada no horário de início ou posterior a ele, de acordo com um padrão de recorrência definido na string de programação. O horário de início pode ser alterado a qualquer momento. Essa opção não limita o horário em que uma transferência de dados pode ser realizada manualmente.
endTime

string (Timestamp format)

Define o tempo para interromper a programação de execuções de transferência. Não é possível programar uma execução de transferência no horário de término ou depois dele. O horário de término pode ser alterado a qualquer momento. Essa opção não limita o horário em que uma transferência de dados pode ser realizada manualmente.

Métodos

create

 Cria uma nova configuração de transferência de dados.

delete

 Exclui uma configuração de transferência de dados, incluindo execuções de transferência e registros associados.

get

 Retorna informações sobre uma configuração de transferência de dados.

list

 Retorna informações sobre todas as transferências de dados no projeto.

patch

 Atualiza uma configuração de transferência de dados.

scheduleRuns
(deprecated)

 Cria execuções de transferência para um intervalo de tempo [start_time, end_time].

startManualRuns

 Inicia a execução manual de transferências com schedule_time igual ao horário atual.