Pacote google.cloud.bigquery.datatransfer.v1

Índice

DataTransferService

A Data Transfer Service API do Google BigQuery permite que os usuários do BigQuery configurem a transferência de dados de outros produtos do Google para o BigQuery. Este serviço contém métodos que são expostos ao usuário final. Além disso, ele faz o back-up do front-end.

CheckValidCreds

rpc CheckValidCreds(CheckValidCredsRequest) returns (CheckValidCredsResponse)

Retornará verdadeiro caso haja credenciais válidas para a fonte de dados e o usuário solicitante. Algumas fontes de dados não são compatíveis com conta de serviço, por isso é necessário se referir a elas em nome do usuário final. Essa API apenas verifica se temos o token OAuth para o usuário específico, que é um pré-requisito para que o usuário possa criar uma configuração de transferência.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
CreateTransferConfig

rpc CreateTransferConfig(CreateTransferConfigRequest) returns (TransferConfig)

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

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
DeleteTransferConfig

rpc DeleteTransferConfig(DeleteTransferConfigRequest) returns (Empty)

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

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
DeleteTransferRun

rpc DeleteTransferRun(DeleteTransferRunRequest) returns (Empty)

Exclui a execução de transferência especificada.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

Recupera uma fonte de dados compatível e retorna suas configurações, que podem ser usadas para renderização da IU.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
GetTransferConfig

rpc GetTransferConfig(GetTransferConfigRequest) returns (TransferConfig)

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

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
GetTransferRun

rpc GetTransferRun(GetTransferRunRequest) returns (TransferRun)

Retorna informações sobre a execução de transferência específica.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
ListDataSources

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

Lista as fontes de dados compatíveis e retorna as configurações delas, que podem ser usadas para renderização da IU.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
ListTransferConfigs

rpc ListTransferConfigs(ListTransferConfigsRequest) returns (ListTransferConfigsResponse)

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

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
ListTransferLogs

rpc ListTransferLogs(ListTransferLogsRequest) returns (ListTransferLogsResponse)

Retorna mensagens de registro do usuário para a execução da transferência de dados.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
ListTransferRuns

rpc ListTransferRuns(ListTransferRunsRequest) returns (ListTransferRunsResponse)

Retorna informações sobre jobs em execução e concluídos.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
ScheduleTransferRuns

rpc ScheduleTransferRuns(ScheduleTransferRunsRequest) returns (ScheduleTransferRunsResponse)

Cria execuções de transferência para um intervalo de tempo [start_time, end_time]. Para cada data (ou qualquer granularidade compatível com a fonte de dados) no intervalo, uma execução de transferência é criada. As execuções são criadas no horário UTC no intervalo de tempo. OBSOLETO: use StartManualTransferRuns.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
StartManualTransferRuns

rpc StartManualTransferRuns(StartManualTransferRunsRequest) returns (StartManualTransferRunsResponse)

Inicie as transferências manuais a serem executadas agora com schedule_time igual ao horário atual. As execuções de transferência podem ser criadas para um intervalo de tempo entre start_time (incluso) e end_time (não incluso) ou para um run_time específico.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.
UpdateTransferConfig

rpc UpdateTransferConfig(UpdateTransferConfigRequest) returns (TransferConfig)

Atualiza uma configuração de transferência de dados. Todos os campos precisam ser definidos, mesmo que não estejam atualizados.

Escopos da autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.

CheckValidCredsRequest

Uma solicitação para determinar se o usuário tem credenciais válidas. Esse método é usado para limitar o número de pop-ups OAuth na interface do usuário. O código do usuário é inferido do contexto da chamada da API. Se a fonte de dados tiver o tipo de autorização do Google+, esse método retornará falso, porque não é possível determinar se as credenciais já são válidas apenas com base no código do usuário.

Campos
name

string

Obrigatório. A fonte de dados no formato: projects/{project_id}/dataSources/{data_source_id} ou projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • bigquery.transfers.get

CheckValidCredsResponse

Uma resposta indicando se as credenciais existem e são válidas.

