Package cloud.google.com/go/clouddms/apiv1

Package clouddms is an auto-generated package for the Database Migration API.

Manage Cloud Database Migration Service resources on Google Cloud Platform.

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 .

 func DefaultAuthScopes() [] string 
 

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

 type ConnectionProfileIterator 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 []* clouddmspb 
. ConnectionProfile 
, nextPageToken string 
, err error 
)
	// contains filtered or unexported fields
} 

ConnectionProfileIterator manages a stream of *clouddmspb.ConnectionProfile.

 func (it * ConnectionProfileIterator 
) Next() (* clouddmspb 
. ConnectionProfile 
, error 
) 

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 (it * ConnectionProfileIterator 
) PageInfo() * iterator 
. PageInfo 
 

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

 type CreateConnectionProfileOperation struct {
	// contains filtered or unexported fields
} 

CreateConnectionProfileOperation manages a long-running operation from CreateConnectionProfile.

 func (op * CreateConnectionProfileOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * CreateConnectionProfileOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * CreateConnectionProfileOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * CreateConnectionProfileOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. ConnectionProfile 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * CreateConnectionProfileOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. ConnectionProfile 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type CreateMigrationJobOperation struct {
	// contains filtered or unexported fields
} 

CreateMigrationJobOperation manages a long-running operation from CreateMigrationJob.

 func (op * CreateMigrationJobOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * CreateMigrationJobOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * CreateMigrationJobOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * CreateMigrationJobOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * CreateMigrationJobOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type DataMigrationCallOptions struct {
	ListMigrationJobs       [] gax 
. CallOption 
GetMigrationJob         [] gax 
. CallOption 
CreateMigrationJob      [] gax 
. CallOption 
UpdateMigrationJob      [] gax 
. CallOption 
DeleteMigrationJob      [] gax 
. CallOption 
StartMigrationJob       [] gax 
. CallOption 
StopMigrationJob        [] gax 
. CallOption 
ResumeMigrationJob      [] gax 
. CallOption 
PromoteMigrationJob     [] gax 
. CallOption 
VerifyMigrationJob      [] gax 
. CallOption 
RestartMigrationJob     [] gax 
. CallOption 
GenerateSshScript       [] gax 
. CallOption 
ListConnectionProfiles  [] gax 
. CallOption 
GetConnectionProfile    [] gax 
. CallOption 
CreateConnectionProfile [] gax 
. CallOption 
UpdateConnectionProfile [] gax 
. CallOption 
DeleteConnectionProfile [] gax 
. CallOption 
} 

DataMigrationCallOptions contains the retry settings for each method of DataMigrationClient.

 type DataMigrationClient struct {

	// The call options for this service.
	CallOptions * DataMigrationCallOptions 
// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient * lroauto 
. OperationsClient 
// contains filtered or unexported fields
} 

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

Database Migration service

 func NewDataMigrationClient(ctx context 
. Context 
, opts ... option 
. ClientOption 
) (* DataMigrationClient 
, error 
) 

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

Database Migration service

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
)

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

	// TODO: Use client.
	_ = c
} 

 func (c * DataMigrationClient 
) Close() error 
 

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

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

Connection returns a connection to the API service.

Deprecated.

 func (c * DataMigrationClient 
) CreateConnectionProfile(ctx context 
. Context 
, req * clouddmspb 
. CreateConnectionProfileRequest 
, opts ... gax 
. CallOption 
) (* CreateConnectionProfileOperation 
, error 
) 

CreateConnectionProfile creates a new connection profile in a given project and location.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.CreateConnectionProfileRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.CreateConnectionProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) CreateConnectionProfileOperation(name string 
) * CreateConnectionProfileOperation 
 

CreateConnectionProfileOperation returns a new CreateConnectionProfileOperation from a given name. The name must be that of a previously created CreateConnectionProfileOperation, possibly from a different process.

 func (c * DataMigrationClient 
) CreateMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. CreateMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* CreateMigrationJobOperation 
, error 
) 

