Package com.google.cloud.bigquery.migration.v2 (0.23.0)

A client to BigQuery Migration API

The interfaces provided are listed below, along with usage samples.

MigrationServiceClient

Service Description: Service to handle EDW migrations.

Sample for MigrationServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   MigrationWorkflow migrationWorkflow = MigrationWorkflow.newBuilder().build();
   MigrationWorkflow response =
       migrationServiceClient.createMigrationWorkflow(parent, migrationWorkflow);
 }
 

Classes

AzureSynapseDialect

The dialect definition for Azure Synapse.

Protobuf type google.cloud.bigquery.migration.v2.AzureSynapseDialect

AzureSynapseDialect.Builder

The dialect definition for Azure Synapse.

Protobuf type google.cloud.bigquery.migration.v2.AzureSynapseDialect

BigQueryDialect

The dialect definition for BigQuery.

Protobuf type google.cloud.bigquery.migration.v2.BigQueryDialect

BigQueryDialect.Builder

The dialect definition for BigQuery.

Protobuf type google.cloud.bigquery.migration.v2.BigQueryDialect

CreateMigrationWorkflowRequest

Request to create a migration workflow resource.

Protobuf type google.cloud.bigquery.migration.v2.CreateMigrationWorkflowRequest

CreateMigrationWorkflowRequest.Builder

Request to create a migration workflow resource.

Protobuf type google.cloud.bigquery.migration.v2.CreateMigrationWorkflowRequest

DeleteMigrationWorkflowRequest

A request to delete a previously created migration workflow.

Protobuf type google.cloud.bigquery.migration.v2.DeleteMigrationWorkflowRequest

DeleteMigrationWorkflowRequest.Builder

A request to delete a previously created migration workflow.

Protobuf type google.cloud.bigquery.migration.v2.DeleteMigrationWorkflowRequest

Dialect

The possible dialect options for translation.

Protobuf type google.cloud.bigquery.migration.v2.Dialect

Dialect.Builder

The possible dialect options for translation.

Protobuf type google.cloud.bigquery.migration.v2.Dialect

ErrorDetail

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

Protobuf type google.cloud.bigquery.migration.v2.ErrorDetail

ErrorDetail.Builder

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

Protobuf type google.cloud.bigquery.migration.v2.ErrorDetail

ErrorLocation

Holds information about where the error is located.

Protobuf type google.cloud.bigquery.migration.v2.ErrorLocation

ErrorLocation.Builder

Holds information about where the error is located.

Protobuf type google.cloud.bigquery.migration.v2.ErrorLocation

GetMigrationSubtaskRequest

A request to get a previously created migration subtasks.

Protobuf type google.cloud.bigquery.migration.v2.GetMigrationSubtaskRequest

GetMigrationSubtaskRequest.Builder

A request to get a previously created migration subtasks.

Protobuf type google.cloud.bigquery.migration.v2.GetMigrationSubtaskRequest

GetMigrationWorkflowRequest

A request to get a previously created migration workflow.

Protobuf type google.cloud.bigquery.migration.v2.GetMigrationWorkflowRequest

GetMigrationWorkflowRequest.Builder

A request to get a previously created migration workflow.

Protobuf type google.cloud.bigquery.migration.v2.GetMigrationWorkflowRequest

HiveQLDialect

The dialect definition for HiveQL.

Protobuf type google.cloud.bigquery.migration.v2.HiveQLDialect

HiveQLDialect.Builder

The dialect definition for HiveQL.

Protobuf type google.cloud.bigquery.migration.v2.HiveQLDialect

ListMigrationSubtasksRequest

A request to list previously created migration subtasks.

Protobuf type google.cloud.bigquery.migration.v2.ListMigrationSubtasksRequest

ListMigrationSubtasksRequest.Builder

A request to list previously created migration subtasks.

Protobuf type google.cloud.bigquery.migration.v2.ListMigrationSubtasksRequest

ListMigrationSubtasksResponse

Response object for a ListMigrationSubtasks call.

Protobuf type google.cloud.bigquery.migration.v2.ListMigrationSubtasksResponse

ListMigrationSubtasksResponse.Builder

Response object for a ListMigrationSubtasks call.

Protobuf type google.cloud.bigquery.migration.v2.ListMigrationSubtasksResponse

ListMigrationWorkflowsRequest

A request to list previously created migration workflows.