Campos
has_valid_creds

bool

Se definido como true, as credenciais existem e são válidas.

CreateTransferConfigRequest

Uma solicitação para criar uma configuração de transferência de dados. Se novas credenciais forem necessárias para essa configuração de transferência, um código de autorização precisa ser fornecido. Se um código de autorização for fornecido, a configuração de transferência será associada ao código do usuário correspondente ao código de autorização. Caso contrário, a configuração de transferência será associada ao usuário chamador.

Campos
parent

string

Obrigatório. O ID do projeto do BigQuery em que a configuração de transferência precisa ser criada. Precisa estar no formato projects/{project_id}/locations/{location_id} ou projects/{project_id}. Se o local especificado e o local de destino do conjunto de dados do BigQuery não corresponderem, a solicitação falhará.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • bigquery.transfers.update
transfer_config

TransferConfig

Obrigatório. Configuração de transferência de dados a ser criada.
authorization_code

string

Código de autorização OAuth2 opcional para usar com essa configuração de transferência. Será obrigatório caso sejam necessárias novas credenciais, conforme indicado por CheckValidCreds. Para receber o authorization_code, faça uma solicitação para https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=

  • client_id precisa ser o OAuth client_id da API BigQuery DTS referente à fonte de dados retornada pelo método ListDataSources.
  • data_source_scopes são os escopos retornados pelo método ListDataSources.
  • redirect_uri é um parâmetro opcional. Se não for especificado, o código de autorização será postado na janela de abertura do fluxo de autorização. Caso contrário, será enviado para o URI de redirecionamento. Um valor especial de urn:ietf:wg:oauth:2.0:oob significa que o código de autorização precisa ser retornado na barra de título do navegador, com o texto da página solicitando que o usuário copie o código e cole-o no aplicativo.
version_info

string

Informações opcionais de versão. Se os usuários quiserem encontrar um token de acesso muito recente, ou seja, logo após aprovar o acesso, será necessário definir a declaração version_info na solicitação do token. Para encontrar o version_info, os usuários precisam usar o tipo de resposta "none+gsession", que retorna um version_info na resposta de autorização que será colocada em uma declaração JWT na solicitação do token.
service_account_name

string

Nome opcional da conta de serviço. Se este campo estiver definido, a configuração de transferência será criada usando as credenciais da conta de serviço. Para isso, o usuário que chama a API precisa ter permissões para realizações ações com essa conta de serviço.

DataSource

Representa os metadados da fonte de dados. Os metadados são suficientes para renderizar a interface do usuário e solicitar tokens OAuth adequados.

Campos
name

string

Apenas saída. Nome do recurso de fonte de dados.
data_source_id

string

Código da fonte de dados.
display_name

string

Nome da fonte de dados amigável.
description

string

String de descrição da fonte de dados amigável.
client_id

string

ID do cliente da fonte de dados que precisa ser usado para recebimento do token de atualização.
scopes[]

string

Escopos de autenticação da API que precisam ser usados para recebimento do token de atualização. Esses são os escopos necessários para que uma fonte de dados prepare dados e ingira-os no BigQuery, por exemplo, https://www.googleapis.com/auth/bigquery
transfer_type
(deprecated)

TransferType

Obsoleto. Esse campo não tem efeito.
supports_multiple_transfers
(deprecated)

bool

Obsoleto. Esse campo não tem efeito.
update_deadline_seconds

int32

O número de segundos a aguardar por uma atualização da fonte de dados antes que o serviço de transferência de dados marque a transferência como FAILED.
default_schedule

string

Horário padrão de transferência de dados. Exemplos de programações válidas incluem: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 e first sunday of quarter 00:00.
supports_custom_schedule

bool

Especifica se a fonte de dados é compatível com uma programação definida pelo usuário ou se opera na programação padrão. Quando definido como true, o usuário pode substituir a programação padrão.
parameters[]

DataSourceParameter

Parâmetros da fonte de dados.
help_url

string

