Package google.cloud.bigquery.migration.v2

Index

• MigrationService (interface)
• AzureSynapseDialect (message)
• BigQueryDialect (message)
• CreateMigrationWorkflowRequest (message)
• DeleteMigrationWorkflowRequest (message)
• Dialect (message)
• ErrorDetail (message)
• ErrorLocation (message)
• GetMigrationSubtaskRequest (message)
• GetMigrationWorkflowRequest (message)
• HiveQLDialect (message)
• ListMigrationSubtasksRequest (message)
• ListMigrationSubtasksResponse (message)
• ListMigrationWorkflowsRequest (message)
• ListMigrationWorkflowsResponse (message)
• MigrationSubtask (message)
• MigrationSubtask.State (enum)
• MigrationTask (message)
• MigrationTask.State (enum)
• MigrationWorkflow (message)
• MigrationWorkflow.State (enum)
• MySQLDialect (message)
• NameMappingKey (message)
• NameMappingKey.Type (enum)
• NameMappingValue (message)
• NetezzaDialect (message)
• ObjectNameMapping (message)
• ObjectNameMappingList (message)
• OracleDialect (message)
• Point (message)
• PostgresqlDialect (message)
• PrestoDialect (message)
• RedshiftDialect (message)
• ResourceErrorDetail (message)
• SQLServerDialect (message)
• SnowflakeDialect (message)
• SourceEnv (message)
• SparkSQLDialect (message)
• StartMigrationWorkflowRequest (message)
• TeradataDialect (message)
• TeradataDialect.Mode (enum)
• TimeInterval (message)
• TimeSeries (message)
• TranslationConfigDetails (message)
• TypedValue (message)
• VerticaDialect (message)

MigrationService

Service to handle EDW migrations.

CreateMigrationWorkflow

rpc CreateMigrationWorkflow(CreateMigrationWorkflowRequest) returns (MigrationWorkflow) Creates a migration workflow. Authorization Scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: bigquerymigration.workflows.create For more information, see the IAM documentation.

DeleteMigrationWorkflow

rpc DeleteMigrationWorkflow(DeleteMigrationWorkflowRequest) returns (Empty) Deletes a migration workflow by name. Authorization Scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: bigquerymigration.workflows.delete For more information, see the IAM documentation.

GetMigrationSubtask

rpc GetMigrationSubtask(GetMigrationSubtaskRequest) returns (MigrationSubtask) Gets a previously created migration subtask. Authorization Scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: bigquerymigration.subtasks.get For more information, see the IAM documentation.

GetMigrationWorkflow

rpc GetMigrationWorkflow(GetMigrationWorkflowRequest) returns (MigrationWorkflow) Gets a previously created migration workflow. Authorization Scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: bigquerymigration.workflows.get For more information, see the IAM documentation.

ListMigrationSubtasks

rpc ListMigrationSubtasks(ListMigrationSubtasksRequest) returns (ListMigrationSubtasksResponse) Lists previously created migration subtasks. Authorization Scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: bigquerymigration.subtasks.list For more information, see the IAM documentation.

ListMigrationWorkflows

rpc ListMigrationWorkflows(ListMigrationWorkflowsRequest) returns (ListMigrationWorkflowsResponse) Lists previously created migration workflow. Authorization Scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: bigquerymigration.workflows.list For more information, see the IAM documentation.

StartMigrationWorkflow

rpc StartMigrationWorkflow(StartMigrationWorkflowRequest) returns (Empty) Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING. Authorization Scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: bigquerymigration.workflows.update For more information, see the IAM documentation.

SqlTranslationService

Provides other SQL dialects to GoogleSQL translation operations.

TranslateQuery

rpc TranslateQuery(TranslateQueryRequest) returns (TranslateQueryResponse) Translates input queries from source dialects to GoogleSQL. Authorization Scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: bigquerymigration.translation.translate For more information, see the IAM documentation.

AzureSynapseDialect

The dialect definition for Azure Synapse.

BigQueryDialect

The dialect definition for BigQuery.

CreateMigrationWorkflowRequest

Request to create a migration workflow resource.

Fields
parent	string Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar
migration_workflow	MigrationWorkflow Required. The migration workflow to create.

DeleteMigrationWorkflowRequest

A request to delete a previously created migration workflow.

Fields
name	string Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

Dialect

The possible dialect options for translation.