Protobuf type google.cloud.bigquery.migration.v2.ListMigrationWorkflowsRequest

ListMigrationWorkflowsRequest.Builder

A request to list previously created migration workflows.

Protobuf type google.cloud.bigquery.migration.v2.ListMigrationWorkflowsRequest

ListMigrationWorkflowsResponse

Response object for a ListMigrationWorkflows call.

Protobuf type google.cloud.bigquery.migration.v2.ListMigrationWorkflowsResponse

ListMigrationWorkflowsResponse.Builder

Response object for a ListMigrationWorkflows call.

Protobuf type google.cloud.bigquery.migration.v2.ListMigrationWorkflowsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

MigrationEntitiesProto

MigrationErrorDetailsProto

MigrationMetricsProto

MigrationServiceClient

Service Description: Service to handle EDW migrations.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   MigrationWorkflow migrationWorkflow = MigrationWorkflow.newBuilder().build();
   MigrationWorkflow response =
       migrationServiceClient.createMigrationWorkflow(parent, migrationWorkflow);
 }
 

Note: close() needs to be called on the MigrationServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of MigrationServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MigrationServiceClient migrationServiceClient =
     MigrationServiceClient.create(migrationServiceSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 MigrationServiceClient migrationServiceClient =
     MigrationServiceClient.create(migrationServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newHttpJsonBuilder().build();
 MigrationServiceClient migrationServiceClient =
     MigrationServiceClient.create(migrationServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

MigrationServiceClient.ListMigrationSubtasksFixedSizeCollection

MigrationServiceClient.ListMigrationSubtasksPage

MigrationServiceClient.ListMigrationSubtasksPagedResponse

MigrationServiceClient.ListMigrationWorkflowsFixedSizeCollection

MigrationServiceClient.ListMigrationWorkflowsPage

MigrationServiceClient.ListMigrationWorkflowsPagedResponse

MigrationServiceGrpc

Service to handle EDW migrations.

MigrationServiceGrpc.MigrationServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service MigrationService.

Service to handle EDW migrations.

MigrationServiceGrpc.MigrationServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service MigrationService.

Service to handle EDW migrations.

MigrationServiceGrpc.MigrationServiceImplBase

Base class for the server implementation of the service MigrationService.

Service to handle EDW migrations.

MigrationServiceGrpc.MigrationServiceStub

A stub to allow clients to do asynchronous rpc calls to service MigrationService.

Service to handle EDW migrations.

MigrationServiceProto

MigrationServiceSettings

Settings class to configure an instance of MigrationServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (bigquerymigration.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createMigrationWorkflow to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 MigrationServiceSettings.Builder migrationServiceSettingsBuilder =
     MigrationServiceSettings.newBuilder();
 migrationServiceSettingsBuilder
     .createMigrationWorkflowSettings()
     .setRetrySettings(
         migrationServiceSettingsBuilder
             .createMigrationWorkflowSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MigrationServiceSettings migrationServiceSettings = migrationServiceSettingsBuilder.build();
 

MigrationServiceSettings.Builder

Builder for MigrationServiceSettings.

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.

Protobuf type google.cloud.bigquery.migration.v2.MigrationSubtask

MigrationSubtask.Builder

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.

Protobuf type google.cloud.bigquery.migration.v2.MigrationSubtask

MigrationSubtaskName

MigrationSubtaskName.Builder

Builder for projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}.

MigrationTask

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

Protobuf type google.cloud.bigquery.migration.v2.MigrationTask

MigrationTask.Builder

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

Protobuf type google.cloud.bigquery.migration.v2.MigrationTask

MigrationWorkflow

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

Protobuf type google.cloud.bigquery.migration.v2.MigrationWorkflow

MigrationWorkflow.Builder

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

Protobuf type google.cloud.bigquery.migration.v2.MigrationWorkflow

MigrationWorkflowName

MigrationWorkflowName.Builder

Builder for projects/{project}/locations/{location}/workflows/{workflow}.

MySQLDialect

The dialect definition for MySQL.

Protobuf type google.cloud.bigquery.migration.v2.MySQLDialect

MySQLDialect.Builder

The dialect definition for MySQL.

Protobuf type google.cloud.bigquery.migration.v2.MySQLDialect

NameMappingKey

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

Protobuf type google.cloud.bigquery.migration.v2.NameMappingKey

NameMappingKey.Builder

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

Protobuf type google.cloud.bigquery.migration.v2.NameMappingKey

NameMappingValue

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

Protobuf type google.cloud.bigquery.migration.v2.NameMappingValue

NameMappingValue.Builder

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

Protobuf type google.cloud.bigquery.migration.v2.NameMappingValue

NetezzaDialect

The dialect definition for Netezza.

Protobuf type google.cloud.bigquery.migration.v2.NetezzaDialect

NetezzaDialect.Builder

The dialect definition for Netezza.

Protobuf type google.cloud.bigquery.migration.v2.NetezzaDialect

ObjectNameMapping

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

Protobuf type google.cloud.bigquery.migration.v2.ObjectNameMapping

ObjectNameMapping.Builder

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

Protobuf type google.cloud.bigquery.migration.v2.ObjectNameMapping

ObjectNameMappingList

Represents a map of name mappings using a list of key:value proto messages of existing name to desired output name.

Protobuf type google.cloud.bigquery.migration.v2.ObjectNameMappingList

ObjectNameMappingList.Builder

Represents a map of name mappings using a list of key:value proto messages of existing name to desired output name.

Protobuf type google.cloud.bigquery.migration.v2.ObjectNameMappingList

OracleDialect

The dialect definition for Oracle.

Protobuf type google.cloud.bigquery.migration.v2.OracleDialect

OracleDialect.Builder

The dialect definition for Oracle.

Protobuf type google.cloud.bigquery.migration.v2.OracleDialect

Point

A single data point in a time series.

Protobuf type google.cloud.bigquery.migration.v2.Point

Point.Builder

A single data point in a time series.

Protobuf type google.cloud.bigquery.migration.v2.Point

PostgresqlDialect

The dialect definition for Postgresql.

Protobuf type google.cloud.bigquery.migration.v2.PostgresqlDialect

PostgresqlDialect.Builder

The dialect definition for Postgresql.

Protobuf type google.cloud.bigquery.migration.v2.PostgresqlDialect

PrestoDialect

The dialect definition for Presto.

Protobuf type google.cloud.bigquery.migration.v2.PrestoDialect

PrestoDialect.Builder

The dialect definition for Presto.

Protobuf type google.cloud.bigquery.migration.v2.PrestoDialect

RedshiftDialect

The dialect definition for Redshift.

Protobuf type google.cloud.bigquery.migration.v2.RedshiftDialect

RedshiftDialect.Builder

The dialect definition for Redshift.

Protobuf type google.cloud.bigquery.migration.v2.RedshiftDialect

ResourceErrorDetail

Provides details for errors and the corresponding resources.

Protobuf type google.cloud.bigquery.migration.v2.ResourceErrorDetail

ResourceErrorDetail.Builder

Provides details for errors and the corresponding resources.

Protobuf type google.cloud.bigquery.migration.v2.ResourceErrorDetail

SQLServerDialect

The dialect definition for SQL Server.

Protobuf type google.cloud.bigquery.migration.v2.SQLServerDialect

SQLServerDialect.Builder

The dialect definition for SQL Server.

Protobuf type google.cloud.bigquery.migration.v2.SQLServerDialect

SnowflakeDialect

The dialect definition for Snowflake.

Protobuf type google.cloud.bigquery.migration.v2.SnowflakeDialect

SnowflakeDialect.Builder

The dialect definition for Snowflake.

Protobuf type google.cloud.bigquery.migration.v2.SnowflakeDialect

SourceEnv

Represents the default source environment values for the translation.

Protobuf type google.cloud.bigquery.migration.v2.SourceEnv

SourceEnv.Builder

Represents the default source environment values for the translation.

Protobuf type google.cloud.bigquery.migration.v2.SourceEnv

SparkSQLDialect

The dialect definition for SparkSQL.

Protobuf type google.cloud.bigquery.migration.v2.SparkSQLDialect

SparkSQLDialect.Builder

The dialect definition for SparkSQL.

Protobuf type google.cloud.bigquery.migration.v2.SparkSQLDialect

StartMigrationWorkflowRequest

A request to start a previously created migration workflow.

Protobuf type google.cloud.bigquery.migration.v2.StartMigrationWorkflowRequest

StartMigrationWorkflowRequest.Builder

A request to start a previously created migration workflow.

Protobuf type google.cloud.bigquery.migration.v2.StartMigrationWorkflowRequest

TeradataDialect

The dialect definition for Teradata.

Protobuf type google.cloud.bigquery.migration.v2.TeradataDialect

TeradataDialect.Builder

The dialect definition for Teradata.

Protobuf type google.cloud.bigquery.migration.v2.TeradataDialect

TimeInterval

A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.

Protobuf type google.cloud.bigquery.migration.v2.TimeInterval

TimeInterval.Builder

A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.

Protobuf type google.cloud.bigquery.migration.v2.TimeInterval

TimeSeries

The metrics object for a SubTask.

Protobuf type google.cloud.bigquery.migration.v2.TimeSeries

TimeSeries.Builder

The metrics object for a SubTask.

Protobuf type google.cloud.bigquery.migration.v2.TimeSeries

TranslationConfigDetails

The translation config to capture necessary settings for a translation task and subtask.

Protobuf type google.cloud.bigquery.migration.v2.TranslationConfigDetails

TranslationConfigDetails.Builder

The translation config to capture necessary settings for a translation task and subtask.

Protobuf type google.cloud.bigquery.migration.v2.TranslationConfigDetails

TranslationConfigProto

TypedValue

A single strongly-typed value.

Protobuf type google.cloud.bigquery.migration.v2.TypedValue

TypedValue.Builder

A single strongly-typed value.

Protobuf type google.cloud.bigquery.migration.v2.TypedValue

VerticaDialect

The dialect definition for Vertica.

Protobuf type google.cloud.bigquery.migration.v2.VerticaDialect

VerticaDialect.Builder

The dialect definition for Vertica.

Protobuf type google.cloud.bigquery.migration.v2.VerticaDialect

Interfaces

AzureSynapseDialectOrBuilder

BigQueryDialectOrBuilder

CreateMigrationWorkflowRequestOrBuilder

DeleteMigrationWorkflowRequestOrBuilder

DialectOrBuilder

ErrorDetailOrBuilder

ErrorLocationOrBuilder

GetMigrationSubtaskRequestOrBuilder

GetMigrationWorkflowRequestOrBuilder

HiveQLDialectOrBuilder

ListMigrationSubtasksRequestOrBuilder

ListMigrationSubtasksResponseOrBuilder

ListMigrationWorkflowsRequestOrBuilder

ListMigrationWorkflowsResponseOrBuilder

MigrationServiceGrpc.AsyncService

Service to handle EDW migrations.

MigrationSubtaskOrBuilder

MigrationTaskOrBuilder

MigrationWorkflowOrBuilder

MySQLDialectOrBuilder

NameMappingKeyOrBuilder

NameMappingValueOrBuilder

NetezzaDialectOrBuilder

ObjectNameMappingListOrBuilder

ObjectNameMappingOrBuilder

OracleDialectOrBuilder

PointOrBuilder

PostgresqlDialectOrBuilder

PrestoDialectOrBuilder

RedshiftDialectOrBuilder

ResourceErrorDetailOrBuilder

SQLServerDialectOrBuilder

SnowflakeDialectOrBuilder

SourceEnvOrBuilder

SparkSQLDialectOrBuilder

StartMigrationWorkflowRequestOrBuilder

TeradataDialectOrBuilder

TimeIntervalOrBuilder

TimeSeriesOrBuilder

TranslationConfigDetailsOrBuilder

TypedValueOrBuilder

VerticaDialectOrBuilder

Enums

Dialect.DialectValueCase

MigrationSubtask.State

Possible states of a migration subtask.

Protobuf enum google.cloud.bigquery.migration.v2.MigrationSubtask.State

MigrationTask.State

Possible states of a migration task.

Protobuf enum google.cloud.bigquery.migration.v2.MigrationTask.State

MigrationTask.TaskDetailsCase

MigrationWorkflow.State

Possible migration workflow states.

Protobuf enum google.cloud.bigquery.migration.v2.MigrationWorkflow.State

NameMappingKey.Type

The type of the object that is being mapped.

Protobuf enum google.cloud.bigquery.migration.v2.NameMappingKey.Type

TeradataDialect.Mode

The sub-dialect options for Teradata.

Protobuf enum google.cloud.bigquery.migration.v2.TeradataDialect.Mode

TranslationConfigDetails.OutputNameMappingCase

TranslationConfigDetails.SourceLocationCase

TranslationConfigDetails.TargetLocationCase

TypedValue.ValueCase