URL para o documento de ajuda para essa fonte de dados.
authorization_type

AuthorizationType

Indica o tipo de autorização.
data_refresh_type

DataRefreshType

Especifica se (e como) a fonte de dados é compatível com atualização automática de dados nos últimos dias. Em algumas fontes, os dados só ficam completos alguns dias depois. Por isso, é útil atualizá-los automaticamente.
default_data_refresh_window_days

int32

Janela de atualização de dados padrão em dias. Significativa apenas quando data_refresh_type = SLIDING_WINDOW.
manual_runs_disabled

bool

Desativa o preenchimento e a programação de execução manual para a fonte de dados.
minimum_schedule_interval

Duration

O intervalo mínimo para o programador agendar execuções.

AuthorizationType

O tipo de autorização necessária para essa fonte de dados.

Enums
AUTHORIZATION_TYPE_UNSPECIFIED Tipo não especificado.
AUTHORIZATION_CODE Usa os códigos de autorização do OAuth 2 que podem ser trocados por um token de atualização no back-end.
GOOGLE_PLUS_AUTHORIZATION_CODE Retorna um código de autorização para uma determinada página do Google+ que pode ser trocado por um token de atualização no back-end.
FIRST_PARTY_OAUTH Use o OAuth primário com base nos Clientes do Loas. O OAuth primário não requer um token de atualização para receber um token de acesso off-line. Em vez disso, ele usa uma declaração JWT assinada pelo cliente para recuperar um token de acesso.

DataRefreshType

Representa como a fonte de dados oferece suporte à atualização automática de dados.

Enums
DATA_REFRESH_TYPE_UNSPECIFIED A fonte de dados não é compatível com a atualização automática de dados, que é o valor padrão.
SLIDING_WINDOW A fonte de dados é compatível com a atualização automática de dados, e as execuções serão programadas para os últimos dias. Não permite que valores personalizados sejam configurados para cada configuração de transferência.
CUSTOM_SLIDING_WINDOW A fonte de dados é compatível com a atualização automática de dados, e as execuções serão programadas para os últimos dias. Permite que valores personalizados sejam definidos para cada configuração de transferência.

DataSourceParameter

Representa um parâmetro de fonte de dados com regras de validação para que os parâmetros possam ser renderizados na IU. Esses parâmetros são fornecidos por fontes de dados compatíveis e incluem todas as informações necessárias para renderização e validação. Portanto, quem usa essa API pode decidir gerar formulários específicos de IU genérica ou de fonte de dados personalizada.

Campos
param_id

string

Parâmetro identificador.
display_name

string

Nome de exibição do parâmetro na interface do usuário.
description

string

Descrição do parâmetro.
type

Type

Tipo de parâmetro.
required

bool

É um parâmetro obrigatório.
repeated

bool

Obsoleto. Esse campo não tem efeito.
validation_regex

string

Expressão regular que pode ser usada para validação de parâmetros.
allowed_values[]

string

Todos os valores possíveis para o parâmetro.
min_value

DoubleValue

Para valores inteiros e duplos, especifica o valor mínimo permitido.
max_value

DoubleValue

Para valores inteiros e duplos, especifica o valor máximo permitido.
fields[]

DataSourceParameter

Obsoleto. Esse campo não tem efeito.
validation_description

string

Descrição dos requisitos deste campo, caso a entrada do usuário não atenda ao padrão da expressão regular ou aos valores de mínimo/máximo.
validation_help_url

string

URL de um documento de ajuda para explicar melhor os requisitos de nomenclatura.
immutable

bool

Não pode ser alterado após a criação inicial.
recurse

bool

Obsoleto. Esse campo não tem efeito.
deprecated

bool

Se o valor for verdadeiro, ele não deverá ser usado em novas transferências e não ficará visível para usuários.

Tipo

Tipo de parâmetro.

