BigQuery Migration API v2alpha - Package cloud.google.com/go/bigquery/migration/apiv2alpha (v1.35.0)

Stay organized with collections Save and categorize content based on your preferences.

Package migration is an auto-generated package for the BigQuery Migration API.

The migration service, exposing apis for migration jobs operations, and agent management.

NOTE: This package is in alpha. It is not stable, and is likely to change.

Example usage

To get started with this package, create a client.

ctx := context.Background()
c, err := migration.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
c, err := migration.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &migrationpb.CreateMigrationWorkflowRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha#CreateMigrationWorkflowRequest.
}
resp, err := c.CreateMigrationWorkflow(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

CallOptions

type CallOptions struct {
	CreateMigrationWorkflow []gax.CallOption
	GetMigrationWorkflow    []gax.CallOption
	ListMigrationWorkflows  []gax.CallOption
	DeleteMigrationWorkflow []gax.CallOption
	StartMigrationWorkflow  []gax.CallOption
	GetMigrationSubtask     []gax.CallOption
	ListMigrationSubtasks   []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

	// The call options for this service.
	CallOptions *CallOptions
	// contains filtered or unexported fields
}

Client is a client for interacting with BigQuery Migration API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service to handle EDW migrations.

func NewClient

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new migration service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service to handle EDW migrations.

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*Client) Close

func (c *Client) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*Client) Connection

func (c *Client) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*Client) CreateMigrationWorkflow

CreateMigrationWorkflow creates a migration workflow.

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"

	migrationpb "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &migrationpb.CreateMigrationWorkflowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha#CreateMigrationWorkflowRequest.
	}
	resp, err := c.CreateMigrationWorkflow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) DeleteMigrationWorkflow

func (c *Client) DeleteMigrationWorkflow(ctx context.Context, req *migrationpb.DeleteMigrationWorkflowRequest, opts ...gax.CallOption) error

DeleteMigrationWorkflow deletes a migration workflow by name.

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"

	migrationpb "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &migrationpb.DeleteMigrationWorkflowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha#DeleteMigrationWorkflowRequest.
	}
	err = c.DeleteMigrationWorkflow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*Client) GetMigrationSubtask

GetMigrationSubtask gets a previously created migration subtask.

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"

	migrationpb "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &migrationpb.GetMigrationSubtaskRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha#GetMigrationSubtaskRequest.
	}
	resp, err := c.GetMigrationSubtask(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetMigrationWorkflow

GetMigrationWorkflow gets a previously created migration workflow.

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"

	migrationpb "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &migrationpb.GetMigrationWorkflowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha#GetMigrationWorkflowRequest.
	}
	resp, err := c.GetMigrationWorkflow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) ListMigrationSubtasks

ListMigrationSubtasks lists previously created migration subtasks.

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"
	"google.golang.org/api/iterator"

	migrationpb "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &migrationpb.ListMigrationSubtasksRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha#ListMigrationSubtasksRequest.
	}
	it := c.ListMigrationSubtasks(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) ListMigrationWorkflows

ListMigrationWorkflows lists previously created migration workflow.

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"
	"google.golang.org/api/iterator"

	migrationpb "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &migrationpb.ListMigrationWorkflowsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha#ListMigrationWorkflowsRequest.
	}
	it := c.ListMigrationWorkflows(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) StartMigrationWorkflow

func (c *Client) StartMigrationWorkflow(ctx context.Context, req *migrationpb.StartMigrationWorkflowRequest, opts ...gax.CallOption) error

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

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"

	migrationpb "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &migrationpb.StartMigrationWorkflowRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha#StartMigrationWorkflowRequest.
	}
	err = c.StartMigrationWorkflow(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

MigrationSubtaskIterator

type MigrationSubtaskIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*migrationpb.MigrationSubtask, nextPageToken string, err error)
	// contains filtered or unexported fields
}

MigrationSubtaskIterator manages a stream of *migrationpb.MigrationSubtask.

func (*MigrationSubtaskIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*MigrationSubtaskIterator) PageInfo

func (it *MigrationSubtaskIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

MigrationWorkflowIterator

type MigrationWorkflowIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*migrationpb.MigrationWorkflow, nextPageToken string, err error)
	// contains filtered or unexported fields
}

MigrationWorkflowIterator manages a stream of *migrationpb.MigrationWorkflow.

func (*MigrationWorkflowIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*MigrationWorkflowIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

SqlTranslationCallOptions

type SqlTranslationCallOptions struct {
	TranslateQuery []gax.CallOption
}

SqlTranslationCallOptions contains the retry settings for each method of SqlTranslationClient.

SqlTranslationClient

type SqlTranslationClient struct {

	// The call options for this service.
	CallOptions *SqlTranslationCallOptions
	// contains filtered or unexported fields
}

SqlTranslationClient is a client for interacting with BigQuery Migration API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Provides other SQL dialects to GoogleSQL translation operations.

func NewSqlTranslationClient

func NewSqlTranslationClient(ctx context.Context, opts ...option.ClientOption) (*SqlTranslationClient, error)

NewSqlTranslationClient creates a new sql translation service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Provides other SQL dialects to GoogleSQL translation operations.

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewSqlTranslationClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*SqlTranslationClient) Close

func (c *SqlTranslationClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*SqlTranslationClient) Connection

func (c *SqlTranslationClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*SqlTranslationClient) TranslateQuery

TranslateQuery translates input queries from source dialects to GoogleSQL.

Example

package main

import (
	"context"

	migration "cloud.google.com/go/bigquery/migration/apiv2alpha"
	migrationpb "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha"
)

func main() {
	ctx := context.Background()
	c, err := migration.NewSqlTranslationClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &migrationpb.TranslateQueryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha#TranslateQueryRequest.
	}
	resp, err := c.TranslateQuery(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}