Package google.cloud.bigquery.migration.v2

Índice

MigrationService

Serviço para processar migrações de EDW.

CreateMigrationWorkflow

rpc CreateMigrationWorkflow(CreateMigrationWorkflowRequest) returns (MigrationWorkflow)

Cria um fluxo de trabalho de migração.

Escopos de 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.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • bigquerymigration.workflows.create

Para mais informações, consulte a documentação do IAM.
DeleteMigrationWorkflow

rpc DeleteMigrationWorkflow(DeleteMigrationWorkflowRequest) returns (Empty)

Exclui um fluxo de trabalho de migração por nome.

Escopos de 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.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • bigquerymigration.workflows.delete

Para mais informações, consulte a documentação do IAM.
GetMigrationSubtask

rpc GetMigrationSubtask(GetMigrationSubtaskRequest) returns (MigrationSubtask)

Recebe uma subtarefa de migração criada anteriormente.

Escopos de 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.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • bigquerymigration.subtasks.get

Para mais informações, consulte a documentação do IAM.
GetMigrationWorkflow

rpc GetMigrationWorkflow(GetMigrationWorkflowRequest) returns (MigrationWorkflow)

Recebe um fluxo de trabalho de migração criado anteriormente.

Escopos de 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.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • bigquerymigration.workflows.get

Para mais informações, consulte a documentação do IAM.
ListMigrationSubtasks

rpc ListMigrationSubtasks(ListMigrationSubtasksRequest) returns (ListMigrationSubtasksResponse)

Lista subtarefas de migração criadas anteriormente.

Escopos de 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.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • bigquerymigration.subtasks.list

Para mais informações, consulte a documentação do IAM.
ListMigrationWorkflows

rpc ListMigrationWorkflows(ListMigrationWorkflowsRequest) returns (ListMigrationWorkflowsResponse)

Lista o fluxo de trabalho de migração criado anteriormente.

Escopos de 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.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • bigquerymigration.workflows.list

Para mais informações, consulte a documentação do IAM.
StartMigrationWorkflow

rpc StartMigrationWorkflow(StartMigrationWorkflowRequest) returns (Empty)

Inicia um fluxo de trabalho de migração criado anteriormente. Ou seja, o estado passa de DRAFT para RUNNING. Trata-se de um ambiente autônomo se o estado já estiver em RUNNING. Um erro será sinalizado se o estado for diferente de DRAFT ou RUNNING.

Escopos de 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.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • bigquerymigration.workflows.update

Para mais informações, consulte a documentação do IAM.

AzureSynapseDialect

A definição do dialeto para o Azure Synapse.

BigQueryDialect

A definição do dialeto para o BigQuery.

CreateMigrationWorkflowRequest

Solicitação para criar um recurso de fluxo de trabalho de migração.

Campos
parent

string

Obrigatório. O nome do projeto a que esse fluxo de trabalho de migração pertence. Exemplo: projects/foo/locations/bar
migration_workflow

MigrationWorkflow

Obrigatório. O fluxo de trabalho de migração que será criado.

DeleteMigrationWorkflowRequest

Uma solicitação para excluir um fluxo de trabalho de migração criado anteriormente.

Campos
name

string

Obrigatório. O identificador exclusivo do fluxo de trabalho de migração. Exemplo: projects/123/locations/us/workflows/1234

Dialeto

As possíveis opções de dialeto para tradução.

Campos
Campo de união dialect_value. As possíveis opções de dialeto que esta mensagem representa. dialect_value pode ser apenas de um dos tipos a seguir:
bigquery_dialect

BigQueryDialect

O dialeto do BigQuery
hiveql_dialect

HiveQLDialect

O dialeto do HiveQL
redshift_dialect

RedshiftDialect

O dialeto do Redshift
teradata_dialect

TeradataDialect

O dialeto do Teradata
oracle_dialect

OracleDialect

O dialeto do Oracle
sparksql_dialect

SparkSQLDialect

O dialeto do SparkSQL
snowflake_dialect

SnowflakeDialect

O dialeto do Snowflake
netezza_dialect

NetezzaDialect

O dialeto do Netezza
azure_synapse_dialect

AzureSynapseDialect

O dialeto do Azure Synapse
vertica_dialect

VerticaDialect

O dialeto do Vertica
sql_server_dialect

SQLServerDialect

O dialeto do SQL Server
postgresql_dialect

PostgresqlDialect

O dialeto do Postgresql
presto_dialect

PrestoDialect

O dialeto do Presto
mysql_dialect

MySQLDialect

O dialeto do MySQL

ErrorDetail

