Class MigrationServiceClient (2.31.0)

Version 2.31.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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.

Constructors

MigrationServiceClient(MigrationServiceClient const &)

Copy and move support

Parameter
Name	Description
	MigrationServiceClient const &

MigrationServiceClient(MigrationServiceClient &&)

Copy and move support

Parameter
Name	Description
	MigrationServiceClient &&

MigrationServiceClient(std::shared_ptr< MigrationServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< MigrationServiceConnection >
opts	Options

Operators

operator=(MigrationServiceClient const &)

Copy and move support

Parameter
Name	Description
	MigrationServiceClient const &

Returns
Type	Description
MigrationServiceClient &

operator=(MigrationServiceClient &&)

Copy and move support

Parameter
Name	Description
	MigrationServiceClient &&

Returns
Type	Description
MigrationServiceClient &

Functions

CreateMigrationWorkflow(std::string const &, google::cloud::bigquery::migration::v2::MigrationWorkflow const &, Options)

Creates a migration workflow.

Parameters
Name	Description
parent	std::string const & Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar
migration_workflow	google::cloud::bigquery::migration::v2::MigrationWorkflow const & Required. The migration workflow to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow >	the result of the RPC. The response message type (google.cloud.bigquery.migration.v2.MigrationWorkflow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateMigrationWorkflow(google::cloud::bigquery::migration::v2::CreateMigrationWorkflowRequest const &, Options)

Creates a migration workflow.

Parameters
Name	Description
request	google::cloud::bigquery::migration::v2::CreateMigrationWorkflowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.migration.v2.CreateMigrationWorkflowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow >	the result of the RPC. The response message type (google.cloud.bigquery.migration.v2.MigrationWorkflow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMigrationWorkflow(std::string const &, Options)

Gets a previously created migration workflow.

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

Returns
Type	Description
StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow >	the result of the RPC. The response message type (google.cloud.bigquery.migration.v2.MigrationWorkflow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMigrationWorkflow(google::cloud::bigquery::migration::v2::GetMigrationWorkflowRequest const &, Options)

Gets a previously created migration workflow.

Parameters
Name	Description
request	google::cloud::bigquery::migration::v2::GetMigrationWorkflowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.migration.v2.GetMigrationWorkflowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::migration::v2::MigrationWorkflow >	the result of the RPC. The response message type (google.cloud.bigquery.migration.v2.MigrationWorkflow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListMigrationWorkflows(std::string const &, Options)

Lists previously created migration workflow.

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

Returns
Type	Description
StreamRange< google::cloud::bigquery::migration::v2::MigrationWorkflow >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.migration.v2.MigrationWorkflow, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMigrationWorkflows(google::cloud::bigquery::migration::v2::ListMigrationWorkflowsRequest, Options)

Lists previously created migration workflow.

Parameters
Name	Description
request	google::cloud::bigquery::migration::v2::ListMigrationWorkflowsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.migration.v2.ListMigrationWorkflowsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::migration::v2::MigrationWorkflow >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.migration.v2.MigrationWorkflow, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteMigrationWorkflow(std::string const &, Options)

Deletes a migration workflow by name.

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

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteMigrationWorkflow(google::cloud::bigquery::migration::v2::DeleteMigrationWorkflowRequest const &, Options)

Deletes a migration workflow by name.

Parameters
Name	Description
request	google::cloud::bigquery::migration::v2::DeleteMigrationWorkflowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.migration.v2.DeleteMigrationWorkflowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

StartMigrationWorkflow(std::string const &, Options)

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	Description
name	std::string const & Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

StartMigrationWorkflow(google::cloud::bigquery::migration::v2::StartMigrationWorkflowRequest const &, Options)

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	Description
request	google::cloud::bigquery::migration::v2::StartMigrationWorkflowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.migration.v2.StartMigrationWorkflowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

GetMigrationSubtask(std::string const &, Options)

Gets a previously created migration subtask.

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

Returns
Type	Description
StatusOr< google::cloud::bigquery::migration::v2::MigrationSubtask >	the result of the RPC. The response message type (google.cloud.bigquery.migration.v2.MigrationSubtask) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMigrationSubtask(google::cloud::bigquery::migration::v2::GetMigrationSubtaskRequest const &, Options)

Gets a previously created migration subtask.

Parameters
Name	Description
request	google::cloud::bigquery::migration::v2::GetMigrationSubtaskRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.migration.v2.GetMigrationSubtaskRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::migration::v2::MigrationSubtask >	the result of the RPC. The response message type (google.cloud.bigquery.migration.v2.MigrationSubtask) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListMigrationSubtasks(std::string const &, Options)

Lists previously created migration subtasks.

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

Returns
Type	Description
StreamRange< google::cloud::bigquery::migration::v2::MigrationSubtask >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.migration.v2.MigrationSubtask, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMigrationSubtasks(google::cloud::bigquery::migration::v2::ListMigrationSubtasksRequest, Options)

Lists previously created migration subtasks.

Parameters
Name	Description
request	google::cloud::bigquery::migration::v2::ListMigrationSubtasksRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.migration.v2.ListMigrationSubtasksRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::migration::v2::MigrationSubtask >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.migration.v2.MigrationSubtask, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.