Package google.cloud.bigquery.migration.v2

Índice

MigrationService

Servicio para controlar las migraciones de EDW.

CreateMigrationWorkflow

rpc CreateMigrationWorkflow(CreateMigrationWorkflowRequest) returns (MigrationWorkflow)

Crea un flujo de trabajo de migración.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • bigquerymigration.workflows.create

Si deseas obtener más información, consulta la documentación de IAM.

DeleteMigrationWorkflow

rpc DeleteMigrationWorkflow(DeleteMigrationWorkflowRequest) returns (Empty)

Borra un flujo de trabajo de migración por nombre.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • bigquerymigration.workflows.delete

Si deseas obtener más información, consulta la documentación de IAM.

GetMigrationSubtask

rpc GetMigrationSubtask(GetMigrationSubtaskRequest) returns (MigrationSubtask)

Obtiene una subtarea de migración creada con anterioridad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • bigquerymigration.subtasks.get

Si deseas obtener más información, consulta la documentación de IAM.

GetMigrationWorkflow

rpc GetMigrationWorkflow(GetMigrationWorkflowRequest) returns (MigrationWorkflow)

Obtiene un flujo de trabajo de migración creado con anterioridad.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • bigquerymigration.workflows.get

Si deseas obtener más información, consulta la documentación de IAM.

ListMigrationSubtasks

rpc ListMigrationSubtasks(ListMigrationSubtasksRequest) returns (ListMigrationSubtasksResponse)

Enumera las subtareas de migración creadas antes.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • bigquerymigration.subtasks.list

Si deseas obtener más información, consulta la documentación de IAM.

ListMigrationWorkflows

rpc ListMigrationWorkflows(ListMigrationWorkflowsRequest) returns (ListMigrationWorkflowsResponse)

Enumera el flujo de trabajo de migración creado antes.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • bigquerymigration.workflows.list

Si deseas obtener más información, consulta la documentación de IAM.

StartMigrationWorkflow

rpc StartMigrationWorkflow(StartMigrationWorkflowRequest) returns (Empty)

Inicia un flujo de trabajo de migración creado con anterioridad. Es decir, el estado pasa de DRAFT a RUNNING. Esta acción es no-op si el estado ya está en estado RUNNING. Se indicará un error si el estado no es BORRADOR o EN EJECUCIÓN.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • bigquerymigration.workflows.update

Si deseas obtener más información, consulta la documentación de IAM.

AzureSynapseDialect

La definición del dialecto para Azure Synapse.

BigQueryDialect

Es la definición del dialecto para BigQuery.

CreateMigrationWorkflowRequest

Solicitud para crear un recurso de flujo de trabajo de migración.

Campos
parent

string

Obligatorio. Es el nombre del proyecto al que pertenece este flujo de trabajo de migración. Ejemplo: projects/foo/locations/bar

migration_workflow

MigrationWorkflow

Obligatorio. El flujo de trabajo de migración que se creará.

DeleteMigrationWorkflowRequest

Una solicitud para borrar un flujo de trabajo de migración creado con anterioridad.

Campos
name

string

Obligatorio. El identificador único del flujo de trabajo de migración. Ejemplo: projects/123/locations/us/workflows/1234

Dialecto

Las posibles opciones de dialecto para la traducción.

Campos
Campo de unión dialect_value. Las posibles opciones de dialecto que representa este mensaje. dialect_value puede ser solo uno de los siguientes:
bigquery_dialect

BigQueryDialect

El dialecto de BigQuery

hiveql_dialect

HiveQLDialect

El dialecto de HiveQL

redshift_dialect

RedshiftDialect

El dialecto de Redshift

teradata_dialect

TeradataDialect

El dialecto de Teradata

oracle_dialect

OracleDialect

El dialecto de Oracle

sparksql_dialect

SparkSQLDialect

El dialecto de SparkSQL

snowflake_dialect

SnowflakeDialect

El dialecto de Snowflake

netezza_dialect

NetezzaDialect

El dialecto de Netezza

azure_synapse_dialect

AzureSynapseDialect

El dialecto de Azure Synapse

vertica_dialect

VerticaDialect

El dialecto de Vertica

sql_server_dialect

SQLServerDialect

El dialecto de SQL Server

postgresql_dialect

PostgresqlDialect

El dialecto de Postgresql

presto_dialect

PrestoDialect

El dialecto de Presto

mysql_dialect

MySQLDialect