CreateMigrationJob creates a new migration job in a given project and location.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.CreateMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.CreateMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) CreateMigrationJobOperation(name string 
) * CreateMigrationJobOperation 
 

CreateMigrationJobOperation returns a new CreateMigrationJobOperation from a given name. The name must be that of a previously created CreateMigrationJobOperation, possibly from a different process.

 func (c * DataMigrationClient 
) DeleteConnectionProfile(ctx context 
. Context 
, req * clouddmspb 
. DeleteConnectionProfileRequest 
, opts ... gax 
. CallOption 
) (* DeleteConnectionProfileOperation 
, error 
) 

DeleteConnectionProfile deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.DeleteConnectionProfileRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.DeleteConnectionProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
} 

 func (c * DataMigrationClient 
) DeleteConnectionProfileOperation(name string 
) * DeleteConnectionProfileOperation 
 

DeleteConnectionProfileOperation returns a new DeleteConnectionProfileOperation from a given name. The name must be that of a previously created DeleteConnectionProfileOperation, possibly from a different process.

 func (c * DataMigrationClient 
) DeleteMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. DeleteMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* DeleteMigrationJobOperation 
, error 
) 

DeleteMigrationJob deletes a single migration job.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.DeleteMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.DeleteMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
} 

 func (c * DataMigrationClient 
) DeleteMigrationJobOperation(name string 
) * DeleteMigrationJobOperation 
 

DeleteMigrationJobOperation returns a new DeleteMigrationJobOperation from a given name. The name must be that of a previously created DeleteMigrationJobOperation, possibly from a different process.

 func (c * DataMigrationClient 
) GenerateSshScript(ctx context 
. Context 
, req * clouddmspb 
. GenerateSshScriptRequest 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. SshScript 
, error 
) 

GenerateSshScript generate a SSH configuration script to configure the reverse SSH connectivity.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.GenerateSshScriptRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GenerateSshScript(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) GetConnectionProfile(ctx context 
. Context 
, req * clouddmspb 
. GetConnectionProfileRequest 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. ConnectionProfile 
, error 
) 

GetConnectionProfile gets details of a single connection profile.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.GetConnectionProfileRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetConnectionProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) GetMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. GetMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

GetMigrationJob gets details of a single migration job.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.GetMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) ListConnectionProfiles(ctx context 
. Context 
, req * clouddmspb 
. ListConnectionProfilesRequest 
, opts ... gax 
. CallOption 
) * ConnectionProfileIterator 
 

ListConnectionProfiles retrieve a list of all connection profiles in a given project and location.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	"google.golang.org/api/iterator"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.ListConnectionProfilesRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListConnectionProfiles(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
} 

 func (c * DataMigrationClient 
) ListMigrationJobs(ctx context 
. Context 
, req * clouddmspb 
. ListMigrationJobsRequest 
, opts ... gax 
. CallOption 
) * MigrationJobIterator 
 

ListMigrationJobs lists migration jobs in a given project and location.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	"google.golang.org/api/iterator"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.ListMigrationJobsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListMigrationJobs(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
} 

 func (c * DataMigrationClient 
) PromoteMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. PromoteMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* PromoteMigrationJobOperation 
, error 
) 

PromoteMigrationJob promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.PromoteMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.PromoteMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) PromoteMigrationJobOperation(name string 
) * PromoteMigrationJobOperation 
 

PromoteMigrationJobOperation returns a new PromoteMigrationJobOperation from a given name. The name must be that of a previously created PromoteMigrationJobOperation, possibly from a different process.

 func (c * DataMigrationClient 
) RestartMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. RestartMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* RestartMigrationJobOperation 
, error 
) 

RestartMigrationJob restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.RestartMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.RestartMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) RestartMigrationJobOperation(name string 
) * RestartMigrationJobOperation 
 