Informa detalhes de erros, como problemas encontrados ao processar uma subtarefa.

Campos
location

ErrorLocation

Opcional. A localização exata dentro do recurso (se aplicável).
error_info

ErrorInfo

Obrigatório. Descreve a causa do erro com detalhes estruturados.

ErrorLocation

Mantém informações sobre onde o erro está localizado.

Campos
line

int32

Opcional. Se aplicável, indica a linha em que o erro ocorreu. O valor zero significa que não há informações sobre a linha.
column

int32

Opcional. Se aplicável, indica a coluna em que ocorreu o erro. O valor zero significa que não há informações sobre colunas.

GetMigrationSubtaskRequest

Uma solicitação para receber subtarefas de migração criadas anteriormente.

Campos
name

string

Obrigatório. O identificador exclusivo da subtarefa de migração. Exemplo: projects/123/locations/us/workflows/1234/subtasks/543
read_mask

FieldMask

Opcional. A lista de campos a serem recuperados.

GetMigrationWorkflowRequest

Uma solicitação para receber um fluxo de trabalho de migração criado anteriormente.

Campos
name

string

Obrigatório. O identificador exclusivo do fluxo de trabalho de migração. Exemplo: projects/123/locations/us/workflows/1234
read_mask

FieldMask

A lista de campos a serem recuperados.

HiveQLDialect

A definição do dialeto para o HiveQL.

ListMigrationSubtasksRequest

Uma solicitação para listar subtarefas de migração criadas anteriormente.

Campos
parent

string

Obrigatório. A tarefa de migração das subtarefas a serem listadas. Exemplo: projects/123/locations/us/workflows/1234
read_mask

FieldMask

Opcional. A lista de campos a serem recuperados.
page_size

int32

Opcional. O número máximo de tarefas de migração a serem retornadas. O serviço pode retornar menos que esse valor.
page_token

string

Opcional. Um token de página recebido de uma chamada ListMigrationSubtasks anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListMigrationSubtasks precisam corresponder à chamada que forneceu o token da página.
filter

string

Opcional. O filtro que será aplicado. Isso pode ser usado para receber as subtarefas de uma tarefa específica em um fluxo de trabalho, por exemplo, migration_task = "ab012", em que "ab012" é o ID da tarefa (não o nome no mapa nomeado).

ListMigrationSubtasksResponse

Objeto de resposta para uma chamada ListMigrationSubtasks.

Campos
migration_subtasks[]

MigrationSubtask

Subtarefas de migração para a tarefa especificada.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListMigrationWorkflowsRequest

Uma solicitação para listar fluxos de trabalho de migração criados anteriormente.

Campos
parent

string

Obrigatório. O projeto e o local dos fluxos de trabalho de migração a serem listados. Exemplo: projects/123/locations/us
read_mask

FieldMask

A lista de campos a serem recuperados.
page_size

int32

O número máximo de fluxos de trabalho de migração a serem retornados. O serviço pode retornar menos que esse valor.
page_token

string

Um token de página recebido de uma chamada ListMigrationWorkflows anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListMigrationWorkflows precisam corresponder à chamada que forneceu o token da página.

ListMigrationWorkflowsResponse

Objeto de resposta para uma chamada ListMigrationWorkflows.

Campos
migration_workflows[]

MigrationWorkflow

Os fluxos de trabalho de migração para o projeto/local especificado.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

MigrationSubtask

Uma subtarefa de uma migração que carrega detalhes sobre a configuração da subtarefa. O conteúdo dos detalhes não deve importar para o usuário final, mas é um contrato entre o criador da subtarefa e o worker da subtarefa.

Campos
name

string

Apenas saída. Imutável. O nome do recurso da subtarefa de migração. O ID é gerado pelo servidor.

Exemplo: projects/123/locations/us/workflows/345/subtasks/678
task_id

string

O ID exclusivo da tarefa a que essa subtarefa pertence.
type

string

O tipo da subtarefa. O serviço de migração não verifica se esse é um tipo conhecido. Cabe ao criador da tarefa (ou seja, orquestrador ou worker) garantir que ela crie apenas subtarefas para as quais há workers compatíveis pesquisando subtarefas.
state

State

Apenas saída. O estado atual da subtarefa.
processing_error

ErrorInfo

Apenas saída. Uma explicação que pode ser preenchida quando a tarefa está no estado FAILED.
resource_error_details[]

ResourceErrorDetail

Apenas saída. Fornece detalhes dos erros e problemas encontrados durante o processamento da subtarefa. A presença de detalhes do erro não significa que a subtarefa falhou.
resource_error_count

