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