RestartMigrationJobOperation returns a new RestartMigrationJobOperation from a given name. The name must be that of a previously created RestartMigrationJobOperation, possibly from a different process.

 func (c * DataMigrationClient 
) ResumeMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. ResumeMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* ResumeMigrationJobOperation 
, error 
) 

ResumeMigrationJob resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.ResumeMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.ResumeMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) ResumeMigrationJobOperation(name string 
) * ResumeMigrationJobOperation 
 

ResumeMigrationJobOperation returns a new ResumeMigrationJobOperation from a given name. The name must be that of a previously created ResumeMigrationJobOperation, possibly from a different process.

 func (c * DataMigrationClient 
) StartMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. StartMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* StartMigrationJobOperation 
, error 
) 

StartMigrationJob start an already created migration job.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.StartMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.StartMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) StartMigrationJobOperation(name string 
) * StartMigrationJobOperation 
 

StartMigrationJobOperation returns a new StartMigrationJobOperation from a given name. The name must be that of a previously created StartMigrationJobOperation, possibly from a different process.

 func (c * DataMigrationClient 
) StopMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. StopMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* StopMigrationJobOperation 
, error 
) 

StopMigrationJob stops a running migration job.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.StopMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.StopMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) StopMigrationJobOperation(name string 
) * StopMigrationJobOperation 
 

StopMigrationJobOperation returns a new StopMigrationJobOperation from a given name. The name must be that of a previously created StopMigrationJobOperation, possibly from a different process.

 func (c * DataMigrationClient 
) UpdateConnectionProfile(ctx context 
. Context 
, req * clouddmspb 
. UpdateConnectionProfileRequest 
, opts ... gax 
. CallOption 
) (* UpdateConnectionProfileOperation 
, error 
) 

UpdateConnectionProfile update the configuration of a single connection profile.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.UpdateConnectionProfileRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.UpdateConnectionProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) UpdateConnectionProfileOperation(name string 
) * UpdateConnectionProfileOperation 
 

UpdateConnectionProfileOperation returns a new UpdateConnectionProfileOperation from a given name. The name must be that of a previously created UpdateConnectionProfileOperation, possibly from a different process.

 func (c * DataMigrationClient 
) UpdateMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. UpdateMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* UpdateMigrationJobOperation 
, error 
) 

UpdateMigrationJob updates the parameters of a single migration job.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.UpdateMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.UpdateMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) UpdateMigrationJobOperation(name string 
) * UpdateMigrationJobOperation 
 

UpdateMigrationJobOperation returns a new UpdateMigrationJobOperation from a given name. The name must be that of a previously created UpdateMigrationJobOperation, possibly from a different process.

 func (c * DataMigrationClient 
) VerifyMigrationJob(ctx context 
. Context 
, req * clouddmspb 
. VerifyMigrationJobRequest 
, opts ... gax 
. CallOption 
) (* VerifyMigrationJobOperation 
, error 
) 

VerifyMigrationJob verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

 package main

import (
	clouddms "cloud.google.com/go/clouddms/apiv1"
	"context"
	clouddmspb "google.golang.org/genproto/googleapis/cloud/clouddms/v1"
)

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

	req := &clouddmspb.VerifyMigrationJobRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.VerifyMigrationJob(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
} 

 func (c * DataMigrationClient 
) VerifyMigrationJobOperation(name string 
) * VerifyMigrationJobOperation 
 

VerifyMigrationJobOperation returns a new VerifyMigrationJobOperation from a given name. The name must be that of a previously created VerifyMigrationJobOperation, possibly from a different process.

 type DeleteConnectionProfileOperation struct {
	// contains filtered or unexported fields
} 

DeleteConnectionProfileOperation manages a long-running operation from DeleteConnectionProfile.

 func (op * DeleteConnectionProfileOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * DeleteConnectionProfileOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * DeleteConnectionProfileOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * DeleteConnectionProfileOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) error 
 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * DeleteConnectionProfileOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) error 
 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type DeleteMigrationJobOperation struct {
	// contains filtered or unexported fields
} 