Fields
Union field dialect_value. The possible dialect options that this message represents. dialect_value can be only one of the following:
bigquery_dialect	BigQueryDialect The BigQuery dialect
hiveql_dialect	HiveQLDialect The HiveQL dialect
redshift_dialect	RedshiftDialect The Redshift dialect
teradata_dialect	TeradataDialect The Teradata dialect
oracle_dialect	OracleDialect The Oracle dialect
sparksql_dialect	SparkSQLDialect The SparkSQL dialect
snowflake_dialect	SnowflakeDialect The Snowflake dialect
netezza_dialect	NetezzaDialect The Netezza dialect
azure_synapse_dialect	AzureSynapseDialect The Azure Synapse dialect
vertica_dialect	VerticaDialect The Vertica dialect
sql_server_dialect	SQLServerDialect The SQL Server dialect
postgresql_dialect	PostgresqlDialect The Postgresql dialect
presto_dialect	PrestoDialect The Presto dialect
mysql_dialect	MySQLDialect The MySQL dialect

ErrorDetail

Provides details for errors, e.g. issues that where encountered when processing a subtask.

Fields
location	ErrorLocation Optional. The exact location within the resource (if applicable).
error_info	ErrorInfo Required. Describes the cause of the error with structured detail.

ErrorLocation

Holds information about where the error is located.

Fields
line	int32 Optional. If applicable, denotes the line where the error occurred. A zero value means that there is no line information.
column	int32 Optional. If applicable, denotes the column where the error occurred. A zero value means that there is no columns information.

GetMigrationSubtaskRequest

A request to get a previously created migration subtasks.

Fields
name	string Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543
read_mask	FieldMask Optional. The list of fields to be retrieved.

GetMigrationWorkflowRequest

A request to get a previously created migration workflow.

Fields
name	string Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234
read_mask	FieldMask The list of fields to be retrieved.

HiveQLDialect

The dialect definition for HiveQL.

ListMigrationSubtasksRequest

A request to list previously created migration subtasks.

Fields
parent	string Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234
read_mask	FieldMask Optional. The list of fields to be retrieved.
page_size	int32 Optional. The maximum number of migration tasks to return. The service may return fewer than this number.
page_token	string Optional. A page token, received from previous ListMigrationSubtasks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMigrationSubtasks must match the call that provided the page token.
filter	string Optional. The filter to apply. This can be used to get the subtasks of a specific tasks in a workflow, e.g. migration_task = "ab012" where "ab012" is the task ID (not the name in the named map).

ListMigrationSubtasksResponse

Response object for a ListMigrationSubtasks call.

Fields
migration_subtasks[]	MigrationSubtask The migration subtasks for the specified task.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListMigrationWorkflowsRequest

A request to list previously created migration workflows.

Fields
parent	string Required. The project and location of the migration workflows to list. Example: projects/123/locations/us
read_mask	FieldMask The list of fields to be retrieved.
page_size	int32 The maximum number of migration workflows to return. The service may return fewer than this number.
page_token	string A page token, received from previous ListMigrationWorkflows call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMigrationWorkflows must match the call that provided the page token.

ListMigrationWorkflowsResponse

Response object for a ListMigrationWorkflows call.

Fields
migration_workflows[]	MigrationWorkflow The migration workflows for the specified project / location.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

MigrationSubtask

A subtask for a migration which carries details about the configuration of the subtask. The content of the details should not matter to the end user, but is a contract between the subtask creator and subtask worker.

Fields
name	string Output only. Immutable. The resource name for the migration subtask. The ID is server-generated. Example: projects/123/locations/us/workflows/345/subtasks/678
task_id	string The unique ID of the task to which this subtask belongs.
type	string The type of the Subtask. The migration service does not check whether this is a known type. It is up to the task creator (i.e. orchestrator or worker) to ensure it only creates subtasks for which there are compatible workers polling for Subtasks.
state	State Output only. The current state of the subtask.
processing_error	ErrorInfo Output only. An explanation that may be populated when the task is in FAILED state.
resource_error_details[]	ResourceErrorDetail Output only. Provides details to errors and issues encountered while processing the subtask. Presence of error details does not mean that the subtask failed.
resource_error_count	int32 The number or resources with errors. Note: This is not the total number of errors as each resource can have more than one error. This is used to indicate truncation by having a resource_error_count that is higher than the size of resource_error_details.
create_time	Timestamp Time when the subtask was created.
last_update_time	Timestamp Time when the subtask was last updated.
metrics[]	TimeSeries The metrics for the subtask.

