google::cloud::bigquery_migration_v2::MigrationServiceClient Class Reference

Service to handle EDW migrations. More...

#include <google/cloud/bigquery/migration/v2/migration_client.h>

Public Member Functions
	MigrationServiceClient (std::shared_ptr< MigrationServiceConnection > connection, Options opts={})
	~MigrationServiceClient ()
StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow >	CreateMigrationWorkflow (std::string const &parent, google::cloud::bigquery::migration::v2::MigrationWorkflow const &migration_workflow, Options opts={})
	Creates a migration workflow. More...
StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow >	CreateMigrationWorkflow (google::cloud::bigquery::migration::v2::CreateMigrationWorkflowRequest const &request, Options opts={})
	Creates a migration workflow. More...
StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow >	GetMigrationWorkflow (std::string const &name, Options opts={})
	Gets a previously created migration workflow. More...
StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow >	GetMigrationWorkflow (google::cloud::bigquery::migration::v2::GetMigrationWorkflowRequest const &request, Options opts={})
	Gets a previously created migration workflow. More...
StreamRange< google::cloud::bigquery::migration::v2::MigrationWorkflow >	ListMigrationWorkflows (std::string const &parent, Options opts={})
	Lists previously created migration workflow. More...
StreamRange< google::cloud::bigquery::migration::v2::MigrationWorkflow >	ListMigrationWorkflows (google::cloud::bigquery::migration::v2::ListMigrationWorkflowsRequest request, Options opts={})
	Lists previously created migration workflow. More...
Status	DeleteMigrationWorkflow (std::string const &name, Options opts={})
	Deletes a migration workflow by name. More...
Status	DeleteMigrationWorkflow (google::cloud::bigquery::migration::v2::DeleteMigrationWorkflowRequest const &request, Options opts={})
	Deletes a migration workflow by name. More...
Status	StartMigrationWorkflow (std::string const &name, Options opts={})
	Starts a previously created migration workflow. More...
Status	StartMigrationWorkflow (google::cloud::bigquery::migration::v2::StartMigrationWorkflowRequest const &request, Options opts={})
	Starts a previously created migration workflow. More...
StatusOr< google::cloud::bigquery::migration::v2::MigrationSubtask >	GetMigrationSubtask (std::string const &name, Options opts={})
	Gets a previously created migration subtask. More...
StatusOr< google::cloud::bigquery::migration::v2::MigrationSubtask >	GetMigrationSubtask (google::cloud::bigquery::migration::v2::GetMigrationSubtaskRequest const &request, Options opts={})
	Gets a previously created migration subtask. More...
StreamRange< google::cloud::bigquery::migration::v2::MigrationSubtask >	ListMigrationSubtasks (std::string const &parent, Options opts={})
	Lists previously created migration subtasks. More...
StreamRange< google::cloud::bigquery::migration::v2::MigrationSubtask >	ListMigrationSubtasks (google::cloud::bigquery::migration::v2::ListMigrationSubtasksRequest request, Options opts={})
	Lists previously created migration subtasks. More...
Copy and move support
	MigrationServiceClient (MigrationServiceClient const &)=default
MigrationServiceClient &	operator= (MigrationServiceClient const &)=default
	MigrationServiceClient (MigrationServiceClient &&)=default
MigrationServiceClient &	operator= (MigrationServiceClient &&)=default

Friends
Equality
bool	operator== (MigrationServiceClient const &a, MigrationServiceClient const &b)
bool	operator!= (MigrationServiceClient const &a, MigrationServiceClient const &b)

Detailed Description

Service to handle EDW migrations.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructor & Destructor Documentation

MigrationServiceClient() [1/3]

google::cloud::bigquery_migration_v2::MigrationServiceClient::MigrationServiceClient ( std::shared_ptr< MigrationServiceConnection >  connection, Options  opts = {}  )

explicit

~MigrationServiceClient()

google::cloud::bigquery_migration_v2::MigrationServiceClient::~MigrationServiceClient

(

)

MigrationServiceClient() [2/3]

google::cloud::bigquery_migration_v2::MigrationServiceClient::MigrationServiceClient ( MigrationServiceClient const &  )

default

MigrationServiceClient() [3/3]

google::cloud::bigquery_migration_v2::MigrationServiceClient::MigrationServiceClient ( MigrationServiceClient &&  )

default

Member Function Documentation

CreateMigrationWorkflow() [1/2]

StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow > google::cloud::bigquery_migration_v2::MigrationServiceClient::CreateMigrationWorkflow	(	google::cloud::bigquery::migration::v2::CreateMigrationWorkflowRequest const &	request,
		Options	opts = {}
	)

Creates a migration workflow.

Parameters

request	google::cloud::bigquery::migration::v2::CreateMigrationWorkflowRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationWorkflow

CreateMigrationWorkflow() [2/2]

StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow > google::cloud::bigquery_migration_v2::MigrationServiceClient::CreateMigrationWorkflow	(	std::string const &	parent,
		google::cloud::bigquery::migration::v2::MigrationWorkflow const &	migration_workflow,
		Options	opts = {}
	)

Creates a migration workflow.

Parameters

parent	Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar
migration_workflow	Required. The migration workflow to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationWorkflow

DeleteMigrationWorkflow() [1/2]