El dialecto de MySQL

ErrorDetail

Proporciona detalles de los errores, p.ej., problemas que se encontraron cuando se procesó una subtarea.

Campos
location

ErrorLocation

Opcional. La ubicación exacta dentro del recurso (si corresponde).

error_info

ErrorInfo

Obligatorio. Describe la causa del error con detalles estructurados.

ErrorLocation

Contiene información sobre dónde se encuentra el error.

Campos
line

int32

Opcional. Si corresponde, indica la línea donde ocurrió el error. Un valor cero significa que no hay información sobre la línea.

column

int32

Opcional. Si corresponde, indica la columna en la que se produjo el error. Un valor cero significa que no hay información sobre las columnas.

GetMigrationSubtaskRequest

Una solicitud para obtener una subtarea de migración creada con anterioridad.

Campos
name

string

Obligatorio. El identificador único de la subtarea de migración. Ejemplo: projects/123/locations/us/workflows/1234/subtasks/543

read_mask

FieldMask

Opcional. La lista de campos que se recuperarán.

GetMigrationWorkflowRequest

Una solicitud para obtener un flujo de trabajo de migración creado con anterioridad.

Campos
name

string

Obligatorio. El identificador único del flujo de trabajo de migración. Ejemplo: projects/123/locations/us/workflows/1234

read_mask

FieldMask

La lista de campos que se recuperarán.

HiveQLDialect

La definición del dialecto de HiveQL.

ListMigrationSubtasksRequest

Una solicitud para enumerar las subtareas de migración creadas con anterioridad.

Campos
parent

string

Obligatorio. La tarea de migración de las subtareas que se enumerarán. Ejemplo: projects/123/locations/us/workflows/1234

read_mask

FieldMask

Opcional. La lista de campos que se recuperarán.

page_size

int32

Opcional. La cantidad máxima de tareas de migración que se devolverán. El servicio puede devolver menos que este número.

page_token

string

Opcional. Un token de página, recibido desde una llamada ListMigrationSubtasks anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListMigrationSubtasks deben coincidir con la llamada que proporcionó el token de la página.

filter

string

Opcional. El filtro que se aplicará. Se puede usar para obtener las subtareas de una tarea específica en un flujo de trabajo, p.ej., migration_task = "ab012", en el que "ab012" es el ID de la tarea (no el nombre en el mapa con nombre).

ListMigrationSubtasksResponse

Objeto de respuesta para una llamada a ListMigrationSubtasks.

Campos
migration_subtasks[]

MigrationSubtask

Las subtareas de migración para la tarea especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListMigrationWorkflowsRequest

Una solicitud para enumerar los flujos de trabajo de migración creados antes.

Campos
parent

string

Obligatorio. El proyecto y la ubicación de los flujos de trabajo de migración que se enumerarán. Ejemplo: projects/123/locations/us

read_mask

FieldMask

La lista de campos que se recuperarán.

page_size

int32

La cantidad máxima de flujos de trabajo de migración que se devolverán. El servicio puede devolver menos que este número.

page_token

string

Un token de página, recibido desde una llamada ListMigrationWorkflows anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListMigrationWorkflows deben coincidir con la llamada que proporcionó el token de la página.

ListMigrationWorkflowsResponseS

Objeto de respuesta para una llamada a ListMigrationWorkflows.

Campos
migration_workflows[]

MigrationWorkflow

Los flujos de trabajo de migración para la ubicación o el proyecto especificados.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

MigrationSubtask

Una subtarea para una migración que contiene detalles sobre la configuración de la subtarea. El contenido de los detalles no debe importar al usuario final, pero es un contrato entre el creador de la subtarea y el trabajador de la subtarea.

Campos
name

string

Solo salida. Inmutable. El nombre del recurso de la subtarea de migración. El ID lo genera el servidor.

Ejemplo: projects/123/locations/us/workflows/345/subtasks/678

task_id

string

El ID único de la tarea a la que pertenece esta subtarea.

type

string

Es el tipo de subtarea. El servicio de migración no verifica si se trata de un tipo conocido. Depende del creador de tareas (es decir, el organizador o el trabajador) asegurarse de que solo cree subtareas para las que haya trabajadores compatibles que consulten subtareas.

state

State

Solo salida. El estado actual de la subtarea.

processing_error

ErrorInfo

Solo salida. Una explicación que se puede propagar cuando la tarea está en estado FAILED.