Enums
TYPE_UNSPECIFIED Tipo não especificado.
STRING Parâmetro de string.
INTEGER Parâmetro inteiro (64 bits). Será serializado para json como string.
DOUBLE Parâmetro de ponto flutuante de precisão dupla.
BOOLEAN Parâmetro booleano.
RECORD Obsoleto. Esse campo não tem efeito.
PLUS_PAGE Código da página de uma Página do Google+.

DeleteTransferConfigRequest

Uma solicitação para excluir informações de transferência de dados. Todas as execuções de transferência e mensagens de registro associadas serão excluídas também.

Campos
name

string

Obrigatório. O campo terá o nome do recurso solicitado, por exemplo: projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • bigquery.transfers.update

DeleteTransferRunRequest

Uma solicitação para excluir informações de execução de transferência de dados.

Campos
name

string

Obrigatório. O campo terá o nome do recurso solicitado, por exemplo: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • bigquery.transfers.update

EmailPreferences

Representa preferências sobre notificações por e-mail para eventos de execução de transferência.

Campos
enable_failure_email

bool

Se for verdadeiro, as notificações por e-mail serão enviadas caso haja falha na execução da transferência.

GetDataSourceRequest

Uma solicitação para receber informações da fonte de dados.

Campos
name

string

Obrigatório. O campo terá o nome do recurso solicitado, por exemplo: projects/{project_id}/dataSources/{data_source_id} ou projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • bigquery.transfers.get

GetTransferConfigRequest

Uma solicitação para receber informações de transferência de dados.

Campos
name

string

Obrigatório. O campo terá o nome do recurso solicitado, por exemplo: projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • bigquery.transfers.get

GetTransferRunRequest

Uma solicitação para receber informações sobre a execução de transferência de dados.

Campos
name

string

Obrigatório. O campo terá o nome do recurso solicitado, por exemplo: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}.

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • bigquery.transfers.get

ListDataSourcesRequest

Uma solicitação para listar fontes de dados compatíveis e suas configurações de transferência.

Campos
parent

string

