Google Cloud BigQuery C++ Client  2.6.0
A C++ Client Library for Google Cloud BigQuery
Public Member Functions | List of all members
google::cloud::bigquery::MigrationServiceClient Class Reference

Service to handle EDW migrations. More...

#include <google/cloud/bigquery/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...
 
 MigrationServiceClient (MigrationServiceClient const &)=default
 
MigrationServiceClientoperator= (MigrationServiceClient const &)=default
 
 MigrationServiceClient (MigrationServiceClient &&)=default
 
MigrationServiceClientoperator= (MigrationServiceClient &&)=default
 

Friends

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.

Definition at line 62 of file migration_client.h.

Constructor & Destructor Documentation

◆ MigrationServiceClient() [1/3]

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

◆ ~MigrationServiceClient()

google::cloud::bigquery::MigrationServiceClient::~MigrationServiceClient ( )

◆ MigrationServiceClient() [2/3]

google::cloud::bigquery::MigrationServiceClient::MigrationServiceClient ( MigrationServiceClient const &  )
default

◆ MigrationServiceClient() [3/3]

google::cloud::bigquery::MigrationServiceClient::MigrationServiceClient ( MigrationServiceClient &&  )
default

Member Function Documentation

◆ CreateMigrationWorkflow() [1/2]

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

Creates a migration workflow.

Parameters
requestgoogle::cloud::bigquery::migration::v2::CreateMigrationWorkflowRequest
optsOptional. 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::MigrationServiceClient::CreateMigrationWorkflow ( std::string const &  parent,
google::cloud::bigquery::migration::v2::MigrationWorkflow const &  migration_workflow,
Options  opts = {} 
)

Creates a migration workflow.

Parameters
parentRequired. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar
migration_workflowRequired. The migration workflow to create.
optsOptional. 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::MigrationServiceClient::DeleteMigrationWorkflow ( google::cloud::bigquery::migration::v2::DeleteMigrationWorkflowRequest const &  request,
Options  opts = {} 
)

Deletes a migration workflow by name.

Parameters
requestgoogle::cloud::bigquery::migration::v2::DeleteMigrationWorkflowRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteMigrationWorkflow() [2/2]

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

Deletes a migration workflow by name.

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

◆ GetMigrationSubtask() [1/2]

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

Gets a previously created migration subtask.

Parameters
requestgoogle::cloud::bigquery::migration::v2::GetMigrationSubtaskRequest
optsOptional. 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::MigrationServiceClient::GetMigrationSubtask ( std::string const &  name,
Options  opts = {} 
)

Gets a previously created migration subtask.

Parameters
nameRequired. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543
optsOptional. 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::MigrationServiceClient::GetMigrationWorkflow ( google::cloud::bigquery::migration::v2::GetMigrationWorkflowRequest const &  request,
Options  opts = {} 
)

Gets a previously created migration workflow.

Parameters
requestgoogle::cloud::bigquery::migration::v2::GetMigrationWorkflowRequest
optsOptional. 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::MigrationServiceClient::GetMigrationWorkflow ( std::string const &  name,
Options  opts = {} 
)

Gets a previously created migration workflow.

Parameters
nameRequired. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234
optsOptional. 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::MigrationServiceClient::ListMigrationSubtasks ( google::cloud::bigquery::migration::v2::ListMigrationSubtasksRequest  request,
Options  opts = {} 
)

Lists previously created migration subtasks.

Parameters
requestgoogle::cloud::bigquery::migration::v2::ListMigrationSubtasksRequest
optsOptional. 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::MigrationServiceClient::ListMigrationSubtasks ( std::string const &  parent,
Options  opts = {} 
)

Lists previously created migration subtasks.

Parameters
parentRequired. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234
optsOptional. 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::MigrationServiceClient::ListMigrationWorkflows ( google::cloud::bigquery::migration::v2::ListMigrationWorkflowsRequest  request,
Options  opts = {} 
)

Lists previously created migration workflow.

Parameters
requestgoogle::cloud::bigquery::migration::v2::ListMigrationWorkflowsRequest
optsOptional. 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::MigrationServiceClient::ListMigrationWorkflows ( std::string const &  parent,
Options  opts = {} 
)

Lists previously created migration workflow.

Parameters
parentRequired. The project and location of the migration workflows to list. Example: projects/123/locations/us
optsOptional. 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::MigrationServiceClient::operator= ( MigrationServiceClient &&  )
default

◆ operator=() [2/2]

MigrationServiceClient& google::cloud::bigquery::MigrationServiceClient::operator= ( MigrationServiceClient const &  )
default

◆ StartMigrationWorkflow() [1/2]

Status google::cloud::bigquery::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
requestgoogle::cloud::bigquery::migration::v2::StartMigrationWorkflowRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ StartMigrationWorkflow() [2/2]

Status google::cloud::bigquery::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
nameRequired. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234
optsOptional. 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

Definition at line 83 of file migration_client.h.

◆ operator==

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

Definition at line 79 of file migration_client.h.