DeleteMigrationJobOperation manages a long-running operation from DeleteMigrationJob.

 func (op * DeleteMigrationJobOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * DeleteMigrationJobOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * DeleteMigrationJobOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * DeleteMigrationJobOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) error 
 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * DeleteMigrationJobOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) error 
 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type MigrationJobIterator 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 []* clouddmspb 
. MigrationJob 
, nextPageToken string 
, err error 
)
	// contains filtered or unexported fields
} 

MigrationJobIterator manages a stream of *clouddmspb.MigrationJob.

 func (it * MigrationJobIterator 
) Next() (* clouddmspb 
. MigrationJob 
, error 
) 

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 (it * MigrationJobIterator 
) PageInfo() * iterator 
. PageInfo 
 

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

 type PromoteMigrationJobOperation struct {
	// contains filtered or unexported fields
} 

PromoteMigrationJobOperation manages a long-running operation from PromoteMigrationJob.

 func (op * PromoteMigrationJobOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * PromoteMigrationJobOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * PromoteMigrationJobOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * PromoteMigrationJobOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * PromoteMigrationJobOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type RestartMigrationJobOperation struct {
	// contains filtered or unexported fields
} 

RestartMigrationJobOperation manages a long-running operation from RestartMigrationJob.

 func (op * RestartMigrationJobOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * RestartMigrationJobOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * RestartMigrationJobOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * RestartMigrationJobOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * RestartMigrationJobOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type ResumeMigrationJobOperation struct {
	// contains filtered or unexported fields
} 

ResumeMigrationJobOperation manages a long-running operation from ResumeMigrationJob.

 func (op * ResumeMigrationJobOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * ResumeMigrationJobOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * ResumeMigrationJobOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * ResumeMigrationJobOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * ResumeMigrationJobOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type StartMigrationJobOperation struct {
	// contains filtered or unexported fields
} 

StartMigrationJobOperation manages a long-running operation from StartMigrationJob.

 func (op * StartMigrationJobOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * StartMigrationJobOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * StartMigrationJobOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * StartMigrationJobOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * StartMigrationJobOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type StopMigrationJobOperation struct {
	// contains filtered or unexported fields
} 

StopMigrationJobOperation manages a long-running operation from StopMigrationJob.

 func (op * StopMigrationJobOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * StopMigrationJobOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * StopMigrationJobOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * StopMigrationJobOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * StopMigrationJobOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type UpdateConnectionProfileOperation struct {
	// contains filtered or unexported fields
} 

UpdateConnectionProfileOperation manages a long-running operation from UpdateConnectionProfile.

 func (op * UpdateConnectionProfileOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * UpdateConnectionProfileOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * UpdateConnectionProfileOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * UpdateConnectionProfileOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. ConnectionProfile 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * UpdateConnectionProfileOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. ConnectionProfile 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type UpdateMigrationJobOperation struct {
	// contains filtered or unexported fields
} 

UpdateMigrationJobOperation manages a long-running operation from UpdateMigrationJob.

 func (op * UpdateMigrationJobOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * UpdateMigrationJobOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * UpdateMigrationJobOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * UpdateMigrationJobOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * UpdateMigrationJobOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

 type VerifyMigrationJobOperation struct {
	// contains filtered or unexported fields
} 

VerifyMigrationJobOperation manages a long-running operation from VerifyMigrationJob.

 func (op * VerifyMigrationJobOperation 
) Done() bool 
 

Done reports whether the long-running operation has completed.

 func (op * VerifyMigrationJobOperation 
) Metadata() (* clouddmspb 
. OperationMetadata 
, error 
) 

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

 func (op * VerifyMigrationJobOperation 
) Name() string 
 

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

 func (op * VerifyMigrationJobOperation 
) Poll(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

 func (op * VerifyMigrationJobOperation 
) Wait(ctx context 
. Context 
, opts ... gax 
. CallOption 
) (* clouddmspb 
. MigrationJob 
, error 
) 

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.