Recurso REST: projects.locations.dataSourceDefinitions

Recurso: DataSourceDefinition

Representa a definição da fonte de dados.

Representação JSON 

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

string

O nome do recurso da definição da fonte de dados. Os nomes das definições de fonte de dados têm o formato projects/{projectId}/locations/{location}/dataSourceDefinitions/{dataSourceId}.

dataSource

object(DataSource)

Metadados da fonte de dados.

transferRunPubsubTopic

string

O tópico do Pub/Sub que será usado para fazer o broadcast de uma mensagem quando uma execução de transferência é criada. Esse tópico e o transferConfigPubsubTopic podem ser definidos como um tópico personalizado. Por padrão, os dois tópicos serão gerados automaticamente se nenhum deles for especificado ao criar a definição. No entanto, se um tópico for definido manualmente, o outro também precisará ser. A única diferença é que o transferRunPubsubTopic precisa ser um tópico do Pub/Sub preenchido, mas o transferConfigPubsubTopic pode ficar vazio. Os comentários sobre "{location}" para transferConfigPubsubTopic também aparecem aqui.

runTimeOffset

string (Duration format)

Duração que precisa ser adicionada ao scheduleTime para calcular o runTime quando o job está programado. Aplicável apenas para execuções de transferência programadas automaticamente. Usado para iniciar uma execução antecipadamente em uma fonte de dados compatível com a atualização contínua de dados para compensar desvios de fuso horário desconhecidos. Use um número negativo para iniciar uma execução atrasada das fontes de dados incompatíveis com a atualização contínua de dados.

Uma duração em segundos com até nove dígitos fracionários, que termina com "s". Exemplo: "3.5s".
supportEmail

string

Suporte para endereço de e-mail da marca do cliente OAuth, que contém os dados da tela de consentimento.

serviceAccount

string

Quando a conta de serviço for especificada, o BigQuery compartilhará o conjunto de dados criado com essa conta. Além disso, essa conta de serviço estará qualificada para executar atualizações de status e registro de mensagens para execuções de transferência de dados do dataSourceId correspondente.

disabled

boolean

A fonte de dados está desativada? Se estiver, dataSource não estará visível. A API também para de retornar configurações de transferência de dados e/ou execuções associadas à fonte de dados. Essa configuração tem prioridade sobre whitelisted_project_ids.

transferConfigPubsubTopic

string

O tópico do Pub/Sub que será usado para fazer o broadcast de uma mensagem para o config de transferência. Se estiver vazio, o broadcast da mensagem não será feito. Esse tópico e o transferRunPubsubTopic são gerados automaticamente se nenhum deles for especificado ao criar a definição. É recomendado inserir o transferConfigPubsubTopic se um transferRunPubsubTopic pertencente ao usuário for especificado. Caso contrário, ele será definido como vazio. Se "{location}" for encontrado no valor, isso significa que a fonte de dados quer processar a mensagem separadamente para conjuntos de dados em regiões diferentes. Substituiremos {location} pelo local real do conjunto de dados, como o nome do tópico legítimo. Por exemplo, projects/connector/topics/scheduler-{location} passa a ser projects/connector/topics/scheduler-us. Se "{location}" não for encontrado, usaremos o valor de entrada como nome do tópico.

supportedLocationIds[]

string

Location_ids compatíveis usados para decidir em quais locais os tópicos do Pub/Sub precisam ser criados. Se os tópicos personalizados do Pub/Sub forem usados e contiverem "{location}", os location_ids serão usados para validar os tópicos, substituindo "{location}" pelo local individual na lista. Os valores válidos são o campo "locationId" da resposta de GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations. Além disso, se a fonte de dados precisar aceitar todas as regiões disponíveis, supportedLocationIds pode ser definido como "global" (um único elemento de string). Quando "global" é especificado: 1) a implementação da fonte de dados precisa organizar os dados na região adequada do conjunto de dados de destino, 2) o desenvolvedor da fonte de dados precisa estar ciente das implicações (por exemplo, latência do tráfego de rede, possível cobrança associada ao tráfego entre regiões etc.) de oferecer suporte à região "global".

Métodos

create

 Cria uma definição de fonte de dados.

delete

 Exclui uma definição de fonte de dados. Para que a fonte de dados possa ser excluída, todas as configurações de transferência associadas à definição de fonte de dados (se houver) precisam ser excluídas pelo usuário em TODAS as regiões.

get

 Recupera uma definição de fonte de dados existente.

list

 Lista as definições de fontes de dados compatíveis.

patch

 Atualiza uma definição de fonte de dados existente.