int32

O número de recursos com erros. Observação: esse não é o número total de erros, já que cada recurso pode ter mais de um erro. Isso é usado para indicar truncamento, tendo um resource_error_count maior que o tamanho de resource_error_details.
create_time

Timestamp

Hora em que a subtarefa foi criada.
last_update_time

Timestamp

Hora em que a subtarefa foi atualizada pela última vez.
metrics[]

TimeSeries

As métricas da subtarefa.

Estado

Estados possíveis de uma subtarefa de migração.

Enums
STATE_UNSPECIFIED O estado não foi especificado.
ACTIVE A subtarefa está pronta, ou seja, está pronta para execução.
RUNNING A subtarefa está em execução, ou seja, foi atribuída a um worker para execução.
SUCCEEDED A subtarefa foi concluída.
FAILED A subtarefa foi concluída sem sucesso.
PAUSED A subtarefa está pausada, ou seja, não será programada. Se já tiver sido atribuída, ela ainda poderá ser concluída, mas nenhuma nova renovação será concedida.
PENDING_DEPENDENCY A subtarefa tem uma dependência pendente. Ela será programada quando as dependências forem concluídas.

MigrationTask

Uma única tarefa para uma migração que tem detalhes sobre a configuração da tarefa.

Campos
id

string

Apenas saída. Imutável. O identificador exclusivo da tarefa de migração. O ID é gerado pelo servidor.
type

string

O tipo da tarefa. Precisa ser um dos tipos de tarefas compatíveis: Translation_Teradata2BQ, Translation_Redshift2BQ, Translation_Bteq2BQ, Translation_Oracle2BQ, Translation_HiveQL2BQ, Translation_SparkSQL2BQ, Translation_Snowflake2BQ, Translation_Netezza2BQ, Translation_AzureSynapse2BQ, Translation_Vertica2BQ, Translation_SQLServer2BQ, Translation_Presto2BQ, Translation_MySQL2BQ, Translation_Postgresql2BQ.
state

State

Apenas saída. O estado atual da tarefa.
processing_error

ErrorInfo

Apenas saída. Uma explicação que pode ser preenchida quando a tarefa está no estado FAILED.
create_time

Timestamp

Hora em que a tarefa foi criada.
last_update_time

Timestamp

Hora em que a tarefa foi atualizada pela última vez.
Campo de união task_details. Os detalhes da tarefa. task_details pode ser apenas de um dos tipos a seguir:
translation_config_details

TranslationConfigDetails

Configuração de tarefas para tradução de SQL off-line/em lote do CW.

Estado

Os estados possíveis de uma tarefa de migração.

Enums
STATE_UNSPECIFIED O estado não está especificado.
PENDING A tarefa está aguardando a orquestração.
ORCHESTRATING A tarefa é atribuída a um orquestrador.
RUNNING A tarefa está em execução, ou seja, suas subtarefas estão prontas para execução.
PAUSED A tarefa está pausada. As subtarefas atribuídas podem continuar, mas nenhuma subtarefa nova será agendada.
SUCCEEDED A tarefa foi concluída.
FAILED A tarefa foi concluída sem sucesso.

MigrationWorkflow

Um fluxo de trabalho de migração que especifica o que precisa ser feito para uma migração de EDW.

Campos
name

string

Apenas saída. Imutável. O identificador exclusivo do fluxo de trabalho de migração. O ID é gerado pelo servidor.

Exemplo: projects/123/locations/us/workflows/345
display_name

string

O nome de exibição do fluxo de trabalho. Isso pode ser definido para dar um nome descritivo a um fluxo de trabalho. Não há garantia ou aplicação de exclusividade.
tasks

map<string, MigrationTask>

As tarefas em um fluxo de trabalho em um mapa nomeado. O nome (ou seja, chave) não tem significado e é meramente uma maneira conveniente de abordar uma tarefa específica em um fluxo de trabalho.
state

State

Apenas saída. Esse status do fluxo de trabalho.
create_time

Timestamp

Hora em que o fluxo de trabalho foi criado.
last_update_time

Timestamp

Hora em que o fluxo de trabalho foi atualizado pela última vez.

Estado

Possíveis estados do fluxo de trabalho de migração.

Enums
STATE_UNSPECIFIED O estado do fluxo de trabalho não foi especificado.
DRAFT O fluxo de trabalho está com status rascunho, ou seja, as tarefas ainda não estão qualificadas para execução.
RUNNING O fluxo de trabalho está em execução (ou seja, as tarefas estão qualificadas para execução).
PAUSED O fluxo de trabalho está pausado. As tarefas em andamento podem continuar, mas nenhuma outra tarefa será agendada.
COMPLETED O fluxo de trabalho foi concluído. Não deve haver nenhuma tarefa em um estado não terminal, mas se elas estiverem (por exemplo, encerramento forçado), elas não serão agendadas.

