Package com.google.cloud.bigquery.migration.v2alpha (0.2.4)

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

MigrationServiceClient

Service Description: Service to handle EDW migrations.

Sample for MigrationServiceClient:


 try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   MigrationWorkflow migrationWorkflow = MigrationWorkflow.newBuilder().build();
   MigrationWorkflow response =
       migrationServiceClient.createMigrationWorkflow(parent, migrationWorkflow);
 }

Classes

AssessmentOrchestrationResultDetails

Details for an assessment task orchestration result.

Protobuf type google.cloud.bigquery.migration.v2alpha.AssessmentOrchestrationResultDetails

AssessmentOrchestrationResultDetails.Builder

Details for an assessment task orchestration result.

Protobuf type google.cloud.bigquery.migration.v2alpha.AssessmentOrchestrationResultDetails

AssessmentTaskDetails

Assessment task config.

Protobuf type google.cloud.bigquery.migration.v2alpha.AssessmentTaskDetails

AssessmentTaskDetails.Builder

Assessment task config.

Protobuf type google.cloud.bigquery.migration.v2alpha.AssessmentTaskDetails

AssessmentTaskProto

BteqOptions

BTEQ translation task related settings.

Protobuf type google.cloud.bigquery.migration.v2alpha.BteqOptions

BteqOptions.Builder

BTEQ translation task related settings.

Protobuf type google.cloud.bigquery.migration.v2alpha.BteqOptions

CreateMigrationWorkflowRequest

Request to create a migration workflow resource.

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

CreateMigrationWorkflowRequest.Builder

Request to create a migration workflow resource.

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

DatasetReference

Reference to a BigQuery dataset.

Protobuf type google.cloud.bigquery.migration.v2alpha.DatasetReference

DatasetReference.Builder

Reference to a BigQuery dataset.

Protobuf type google.cloud.bigquery.migration.v2alpha.DatasetReference

DeleteMigrationWorkflowRequest

A request to delete a previously created migration workflow.

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

DeleteMigrationWorkflowRequest.Builder

A request to delete a previously created migration workflow.

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

ErrorDetail

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

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

ErrorDetail.Builder

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

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

ErrorLocation

Holds information about where the error is located.

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

ErrorLocation.Builder

Holds information about where the error is located.

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

Filter

The filter applied to fields of translation details.

Protobuf type google.cloud.bigquery.migration.v2alpha.Filter

Filter.Builder

The filter applied to fields of translation details.

Protobuf type google.cloud.bigquery.migration.v2alpha.Filter

GetMigrationSubtaskRequest

A request to get a previously created migration subtasks.

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

GetMigrationSubtaskRequest.Builder

A request to get a previously created migration subtasks.

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

GetMigrationWorkflowRequest

A request to get a previously created migration workflow.

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

GetMigrationWorkflowRequest.Builder

A request to get a previously created migration workflow.

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

IdentifierSettings

Settings related to SQL identifiers.

Protobuf type google.cloud.bigquery.migration.v2alpha.IdentifierSettings

IdentifierSettings.Builder

Settings related to SQL identifiers.

Protobuf type google.cloud.bigquery.migration.v2alpha.IdentifierSettings

ListMigrationSubtasksRequest

A request to list previously created migration subtasks.

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

ListMigrationSubtasksRequest.Builder

A request to list previously created migration subtasks.

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

ListMigrationSubtasksResponse

Response object for a ListMigrationSubtasks call.

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

ListMigrationSubtasksResponse.Builder

Response object for a ListMigrationSubtasks call.

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

ListMigrationWorkflowsRequest

A request to list previously created migration workflows.

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

ListMigrationWorkflowsRequest.Builder

A request to list previously created migration workflows.

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

ListMigrationWorkflowsResponse

Response object for a ListMigrationWorkflows call.

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

ListMigrationWorkflowsResponse.Builder

Response object for a ListMigrationWorkflows call.

Protobuf type google.cloud.bigquery.migration.v2alpha.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:


 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:


 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MigrationServiceClient migrationServiceClient =
     MigrationServiceClient.create(migrationServiceSettings);

To customize the endpoint:


 MigrationServiceSettings migrationServiceSettings =
     MigrationServiceSettings.newBuilder().setEndpoint(myEndpoint).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

Service to handle EDW migrations.

MigrationServiceGrpc.MigrationServiceFutureStub

Service to handle EDW migrations.

MigrationServiceGrpc.MigrationServiceImplBase

Service to handle EDW migrations.