Obrigatório. O ID do projeto do BigQuery para onde as fontes de dados precisam ser retornadas. Precisa estar no formato: projects/{project_id} ou `projects/{project_id}/locations/{location_id}

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • bigquery.transfers.get
page_token

string

O token de paginação, que pode ser usado para solicitar uma página específica de resultados da lista ListDataSourcesRequest. Para resultados de várias páginas, ListDataSourcesResponse gera um token next_page, que pode ser usado como o valor page_token para solicitar a próxima página de resultados da lista.
page_size

int32

Tamanho da página. O tamanho de página padrão é o valor máximo de 1.000 resultados.

ListDataSourcesResponse

Retorna a lista de fontes de dados compatíveis e seus metadados.

Campos
data_sources[]

DataSource

Lista de fontes de dados compatíveis e suas configurações de transferência.
next_page_token

string

Apenas saída. O próximo token de paginação. Para listas de resultados com várias páginas, esse token pode ser usado como ListDataSourcesRequest.page_token para solicitar a próxima página de resultados da lista.

ListTransferConfigsRequest

Uma solicitação para listar as transferências de dados configuradas para um projeto do BigQuery.

Campos
parent

string

Obrigatório. O ID do projeto do BigQuery a que as fontes de dados precisam ser retornadas: projects/{project_id} ou projects/{project_id}/locations/{location_id}

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • bigquery.transfers.get
data_source_ids[]

string

Quando especificado, somente configurações de fontes de dados solicitadas são retornadas.
page_token

string

O token de paginação, que pode ser usado para solicitar uma página específica de resultados da lista ListTransfersRequest. Para resultados de várias páginas, ListTransfersResponse gera um token next_page, que pode ser usado como o valor page_token para solicitar a próxima página de resultados da lista.
page_size

int32

Tamanho da página. O tamanho de página padrão é o valor máximo de 1.000 resultados.

ListTransferConfigsResponse

A lista retornada de canais no projeto.

Campos
transfer_configs[]

TransferConfig

Apenas saída. As configurações de transferência de canal armazenadas.
next_page_token

string

Apenas saída. O próximo token de paginação. Para listas de resultados com várias páginas, esse token pode ser usado como ListTransferConfigsRequest.page_token para solicitar a próxima página de resultados da lista.

ListTransferLogsRequest

Uma solicitação para receber mensagens de registro do usuário associadas à transferência de dados é executada.

Campos
parent

string

Obrigatório. Nome da execução de transferência no formato: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • bigquery.transfers.get
page_token

string

O token de paginação, que pode ser usado para solicitar uma página específica de resultados da lista ListTransferLogsRequest. Para resultados de várias páginas, ListTransferLogsResponse gera um token next_page, que pode ser usado como o valor page_token para solicitar a próxima página de resultados da lista.
page_size

int32

Tamanho da página. O tamanho de página padrão é o valor máximo de 1.000 resultados.
message_types[]

MessageSeverity

Tipos de mensagens para retornar. Se não preenchido, as mensagens INFO, WARNING e ERROR são retornadas.

ListTransferLogsResponse

A lista retornada de mensagens de execução de transferência.

Campos
transfer_messages[]

TransferMessage

Apenas saída. As mensagens de transferência de canal armazenadas.
next_page_token

string

Apenas saída. O próximo token de paginação. Para listas de resultados com várias páginas, esse token pode ser usado como GetTransferRunLogRequest.page_token para solicitar a próxima página de resultados da lista.

ListTransferRunsRequest

Uma solicitação para listar execuções de transferência de dados. A interface do usuário pode usar esse método para mostrar/filtrar execuções de transferência de dados específicas. A fonte de dados pode usar esse método para solicitar todas as execuções de transferência programadas.

Campos
parent

string

Obrigatório. Nome da configuração de transferência para que as execuções de transferência precisam ser recuperadas. O formato do nome do recurso da configuração de transferência é: projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • bigquery.transfers.get
states[]

TransferState

Quando especificado, apenas as execuções de transferência com estados solicitados são retornadas.
page_token

string

O token de paginação, que pode ser usado para solicitar uma página específica de resultados da lista ListTransferRunsRequest. Para resultados de várias páginas, ListTransferRunsResponse gera um token next_page, que pode ser usado como o valor page_token para solicitar a próxima página de resultados da lista.
page_size

int32

Tamanho da página. O tamanho de página padrão é o valor máximo de 1.000 resultados.
run_attempt

RunAttempt

Indica como as tentativas de execução precisam ser retornadas.

RunAttempt

Representa quais execuções precisam ser retornadas.

Enums
RUN_ATTEMPT_UNSPECIFIED Todas as execuções precisam ser retornadas.
LATEST Apenas a última execução por dia precisa ser retornada.

ListTransferRunsResponse

A lista retornada de canais no projeto.

Campos
transfer_runs[]

TransferRun

Apenas saída. A transferência de canais armazenada é executada.
next_page_token

string

Apenas saída. O próximo token de paginação. Para listas de resultados com várias páginas, esse token pode ser usado como ListTransferRunsRequest.page_token para solicitar a próxima página de resultados da lista.

ScheduleOptions

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

Campos
disable_auto_scheduling

bool

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

Timestamp

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, 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.
end_time

Timestamp

Define o horário 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.

ScheduleTransferRunsRequest

Uma solicitação para programar execuções de transferência para um intervalo de tempo.

Campos
parent

string

Obrigatório. O nome da configuração de transferência no formato: projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • bigquery.transfers.update
start_time

Timestamp

Obrigatório. Horário de início do intervalo de execuções de transferência. Por exemplo, "2017-05-25T00:00:00+00:00"
end_time

Timestamp

Obrigatório. Horário de término do intervalo de execuções de transferência. Por exemplo, "2017-05-30T00:00:00+00:00"

ScheduleTransferRunsResponse

Uma resposta para programar execuções de transferência por um período.

Campos
runs[]

TransferRun

As execuções de transferência que foram programadas.

StartManualTransferRunsRequest

Uma solicitação para iniciar execuções de transferência manual.

Campos
parent

string

O nome da configuração de transferência no formato: projects/{project_id}/transferConfigs/{config_id} ou projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • bigquery.transfers.update
Campo de união time. A especificação de hora solicitada: pode ser um intervalo de tempo ou um run_time específico. time pode ser apenas de um dos tipos a seguir:
requested_time_range

TimeRange

Intervalo de tempo para as execuções de transferência que precisam ser iniciadas.
requested_run_time

Timestamp

run_time específico para iniciar uma execução de transferência. O requested_run_time não pode estar no futuro.

TimeRange

A especificação do intervalo de tempo. Será usado para solicitar execuções de transferência com run_time entre start_time (inclusive) e end_time (exclusivo).

Campos
start_time

Timestamp

Horário de início do intervalo de execuções de transferência. Por exemplo, "2017-05-25T00:00:00+00:00" O horário de início precisa ser menor que o de término. Cria execuções de transferência em que o run_time está no intervalo entre start_time (inclusive) e end_time (exclusivo).
end_time

Timestamp

Horário de término do intervalo de execuções de transferência. Por exemplo, "2017-05-30T00:00:00+00:00" O end_time não pode ser no futuro. Cria execuções de transferência em que o run_time está no intervalo entre start_time (inclusive) e end_time (exclusivo).

StartManualTransferRunsResponse

Uma resposta para iniciar execuções de transferência manual.

Campos
runs[]

TransferRun

As execuções de transferência criadas.

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, destination_dataset_id especifica onde os dados precisam ser armazenados. Quando uma nova configuração de transferência é criada, o destination_dataset_id especificado é criado quando necessário e compartilhado com a conta de serviço da fonte de dados apropriada.

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/{project_id}/locations/{region}/transferConfigs/{config_id}. O nome é gerado automaticamente com base no config_id especificado em CreateTransferConfigRequest com o project_id e a região. Caso o config_id não seja inserido, geralmente um uuid, mesmo que não seja garantido ou necessário, será gerado para o config_id.
display_name

string

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

string

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

Struct

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.
schedule_options

ScheduleOptions

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

int32

A quantidade de dias para passados para atualizar automaticamente os dados. Por exemplo, se data_refresh_window_days = 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

bool

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

Timestamp

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

Timestamp

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

TransferState

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

int64

Obsoleto. ID exclusivo do usuário que tem a transferência feita em seu nome.
dataset_region

string

Apenas saída. Região onde o conjunto de dados do BigQuery está localizado.
notification_pubsub_topic

string

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

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.
destination_dataset_id

string

O ID do conjunto de dados de destino do BigQuery.

TransferMessage

Representa uma mensagem do usuário para uma determinada execução de transferência de dados.

Campos
message_time

Timestamp

Horário em que a mensagem foi registrada.
severity

MessageSeverity

Gravidade da mensagem.
message_text

string

Texto da mensagem.

MessageSeverity

Representa a gravidade da mensagem do usuário da transferência de dados.

Enums
MESSAGE_SEVERITY_UNSPECIFIED Nenhuma gravidade especificada.
INFO Mensagem informativa.
WARNING Mensagem de alerta.
ERROR Mensagem de erro.

TransferRun

Representa uma execução de transferência de dados.

Campos
name

string

O nome do recurso da execução de transferência. Os nomes das execuções de transferência têm o formato projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. O nome é ignorado ao criar uma execução de transferência.
schedule_time

Timestamp

Tempo mínimo para que uma execução de transferência possa ser iniciada.
run_time

Timestamp

Especifica a data e a hora dos dados que serão ingeridos em execuções de transferência em lote.
error_status

Status

Status da execução da transferência.
start_time

Timestamp

Apenas saída. Hora em que a execução da transferência foi iniciada. Parâmetro ignorado pelo servidor para solicitações de entrada.
end_time

Timestamp

Apenas saída. Hora em que a execução da transferência foi finalizada. Parâmetro ignorado pelo servidor para solicitações de entrada.
update_time

Timestamp

Apenas saída. Última vez que o estado de execução da transferência de dados foi atualizado.
params

Struct

Apenas saída. Parâmetros específicos de transferência de dados.
data_source_id

string

Apenas saída. Código da fonte de dados.
state

TransferState

Estado de execução da transferência de dados. Ignorado para solicitações de entrada.
user_id

int64

Obsoleto. ID exclusivo do usuário que tem a transferência feita em seu nome.
schedule

string

Apenas saída. Descreve a programação dessa execução de transferência se ela foi criada como parte de uma programação regular. Para execuções de transferência em lote programadas manualmente, este parâmetro fica vazio. Observação: o sistema pode atrasar a programação, dependendo da carga atual. Portanto, schedule_time nem sempre corresponde a isso.
notification_pubsub_topic

string

Apenas saída. Tópico do Pub/Sub a que uma notificação será enviada quando a transferência for concluída
email_preferences

EmailPreferences

Apenas saída. Essas preferências serão usadas para enviar notificações para o endereço de e-mail do usuário que é proprietário da configuração de transferência que serviu como base para derivar a execução.
destination_dataset_id

string

Apenas saída. O ID do conjunto de dados de destino do BigQuery.

TransferState

Representa o estado de execução da transferência de dados.

Enums
TRANSFER_STATE_UNSPECIFIED Marcador para o estado.
PENDING A transferência de dados está programada e está aguardando para ser retirada pelo back-end de transferência de dados.
RUNNING A transferência de dados está em andamento.
SUCCEEDED Transferência de dados concluída com sucesso.
FAILED Falha na transferência de dados.
CANCELLED Transferência de dados foi cancelada.

TransferType

OBSOLETO. Representa o tipo de transferência de dados.

Enums
TRANSFER_TYPE_UNSPECIFIED Marcador para tipo de transferência inválido ou desconhecido.
BATCH Transferência de dados em lote.
STREAMING Transmissão de dados por streaming. Atualmente, a fonte de dados de streaming não é compatível com várias configurações de transferência por projeto.

UpdateTransferConfigRequest

Solicitação para atualizar uma configuração de transferência. Para atualizar o código do usuário da configuração de transferência, um código de autorização precisa ser fornecido.

Campos
transfer_config

TransferConfig

Obrigatório. Configuração de transferência de dados a ser criada.

A autorização requer a seguinte permissão do IAM no recurso especificado transferConfig:

  • bigquery.transfers.update
authorization_code

string

Código de autorização OAuth2 opcional para usar com essa configuração de transferência. Se for fornecido, a configuração de transferência será associada ao usuário que autoriza. Para receber o authorization_code, faça uma solicitação para https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=

  • client_id precisa ser o OAuth client_id da API BigQuery DTS referente à fonte de dados retornada pelo método ListDataSources.
  • data_source_scopes são os escopos retornados pelo método ListDataSources.
  • redirect_uri é um parâmetro opcional. Se não for especificado, o código de autorização será postado na janela de abertura do fluxo de autorização. Caso contrário, será enviado para o URI de redirecionamento. Um valor especial de urn:ietf:wg:oauth:2.0:oob significa que o código de autorização precisa ser retornado na barra de título do navegador, com o texto da página solicitando que o usuário copie o código e cole-o no aplicativo.
update_mask

FieldMask

Obrigatório. Lista obrigatória de campos a serem atualizados nesta solicitação.
version_info

string

Informações opcionais de versão. Se os usuários quiserem encontrar um token de acesso muito recente, ou seja, logo após aprovar o acesso, será necessário definir a declaração version_info na solicitação do token. Para encontrar o version_info, os usuários precisam usar o tipo de resposta "none+gsession", que retorna um version_info na resposta de autorização que será colocada em uma declaração JWT na solicitação do token.
service_account_name

string

Nome opcional da conta de serviço. Se esse campo estiver definido e "service_account_name" estiver definido em update_mask, a configuração de transferência será atualizada para usar as credenciais da conta de serviço. Para isso, o usuário que chama a API precisa ter permissões para realizações ações com essa conta de serviço.