MySQLDialect

A definição do dialeto para o MySQL.

NameMappingKey

Os possíveis componentes de um mapeamento de nome completo que serão mapeados durante a tradução no data warehouse de origem.

Campos
type

Type

O tipo de objeto que está sendo mapeado.
database

string

O nome do banco de dados (ID do projeto do BigQuery equivalente no data warehouse de origem).
schema

string

O nome do esquema (conjunto de dados do BigQuery equivalente no data warehouse de origem).
relation

string

O nome da relação (visualização ou tabela do BigQuery equivalente no data warehouse de origem).
attribute

string

O nome do atributo (coluna do BigQuery equivalente no data warehouse de origem).

Tipo

O tipo do objeto que está sendo mapeado.

Enums
TYPE_UNSPECIFIED Tipo de mapeamento de nome não especificado.
DATABASE O objeto que está sendo mapeado é um banco de dados.
SCHEMA O objeto que está sendo mapeado é um esquema.
RELATION O objeto que está sendo mapeado é uma relação.
ATTRIBUTE O objeto que está sendo mapeado é um atributo.
RELATION_ALIAS O objeto que está sendo mapeado é um alias de relação.
ATTRIBUTE_ALIAS O objeto que está sendo mapeado é um alias de atributo.
FUNCTION O objeto que está sendo mapeado é uma função.

NameMappingValue

Os possíveis componentes de um mapeamento de nome completo que serão mapeados durante a tradução no data warehouse de destino.

Campos
database

string

O nome do banco de dados (ID do projeto do BigQuery equivalente no data warehouse de destino).
schema

string

O nome do esquema (conjunto de dados do BigQuery equivalente no data warehouse de destino).
relation

string

O nome da relação (visualização ou tabela do BigQuery equivalente no data warehouse de destino).
attribute

string

O nome do atributo (coluna do BigQuery equivalente no data warehouse de destino).

NetezzaDialect

A definição do dialeto para o Netezza.

ObjectNameMapping

Representa um par de chave-valor de NameMappingKey para NameMappingValue para representar o mapeamento de nomes SQL do valor de entrada até a saída desejada.

Campos
source

NameMappingKey

O nome do objeto na origem que está sendo mapeado.
target

NameMappingValue

O nome do destino desejado do objeto que está sendo mapeado.

ObjectNameMappingList

Representa um mapa de mapeamentos de nomes usando uma lista de mensagens proto de chave-valor do nome atual para o nome de saída desejado.

Campos
name_map[]

ObjectNameMapping

Os elementos do mapa de nome do objeto.

OracleDialect

A definição do dialeto para o Oracle.

Point

Um único ponto de dados em uma série temporal.

Campos
interval

TimeInterval

O intervalo de tempo a que o ponto de dados se aplica. Para métricas GAUGE, o horário de início não precisa ser fornecido, mas, se for fornecido, precisa ser igual ao horário de término. Para métricas DELTA, os horários de início e término precisam especificar um intervalo diferente de zero, com os pontos subsequentes especificando intervalos contíguos e não sobrepostos. Para métricas de CUMULATIVE, os horários de início e de término precisam especificar um intervalo diferente de zero, com os pontos subsequentes especificando o mesmo horário de início e horários de término crescentes, até que um evento redefina o valor cumulativo para zero e defina um novo horário de início para os pontos a seguir.
value

TypedValue

O valor do ponto de dados.

PostgresqlDialect

A definição do dialeto para o PostgreSQL.

PrestoDialect

A definição do dialeto para o Presto.

RedshiftDialect

A definição do dialeto para o Redshift.

ResourceErrorDetail

Apresenta detalhes dos erros e os recursos correspondentes.

Campos
resource_info

ResourceInfo

Obrigatório. Informações sobre o recurso em que o erro está localizado.
error_details[]

ErrorDetail

Obrigatório. Os detalhes do erro para o recurso.
error_count

int32

Obrigatório. Quantos erros existem no recurso no total. O truncamento pode ser indicado por ter um error_count maior que o tamanho de error_details.

SQLServerDialect

A definição do dialeto para o SQL Server.

SnowflakeDialect

A definição do dialeto para o Snowflake.

SourceEnv

Representa os valores padrão do ambiente de origem para a tradução.

Campos
default_database

string

