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 onde 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,
  "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

O nome do recurso do config de transferência. Os nomes de config 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 inserido, geralmente um uuid, mesmo que não seja garantido ou necessário, será gerado para o configId.

destinationDatasetId

string

O ID do conjunto de dados de destino do BigQuery.

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 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, oito horas ou menos frequente.

dataRefreshWindowDays

number

Quantos dias transcorridos para atualizar automaticamente os dados. Por exemplo, se dataRefreshWindowDays = 10, o BigQuery receberá dados todos os dias para [today-10, today-1], em vez de ingerir dados apenas para [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.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
nextRunTime

string (Timestamp format)

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

Um carimbo de data/hora no formato UTC “Zulu” RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
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 onde o conjunto de dados do BigQuery está localizado.

partnerToken

string

Um identificador exclusivo usado para identificar uma configuração de transferência armazenada no lado do parceiro externo. O token é opaco para DTS e só pode ser interpretado pelo parceiro. A fonte de dados do parceiro precisa criar um mapeamento entre o ID do config e o token para confirmar que um config/execução de transferência é legítimo.

partnerConnectionInfo

object (Struct format)

Configurações de transferência gerenciadas por fontes de dados do parceiro. É armazenado como pares de chave-valor e é usado apenas para fins de exibição de IU do DTS. Há dois motivos para não querer armazená-los com os "params": as informações de conexão são fornecidas pelo parceiro e não podem ser editadas na IU do DTS, o que é diferente do parâmetro imutável. A adição de outro booleano ao DataSourceParameter para diferenciá-los provocará confusão. As informações de conexão podem ser qualquer par de chave-valor arbitrário. Para adicioná-los aos campos de parâmetros, o parceiro precisa inserir a definição da fonte de dados para eles. É melhor para os parceiros evitar isso.

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

 Cria execuções de transferência para um período [start_time, end_time].