State

Possible states of a migration subtask.

Enums
STATE_UNSPECIFIED	The state is unspecified.
ACTIVE	The subtask is ready, i.e. it is ready for execution.
RUNNING	The subtask is running, i.e. it is assigned to a worker for execution.
SUCCEEDED	The subtask finished successfully.
FAILED	The subtask finished unsuccessfully.
PAUSED	The subtask is paused, i.e., it will not be scheduled. If it was already assigned,it might still finish but no new lease renewals will be granted.

MigrationTask

A single task for a migration which has details about the configuration of the task.

Fields
id	string Output only. Immutable. The unique identifier for the migration task. The ID is server-generated.
type	string The type of the task. This must be one of the supported task types: 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 Output only. The current state of the task.
processing_error	ErrorInfo Output only. An explanation that may be populated when the task is in FAILED state.
create_time	Timestamp Time when the task was created.
last_update_time	Timestamp Time when the task was last updated.
translation_config_details	TranslationConfigDetails Task configuration for CW Batch/Offline SQL Translation.

State

Possible states of a migration task.

Enums
STATE_UNSPECIFIED	The state is unspecified.
PENDING	The task is waiting for orchestration.
ORCHESTRATING	The task is assigned to an orchestrator.
RUNNING	The task is running, i.e. its subtasks are ready for execution.
PAUSED	Tha task is paused. Assigned subtasks can continue, but no new subtasks will be scheduled.
SUCCEEDED	The task finished successfully.
FAILED	The task finished unsuccessfully.

MigrationWorkflow

A migration workflow which specifies what needs to be done for an EDW migration.

Fields
name	string Output only. Immutable. The unique identifier for the migration workflow. The ID is server-generated. Example: projects/123/locations/us/workflows/345
display_name	string The display name of the workflow. This can be set to give a workflow a descriptive name. There is no guarantee or enforcement of uniqueness.
tasks	map<string, MigrationTask> The tasks in a workflow in a named map. The name (i.e. key) has no meaning and is merely a convenient way to address a specific task in a workflow.
state	State Output only. That status of the workflow.
create_time	Timestamp Time when the workflow was created.
last_update_time	Timestamp Time when the workflow was last updated.

State

Possible migration workflow states.

Enums
STATE_UNSPECIFIED	Workflow state is unspecified.
DRAFT	Workflow is in draft status, i.e. tasks are not yet eligible for execution.
RUNNING	Workflow is running (i.e. tasks are eligible for execution).
PAUSED	Workflow is paused. Tasks currently in progress may continue, but no further tasks will be scheduled.
COMPLETED	Workflow is complete. There should not be any task in a non-terminal state, but if they are (e.g. forced termination), they will not be scheduled.

MySQLDialect

The dialect definition for MySQL.

NameMappingKey

The potential components of a full name mapping that will be mapped during translation in the source data warehouse.

Fields
type	Type The type of object that is being mapped.
database	string The database name (BigQuery project ID equivalent in the source data warehouse).
schema	string The schema name (BigQuery dataset equivalent in the source data warehouse).
relation	string The relation name (BigQuery table or view equivalent in the source data warehouse).
attribute	string The attribute name (BigQuery column equivalent in the source data warehouse).

Type

The type of the object that is being mapped.

Enums
TYPE_UNSPECIFIED	Unspecified name mapping type.
DATABASE	The object being mapped is a database.
SCHEMA	The object being mapped is a schema.
RELATION	The object being mapped is a relation.
ATTRIBUTE	The object being mapped is an attribute.
RELATION_ALIAS	The object being mapped is a relation alias.
ATTRIBUTE_ALIAS	The object being mapped is a an attribute alias.
FUNCTION	The object being mapped is a function.

NameMappingValue

The potential components of a full name mapping that will be mapped during translation in the target data warehouse.

Fields
database	string The database name (BigQuery project ID equivalent in the target data warehouse).
schema	string The schema name (BigQuery dataset equivalent in the target data warehouse).
relation	string The relation name (BigQuery table or view equivalent in the target data warehouse).
attribute	string The attribute name (BigQuery column equivalent in the target data warehouse).

NetezzaDialect

The dialect definition for Netezza.

ObjectNameMapping

Represents a key-value pair of NameMappingKey to NameMappingValue to represent the mapping of SQL names from the input value to desired output.

<

Fields
source	NameMappingKey The name of the object in source that is being mapped.
target