O nome padrão do banco de dados para qualificar totalmente objetos SQL quando o nome do banco de dados está ausente.
schema_search_path[]

string

O caminho de pesquisa do esquema. Quando os objetos SQL não têm o nome do esquema, o mecanismo de tradução pesquisará essa lista para encontrar o valor.

SparkSQLDialect

A definição do dialeto para o SparkSQL.

StartMigrationWorkflowRequest

Uma solicitação para iniciar um fluxo de trabalho de migração criado anteriormente.

Campos
name

string

Obrigatório. O identificador exclusivo do fluxo de trabalho de migração. Exemplo: projects/123/locations/us/workflows/1234

TeradataDialect

A definição de dialeto para o Teradata.

Campos
mode

Mode

Qual modo de subdialeto do Teradata o usuário especifica.

Modo

As opções de subdialetos para o Teradata.

Enums
MODE_UNSPECIFIED Modo não especificado.
SQL Modo SQL do Teradata.
BTEQ Modo BTEQ (que inclui SQL).

TimeInterval

Um intervalo de tempo que se estende logo após um horário de início até um horário de término. Se o horário de início for igual ao de término, o intervalo vai representar um único ponto no tempo.

Campos
start_time

Timestamp

Opcional. O início do intervalo de tempo. O valor padrão para o horário de início é o horário de término. O horário de início não pode ser posterior ao horário de término.
end_time

Timestamp

Obrigatório. O fim do intervalo de tempo.

TimeSeries

O objeto de métricas para uma SubTask.

Campos
metric

string

Obrigatório. O nome da métrica.

Se o serviço ainda não souber a métrica, ela será criada automaticamente.
value_type

ValueType

Obrigatório. O tipo de valor da série temporal.
metric_kind

MetricKind

Opcional. O tipo de métrica da série temporal.

Se estiver presente, ele precisa ser igual ao tipo da métrica associada. Se o descritor da métrica associada precisar ser criado automaticamente, esse campo especificará o tipo de métrica do novo descritor e precisará ser GAUGE (o padrão) ou CUMULATIVE.
points[]

Point

Obrigatório. Os pontos de dados desta série temporal. Ao listar séries temporais, os pontos são retornados em ordem inversa.

Ao criar uma série temporal, esse campo precisa conter exatamente um ponto, e o tipo do ponto precisa ser igual ao tipo de valor da métrica associada. Se o descritor da métrica associada precisar ser criado automaticamente, o tipo de valor do descritor será determinado pelo tipo do ponto, que precisa ser BOOL, INT64, DOUBLE ou DISTRIBUTION.

TranslationConfigDetails

A configuração de tradução para capturar as configurações necessárias para uma tarefa de tradução e uma subtarefa.

Campos
source_dialect

Dialect

O dialeto dos arquivos de entrada.
target_dialect

Dialect

O dialeto de destino para o qual o mecanismo traduzirá a entrada.
source_env

SourceEnv

Os valores padrão do ambiente de origem para a tradução.
request_source

string

O indicador que mostra o iniciador da solicitação de tradução.
Campo de união source_location. O caminho escolhido em que a origem dos arquivos de entrada será encontrada. source_location pode ser apenas de um dos tipos a seguir:
gcs_source_path

string

O caminho do Cloud Storage para um diretório de arquivos a serem convertidos em uma tarefa.
Campo de união target_location. O caminho escolhido em que o destino dos arquivos de saída será encontrado. target_location pode ser apenas de um dos tipos a seguir:
gcs_target_path

string

O caminho do Cloud Storage em que os arquivos de entrada correspondentes serão gravados.
Campo de união output_name_mapping. O mapeamento de nomes completos de objetos SQL do estado atual para a saída desejada. output_name_mapping pode ser apenas de um dos tipos a seguir:
name_mapping_list

ObjectNameMappingList

O mapeamento de objetos para os nomes de saída desejados em formato de lista.

TypedValue

Um único valor fortemente digitado.

Campos
Campo de união value. O campo de valor digitado. value pode ser apenas de um dos tipos a seguir:
bool_value

bool

Um valor booleano: true ou false.
int64_value

int64

Um número inteiro de 64 bits. Seu intervalo é de aproximadamente +/-9.2x10^18.
double_value

double

Um número de ponto flutuante de dupla precisão de 64 bits. A magnitude é de aproximadamente +/-10^(+/-300) e tem 16 dígitos significativos de precisão.
string_value

string

Um valor de string de comprimento variável.
distribution_value

Distribution

Um valor de distribuição.

VerticaDialect

A definição do dialeto para o Vertica.