MigrationServiceGrpc.MigrationServiceStub

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:


 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.v2alpha.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.v2alpha.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.v2alpha.MigrationTask

MigrationTask.Builder

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

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

MigrationTaskOrchestrationResult

Additional information from the orchestrator when it is done with the task orchestration.

Protobuf type google.cloud.bigquery.migration.v2alpha.MigrationTaskOrchestrationResult

MigrationTaskOrchestrationResult.Builder

Additional information from the orchestrator when it is done with the task orchestration.

Protobuf type google.cloud.bigquery.migration.v2alpha.MigrationTaskOrchestrationResult

MigrationWorkflow

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

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

MigrationWorkflow.Builder

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

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

MigrationWorkflowName

MigrationWorkflowName.Builder

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

Point

A single data point in a time series.

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

Point.Builder

A single data point in a time series.

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

ResourceErrorDetail

Provides details for errors and the corresponding resources.

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

ResourceErrorDetail.Builder

Provides details for errors and the corresponding resources.

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

StartMigrationWorkflowRequest

A request to start a previously created migration workflow.

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

StartMigrationWorkflowRequest.Builder

A request to start a previously created migration workflow.

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

TeradataOptions

Teradata SQL specific translation task related settings.

Protobuf type google.cloud.bigquery.migration.v2alpha.TeradataOptions

TeradataOptions.Builder

Teradata SQL specific translation task related settings.

Protobuf type google.cloud.bigquery.migration.v2alpha.TeradataOptions

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.v2alpha.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.v2alpha.TimeInterval

TimeSeries

The metrics object for a SubTask.

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

TimeSeries.Builder

The metrics object for a SubTask.

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

TranslationFileMapping

Mapping between an input and output file to be translated in a subtask.

Protobuf type google.cloud.bigquery.migration.v2alpha.TranslationFileMapping

TranslationFileMapping.Builder

Mapping between an input and output file to be translated in a subtask.

Protobuf type google.cloud.bigquery.migration.v2alpha.TranslationFileMapping

TranslationTaskDetails

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

Protobuf type google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails

TranslationTaskDetails.Builder

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

Protobuf type google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails

TranslationTaskProto

TypedValue

A single strongly-typed value.

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

TypedValue.Builder

A single strongly-typed value.

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

Interfaces

AssessmentOrchestrationResultDetailsOrBuilder

AssessmentTaskDetailsOrBuilder

BteqOptionsOrBuilder

CreateMigrationWorkflowRequestOrBuilder

DatasetReferenceOrBuilder

DeleteMigrationWorkflowRequestOrBuilder

ErrorDetailOrBuilder

ErrorLocationOrBuilder

FilterOrBuilder

GetMigrationSubtaskRequestOrBuilder

GetMigrationWorkflowRequestOrBuilder

IdentifierSettingsOrBuilder

ListMigrationSubtasksRequestOrBuilder

ListMigrationSubtasksResponseOrBuilder

ListMigrationWorkflowsRequestOrBuilder

ListMigrationWorkflowsResponseOrBuilder

MigrationSubtaskOrBuilder

MigrationTaskOrBuilder

MigrationTaskOrchestrationResultOrBuilder

MigrationWorkflowOrBuilder

PointOrBuilder

ResourceErrorDetailOrBuilder

StartMigrationWorkflowRequestOrBuilder

TeradataOptionsOrBuilder

TimeIntervalOrBuilder

TimeSeriesOrBuilder

TranslationFileMappingOrBuilder

TranslationTaskDetailsOrBuilder

TypedValueOrBuilder

Enums

IdentifierSettings.IdentifierCase

The identifier case type.

Protobuf enum google.cloud.bigquery.migration.v2alpha.IdentifierSettings.IdentifierCase

IdentifierSettings.IdentifierRewriteMode

The SQL identifier rewrite mode.

Protobuf enum google.cloud.bigquery.migration.v2alpha.IdentifierSettings.IdentifierRewriteMode

MigrationSubtask.State

Possible states of a migration subtask.

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

MigrationTask.State

Possible states of a migration task.

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

MigrationTask.TaskDetailsCase

MigrationTaskOrchestrationResult.DetailsCase

MigrationWorkflow.State

Possible migration workflow states.

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

TranslationTaskDetails.FileEncoding

The file encoding types.

Protobuf enum google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.FileEncoding

TranslationTaskDetails.LanguageOptionsCase

TranslationTaskDetails.TokenType

The special token data type.

Protobuf enum google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.TokenType

TypedValue.ValueCase