resource_error_details[]

ResourceErrorDetail

Solo salida. Proporciona detalles sobre los errores y problemas detectados mientras se procesa la subtarea. La presencia de detalles de errores no significa que la subtarea falló.

resource_error_count

int32

La cantidad o los recursos con errores. Nota: Esta no es la cantidad total de errores, ya que cada recurso puede tener más de un error. Esto se usa para indicar el truncamiento con un resource_error_count que es mayor que el tamaño de resource_error_details.

create_time

Timestamp

Hora en la que se creó la subtarea.

last_update_time

Timestamp

Hora en la que se actualizó la subtarea por última vez.

metrics[]

TimeSeries

Las métricas de la subtarea.

Estado

Estados posibles de una subtarea de migración.

Enums
STATE_UNSPECIFIED El estado no se especifica.
ACTIVE La subtarea está lista, es decir, está lista para ejecutarse.
RUNNING La subtarea está en ejecución, es decir, se asigna a un trabajador para que la ejecute.
SUCCEEDED La subtarea finalizó correctamente.
FAILED La subtarea no se completó correctamente.
PAUSED La subtarea está detenida, es decir, no se programará. Si ya se asignó, es posible que finalice, pero no se otorgarán renovaciones de asignaciones nuevas.
PENDING_DEPENDENCY La subtarea tiene una dependencia pendiente. Se programará una vez que finalicen sus dependencias.

MigrationTask

Una sola tarea para una migración que tiene detalles sobre la configuración de la tarea.

Campos
id

string

Solo salida. Inmutable. El identificador único de la tarea de migración. El ID lo genera el servidor.

type

string

El tipo de tarea. Debe ser uno de los tipos de tareas compatibles: 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

Solo salida. El estado actual de la tarea.

processing_error

ErrorInfo

Solo salida. Una explicación que se puede propagar cuando la tarea está en estado FAILED.

create_time

Timestamp

Hora en la que se creó la tarea.

last_update_time

Timestamp

Hora a la que se actualizó la tarea por última vez.

Campo de unión task_details. Los detalles de la tarea. task_details puede ser solo uno de los siguientes:
translation_config_details

TranslationConfigDetails

Configuración de tareas para la traducción de SQL por lotes/sin conexión de CW.

Estado

Estados posibles de una tarea de migración.

Enums
STATE_UNSPECIFIED El estado no se especifica.
PENDING La tarea está esperando la organización.
ORCHESTRATING La tarea se asigna a un organizador.
RUNNING La tarea está en ejecución, es decir, sus subtareas están listas para ejecutarse.
PAUSED Esta tarea está pausada. Las subtareas asignadas pueden continuar, pero no se programarán subtareas nuevas.
SUCCEEDED La tarea finalizó correctamente.
FAILED La tarea no se completó correctamente.

MigrationWorkflow

Un flujo de trabajo de migración que especifica qué se debe hacer para una migración de EDW.

Campos
name

string

Solo salida. Inmutable. El identificador único del flujo de trabajo de migración. El ID lo genera el servidor.

Ejemplo: projects/123/locations/us/workflows/345

display_name

string

El nombre visible del flujo de trabajo. Se puede configurar para darle a un flujo de trabajo un nombre descriptivo. No se garantiza ni se aplica la exclusividad.

tasks

map<string, MigrationTask>

Las tareas de un flujo de trabajo en un mapa con nombre. El nombre (es decir, la clave) no tiene sentido y es solo una forma conveniente de abordar una tarea específica en un flujo de trabajo.

state

State

Solo salida. Ese estado del flujo de trabajo.

create_time

Timestamp

Hora en la que se creó el flujo de trabajo.

last_update_time

Timestamp

Hora a la que se actualizó el flujo de trabajo por última vez.

Estado

Estados posibles del flujo de trabajo de migración.

Enums
STATE_UNSPECIFIED El estado del flujo de trabajo no está especificado.
DRAFT El flujo de trabajo está en estado de borrador, es decir, las tareas aún no son aptas para ejecutarse.
RUNNING El flujo de trabajo está en ejecución (es decir, las tareas son aptas para ejecutarse).
PAUSED El flujo de trabajo está pausado. Es posible que las tareas actualmente en curso continúen, pero no se programarán más tareas.
COMPLETED El flujo de trabajo está completo. No debería haber ninguna tarea en un estado no terminal, pero si tiene una (p.ej., finalización forzada), no se programarán.

