migration
package v1.72.0
Go to latest Published: Oct 28, 2025 License:Apache-2.0
Opens a new window with list of versions in this module.
Latest Latest
This package is not in the latest version of its module.
Opens a new window with license information.
Imports:20 Opens a new window with list of imports.
Imported by:1 Opens a new window with list of known importers.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Documentation¶
Overview¶
Package migration is an auto-generated package for theBigQuery Migration API.
The migration service, exposing apis for migration jobs operations, andagent management.
General documentation¶
For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage¶
To get started with this package, create a client.
// go get cloud.google.com/go/bigquery/migration/apiv2@latestctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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, mentioned above.
req := &migrationpb.CreateMigrationWorkflowRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#CreateMigrationWorkflowRequest.}resp, err := c.CreateMigrationWorkflow(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = respUse of Context¶
The ctx passed to NewClient is used for authentication requests andfor 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.
Index¶
- func DefaultAuthScopes() []string
- type CallOptions
- type Client
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConndeprecated
- func (c *Client) CreateMigrationWorkflow(ctx context.Context, req *migrationpb.CreateMigrationWorkflowRequest, ...) (*migrationpb.MigrationWorkflow, error)
- func (c *Client) DeleteMigrationWorkflow(ctx context.Context, req *migrationpb.DeleteMigrationWorkflowRequest, ...) error
- func (c *Client) GetMigrationSubtask(ctx context.Context, req *migrationpb.GetMigrationSubtaskRequest, ...) (*migrationpb.MigrationSubtask, error)
- func (c *Client) GetMigrationWorkflow(ctx context.Context, req *migrationpb.GetMigrationWorkflowRequest, ...) (*migrationpb.MigrationWorkflow, error)
- func (c *Client) ListMigrationSubtasks(ctx context.Context, req *migrationpb.ListMigrationSubtasksRequest, ...) *MigrationSubtaskIterator
- func (c *Client) ListMigrationWorkflows(ctx context.Context, req *migrationpb.ListMigrationWorkflowsRequest, ...) *MigrationWorkflowIterator
- func (c *Client) StartMigrationWorkflow(ctx context.Context, req *migrationpb.StartMigrationWorkflowRequest, ...) error
- type MigrationSubtaskIterator
- type MigrationWorkflowIterator
Examples¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
funcDefaultAuthScopes¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types¶
typeCallOptions¶
type CallOptions struct {CreateMigrationWorkflow []gax.CallOptionGetMigrationWorkflow []gax.CallOptionListMigrationWorkflows []gax.CallOptionDeleteMigrationWorkflow []gax.CallOptionStartMigrationWorkflow []gax.CallOptionGetMigrationSubtask []gax.CallOptionListMigrationSubtasks []gax.CallOption}CallOptions contains the retry settings for each method of Client.
typeClient¶
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.
funcNewClient¶
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 mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := migration.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()// TODO: Use client._ = c}func (*Client)Close¶
Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.
func (*Client)Connectiondeprecated
func (c *Client) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.
func (*Client)CreateMigrationWorkflow¶
func (c *Client) CreateMigrationWorkflow(ctxcontext.Context, req *migrationpb.CreateMigrationWorkflowRequest, opts ...gax.CallOption) (*migrationpb.MigrationWorkflow,error)
CreateMigrationWorkflow creates a migration workflow.
Example¶
package mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2"migrationpb "cloud.google.com/go/bigquery/migration/apiv2/migrationpb")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#CreateMigrationWorkflowRequest.}resp, err := c.CreateMigrationWorkflow(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}func (*Client)DeleteMigrationWorkflow¶
func (c *Client) DeleteMigrationWorkflow(ctxcontext.Context, req *migrationpb.DeleteMigrationWorkflowRequest, opts ...gax.CallOption)error
DeleteMigrationWorkflow deletes a migration workflow by name.
Example¶
package mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2"migrationpb "cloud.google.com/go/bigquery/migration/apiv2/migrationpb")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#DeleteMigrationWorkflowRequest.}err = c.DeleteMigrationWorkflow(ctx, req)if err != nil {// TODO: Handle error.}}func (*Client)GetMigrationSubtask¶
func (c *Client) GetMigrationSubtask(ctxcontext.Context, req *migrationpb.GetMigrationSubtaskRequest, opts ...gax.CallOption) (*migrationpb.MigrationSubtask,error)
GetMigrationSubtask gets a previously created migration subtask.
Example¶
package mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2"migrationpb "cloud.google.com/go/bigquery/migration/apiv2/migrationpb")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#GetMigrationSubtaskRequest.}resp, err := c.GetMigrationSubtask(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}func (*Client)GetMigrationWorkflow¶
func (c *Client) GetMigrationWorkflow(ctxcontext.Context, req *migrationpb.GetMigrationWorkflowRequest, opts ...gax.CallOption) (*migrationpb.MigrationWorkflow,error)
GetMigrationWorkflow gets a previously created migration workflow.
Example¶
package mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2"migrationpb "cloud.google.com/go/bigquery/migration/apiv2/migrationpb")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#GetMigrationWorkflowRequest.}resp, err := c.GetMigrationWorkflow(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}func (*Client)ListMigrationSubtasks¶
func (c *Client) ListMigrationSubtasks(ctxcontext.Context, req *migrationpb.ListMigrationSubtasksRequest, opts ...gax.CallOption) *MigrationSubtaskIterator
ListMigrationSubtasks lists previously created migration subtasks.
Example¶
package mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2"migrationpb "cloud.google.com/go/bigquery/migration/apiv2/migrationpb""google.golang.org/api/iterator")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#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// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._ = it.Response.(*migrationpb.ListMigrationSubtasksResponse)}}Example (All)¶
package mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2"migrationpb "cloud.google.com/go/bigquery/migration/apiv2/migrationpb")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#ListMigrationSubtasksRequest.}for resp, err := range c.ListMigrationSubtasks(ctx, req).All() {if err != nil {// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._ = resp}}func (*Client)ListMigrationWorkflows¶
func (c *Client) ListMigrationWorkflows(ctxcontext.Context, req *migrationpb.ListMigrationWorkflowsRequest, opts ...gax.CallOption) *MigrationWorkflowIterator
ListMigrationWorkflows lists previously created migration workflow.
Example¶
package mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2"migrationpb "cloud.google.com/go/bigquery/migration/apiv2/migrationpb""google.golang.org/api/iterator")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#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// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._ = it.Response.(*migrationpb.ListMigrationWorkflowsResponse)}}Example (All)¶
package mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2"migrationpb "cloud.google.com/go/bigquery/migration/apiv2/migrationpb")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#ListMigrationWorkflowsRequest.}for resp, err := range c.ListMigrationWorkflows(ctx, req).All() {if err != nil {// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._ = resp}}func (*Client)StartMigrationWorkflow¶
func (c *Client) StartMigrationWorkflow(ctxcontext.Context, req *migrationpb.StartMigrationWorkflowRequest, opts ...gax.CallOption)error
StartMigrationWorkflow starts a previously created migration workflow. I.e., the state transitionsfrom 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 orRUNNING.
Example¶
package mainimport ("context"migration "cloud.google.com/go/bigquery/migration/apiv2"migrationpb "cloud.google.com/go/bigquery/migration/apiv2/migrationpb")func main() {ctx := context.Background()// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, 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/cloud.google.com/go/bigquery/migration/apiv2/migrationpb#StartMigrationWorkflowRequest.}err = c.StartMigrationWorkflow(ctx, req)if err != nil {// TODO: Handle error.}}typeMigrationSubtaskIterator¶
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(pageSizeint, pageTokenstring) (results []*migrationpb.MigrationSubtask, nextPageTokenstring, errerror)// contains filtered or unexported fields}MigrationSubtaskIterator manages a stream of *migrationpb.MigrationSubtask.
func (*MigrationSubtaskIterator)All¶added inv1.63.0
func (it *MigrationSubtaskIterator) All()iter.Seq2[*migrationpb.MigrationSubtask,error]
All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*MigrationSubtaskIterator)Next¶
func (it *MigrationSubtaskIterator) Next() (*migrationpb.MigrationSubtask,error)
Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*MigrationSubtaskIterator)PageInfo¶
func (it *MigrationSubtaskIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See thegoogle.golang.org/api/iterator package for details.
typeMigrationWorkflowIterator¶
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(pageSizeint, pageTokenstring) (results []*migrationpb.MigrationWorkflow, nextPageTokenstring, errerror)// contains filtered or unexported fields}MigrationWorkflowIterator manages a stream of *migrationpb.MigrationWorkflow.
func (*MigrationWorkflowIterator)All¶added inv1.63.0
func (it *MigrationWorkflowIterator) All()iter.Seq2[*migrationpb.MigrationWorkflow,error]
All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*MigrationWorkflowIterator)Next¶
func (it *MigrationWorkflowIterator) Next() (*migrationpb.MigrationWorkflow,error)
Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*MigrationWorkflowIterator)PageInfo¶
func (it *MigrationWorkflowIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See thegoogle.golang.org/api/iterator package for details.
Source Files¶
Directories Click to show internal directories.
Click to hide internal directories.