Status google::cloud::bigquery_migration_v2::MigrationServiceClient::DeleteMigrationWorkflow	(	google::cloud::bigquery::migration::v2::DeleteMigrationWorkflowRequest const &	request,
		Options	opts = {}
	)

Deletes a migration workflow by name.

Parameters

request	google::cloud::bigquery::migration::v2::DeleteMigrationWorkflowRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

DeleteMigrationWorkflow() [2/2]

Status google::cloud::bigquery_migration_v2::MigrationServiceClient::DeleteMigrationWorkflow	(	std::string const &	name,
		Options	opts = {}
	)

Deletes a migration workflow by name.

Parameters

name	Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234
opts	Optional. Override the class-level options, such as retry and backoff policies.

GetMigrationSubtask() [1/2]

StatusOr< google::cloud::bigquery::migration::v2::MigrationSubtask > google::cloud::bigquery_migration_v2::MigrationServiceClient::GetMigrationSubtask	(	google::cloud::bigquery::migration::v2::GetMigrationSubtaskRequest const &	request,
		Options	opts = {}
	)

Gets a previously created migration subtask.

Parameters

request	google::cloud::bigquery::migration::v2::GetMigrationSubtaskRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationSubtask

GetMigrationSubtask() [2/2]

StatusOr< google::cloud::bigquery::migration::v2::MigrationSubtask > google::cloud::bigquery_migration_v2::MigrationServiceClient::GetMigrationSubtask	(	std::string const &	name,
		Options	opts = {}
	)

Gets a previously created migration subtask.

Parameters

name	Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationSubtask

GetMigrationWorkflow() [1/2]

StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow > google::cloud::bigquery_migration_v2::MigrationServiceClient::GetMigrationWorkflow	(	google::cloud::bigquery::migration::v2::GetMigrationWorkflowRequest const &	request,
		Options	opts = {}
	)

Gets a previously created migration workflow.

Parameters

request	google::cloud::bigquery::migration::v2::GetMigrationWorkflowRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationWorkflow

GetMigrationWorkflow() [2/2]

StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow > google::cloud::bigquery_migration_v2::MigrationServiceClient::GetMigrationWorkflow	(	std::string const &	name,
		Options	opts = {}
	)

Gets a previously created migration workflow.

Parameters

name	Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationWorkflow

ListMigrationSubtasks() [1/2]

StreamRange< google::cloud::bigquery::migration::v2::MigrationSubtask > google::cloud::bigquery_migration_v2::MigrationServiceClient::ListMigrationSubtasks	(	google::cloud::bigquery::migration::v2::ListMigrationSubtasksRequest	request,
		Options	opts = {}
	)

Lists previously created migration subtasks.

Parameters

request	google::cloud::bigquery::migration::v2::ListMigrationSubtasksRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationSubtask

ListMigrationSubtasks() [2/2]

StreamRange< google::cloud::bigquery::migration::v2::MigrationSubtask > google::cloud::bigquery_migration_v2::MigrationServiceClient::ListMigrationSubtasks	(	std::string const &	parent,
		Options	opts = {}
	)

Lists previously created migration subtasks.

Parameters

parent	Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationSubtask

ListMigrationWorkflows() [1/2]

StreamRange< google::cloud::bigquery::migration::v2::MigrationWorkflow > google::cloud::bigquery_migration_v2::MigrationServiceClient::ListMigrationWorkflows	(	google::cloud::bigquery::migration::v2::ListMigrationWorkflowsRequest	request,
		Options	opts = {}
	)

Lists previously created migration workflow.

Parameters

request	google::cloud::bigquery::migration::v2::ListMigrationWorkflowsRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationWorkflow

ListMigrationWorkflows() [2/2]

StreamRange< google::cloud::bigquery::migration::v2::MigrationWorkflow > google::cloud::bigquery_migration_v2::MigrationServiceClient::ListMigrationWorkflows	(	std::string const &	parent,
		Options	opts = {}
	)

Lists previously created migration workflow.

Parameters

parent	Required. The project and location of the migration workflows to list. Example: projects/123/locations/us
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::migration::v2::MigrationWorkflow

operator=() [1/2]

MigrationServiceClient & google::cloud::bigquery_migration_v2::MigrationServiceClient::operator= ( MigrationServiceClient &&  )

default

operator=() [2/2]

MigrationServiceClient & google::cloud::bigquery_migration_v2::MigrationServiceClient::operator= ( MigrationServiceClient const &  )

default

StartMigrationWorkflow() [1/2]

Status google::cloud::bigquery_migration_v2::MigrationServiceClient::StartMigrationWorkflow	(	google::cloud::bigquery::migration::v2::StartMigrationWorkflowRequest const &	request,
		Options	opts = {}
	)

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.

Parameters

request	google::cloud::bigquery::migration::v2::StartMigrationWorkflowRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

StartMigrationWorkflow() [2/2]

Status google::cloud::bigquery_migration_v2::MigrationServiceClient::StartMigrationWorkflow	(	std::string const &	name,
		Options	opts = {}
	)

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.

Parameters

name	Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234
opts	Optional. Override the class-level options, such as retry and backoff policies.

Friends And Related Function Documentation

operator!=

bool operator!= ( MigrationServiceClient const &  a, MigrationServiceClient const &  b  )

friend

operator==

bool operator== ( MigrationServiceClient const &  a, MigrationServiceClient const &  b  )

friend