MySQLDialect

La definición del dialecto para MySQL.

NameMappingKey

Los componentes potenciales de una asignación de nombre completo que se asignarán durante la traducción en el almacén de datos de origen.

Campos
type

Type

El tipo de objeto que se asigna.

database

string

El nombre de la base de datos (ID del proyecto de BigQuery equivalente en el almacén de datos de origen).

schema

string

El nombre del esquema (conjunto de datos de BigQuery equivalente en el almacén de datos de origen).

relation

string

El nombre de la relación (tabla de BigQuery o vista equivalente en el almacén de datos de origen).

attribute

string

El nombre del atributo (equivalente a la columna de BigQuery en el almacén de datos de origen).

Tipo

El tipo de objeto que se asigna.

Enums
TYPE_UNSPECIFIED Tipo de asignación de nombre no especificado.
DATABASE El objeto que se asigna es una base de datos.
SCHEMA El objeto que se asigna es un esquema.
RELATION El objeto que se asigna es una relación.
ATTRIBUTE El objeto que se asigna es un atributo.
RELATION_ALIAS El objeto que se asigna es un alias de relación.
ATTRIBUTE_ALIAS El objeto que se asigna es un alias de atributo.
FUNCTION El objeto que se asigna es una función.

NameMappingValue

Los posibles componentes de una asignación de nombre completo que se asignarán durante la traducción en el almacén de datos de destino.

Campos
database

string

El nombre de la base de datos (ID del proyecto de BigQuery equivalente en el almacén de datos de destino).

schema

string

El nombre del esquema (conjunto de datos de BigQuery equivalente en el almacén de datos de destino).

relation

string

El nombre de la relación (tabla de BigQuery o vista equivalente en el almacén de datos de destino).

attribute

string

El nombre del atributo (equivalente a la columna de BigQuery en el almacén de datos de destino).

NetezzaDialect

Es la definición del dialecto para Netezza.

ObjectNameMapping

Representa un par clave-valor de NameMappingKey a NameMappingValue para representar la asignación de nombres de SQL del valor de entrada al resultado deseado.

Campos
source

NameMappingKey

El nombre del objeto en la fuente que se asigna.

target

NameMappingValue

El nombre de destino deseado del objeto que se asigna.

ObjectNameMappingList

Representa un mapa de asignaciones de nombres mediante una lista de mensajes proto de clave-valor de nombre existente al nombre de salida deseado.

Campos
name_map[]

ObjectNameMapping

Los elementos del mapa de nombres del objeto.

OracleDialect

Es la definición del dialecto para Oracle.

Punto

Un único dato en una serie temporal.

Campos
interval

TimeInterval

El intervalo al que se aplican los datos. Para las métricas GAUGE, no es necesario proporcionar la hora de inicio, pero, si se proporciona, debe ser igual a la hora de finalización. Para las métricas DELTA, la hora de inicio y finalización debe especificar un intervalo distinto de cero, y los puntos posteriores especifican intervalos contiguos y no superpuestos. Para las métricas de CUMULATIVE, la hora de inicio y finalización deben especificar un intervalo distinto de cero, en el que los puntos posteriores especifiquen la misma hora de inicio y mayores horas de finalización, hasta que un evento restablezca el valor acumulativo en cero y establezca una nueva hora de inicio para el siguientes puntos.

value

TypedValue

El valor del dato.

PostgresqlDialect

La definición del dialecto para Postgresql.

PrestoDialect

Es la definición del dialecto de Presto.

RedshiftDialect

La definición del dialecto para Redshift.

ResourceErrorDetail

Proporciona detalles de los errores y los recursos correspondientes.

Campos
resource_info

ResourceInfo

Obligatorio. Información sobre el recurso donde se encuentra el error.

error_details[]

ErrorDetail

Obligatorio. Los detalles del error para el recurso.

error_count

int32

Obligatorio. Cantidad de errores en total para el recurso. El truncamiento se puede indicar con un error_count mayor que el tamaño de error_details.

SQLServerDialect

Es la definición del dialecto para SQL Server.

SnowflakeDialect

La definición del dialecto para Snowflake.

SourceEnv

Representa los valores del entorno de origen predeterminados para la traducción.

Campos
default_database

string

El nombre de la base de datos predeterminada para calificar completamente los objetos SQL cuando falta el nombre de su base de datos.

schema_search_path[]

string

La ruta de búsqueda del esquema. Cuando a los objetos SQL les falta el nombre de esquema, el motor de traducción buscará en esta lista para encontrar el valor.

SparkSQLDialect

La definición del dialecto para SparkSQL.

StartMigrationWorkflowRequest

Una solicitud para iniciar un flujo de trabajo de migración creado con anterioridad.

Campos
name

string

Obligatorio. El identificador único del flujo de trabajo de migración. Ejemplo: projects/123/locations/us/workflows/1234

TeradataDialect

Es la definición del dialecto para Teradata.

Campos
mode

Mode

El modo de subdialecto de Teradata que especifica el usuario.

Modo

Las opciones del subdialecto para Teradata.

Enums
MODE_UNSPECIFIED Modo sin especificar.
SQL Modo SQL de Teradata.
BTEQ Modo BTEQ (que incluye SQL).

TimeInterval

Un intervalo que se extiende justo después de una hora de inicio hasta una hora de finalización. Si la hora de inicio es la misma que la de finalización, el intervalo representa un solo punto en el tiempo.

Campos
start_time

Timestamp

Opcional. El comienzo del intervalo de tiempo. El valor predeterminado para la hora de inicio es la hora de finalización. La hora de inicio no debe ser posterior a la de finalización.

end_time

Timestamp

Obligatorio. El final del intervalo de tiempo.

TimeSeries

El objeto de métricas para una subtarea.

Campos
metric

string

Obligatorio. Es el nombre de la métrica.

Si el servicio aún no conoce la métrica, se creará de forma automática.

value_type

ValueType

Obligatorio. El tipo de valor de la serie temporal.

metric_kind

MetricKind

Opcional. El tipo de métrica de la serie temporal.

Si está presente, debe ser el mismo que el tipo de métrica de la métrica asociada. Si el descriptor de la métrica asociada se debe crear automáticamente, este campo especifica el tipo de métrica del descriptor nuevo y debe ser GAUGE (predeterminado) o CUMULATIVE.

points[]

Point

Obligatorio. Los datos de esta serie temporal. Cuando se enumeran series temporales, los puntos se muestran en orden de tiempo inverso.

Cuando creas una serie temporal, este campo debe contener exactamente un punto, y el tipo de punto debe ser el mismo que el tipo de valor de la métrica asociada. Si el descriptor de la métrica asociada debe crearse automáticamente, el tipo de valor del descriptor se determina por el tipo del punto, que debe ser BOOL, INT64, DOUBLE o DISTRIBUTION.

TranslationConfigDetails

La configuración de traducción para capturar la configuración necesaria para una tarea de traducción y una subtarea.

Campos
source_dialect

Dialect

Es el dialecto de los archivos de entrada.

target_dialect

Dialect

El dialecto de destino al que el motor traduce la entrada.

source_env

SourceEnv

Los valores del entorno de origen predeterminados para la traducción.

request_source

string

El indicador para mostrar el iniciador de la solicitud de traducción.

Campo de unión source_location. La ruta de acceso elegida donde se encontrará el origen de los archivos de entrada. source_location puede ser solo uno de los siguientes:
gcs_source_path

string

La ruta de Cloud Storage para un directorio de archivos que se traducirán en una tarea.

Campo de unión target_location. La ruta de acceso elegida donde se encontrará el destino de los archivos de salida. target_location puede ser solo uno de los siguientes:
gcs_target_path

string

La ruta de Cloud Storage en la que se vuelven a escribir los archivos de entrada correspondientes.

Campo de unión output_name_mapping. La asignación de nombres de objetos SQL completos de su estado actual al resultado deseado. output_name_mapping puede ser solo uno de los siguientes:
name_mapping_list

ObjectNameMappingList

La asignación de objetos a los nombres de salida deseados en forma de lista.

TypedValue

Un valor único de tipo fuerte.

Campos
Campo de unión value. El campo de valor escrito. value puede ser solo uno de los siguientes:
bool_value

bool

Un valor booleano: true o false.

int64_value

int64

Un número entero de 64 bits. Su rango es de aproximadamente +/-9.2x10^18.

double_value

double

Un número de punto flotante de doble precisión de 64 bits. Su magnitud es aproximadamente +/-10^(+/-300) y tiene 16 dígitos significativos de precisión.

string_value

string

Es un valor de cadena de longitud variable.

distribution_value

Distribution

Un valor de distribución.

VerticaDialect

Es la definición del dialecto para Vertica.