Class VmMigrationClient (2.12.0)

VM Migration Service.

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

VmMigrationClient(VmMigrationClient const &)

Copy and move support

Parameter
Name	Description
	`VmMigrationClient const &`

VmMigrationClient(VmMigrationClient &&)

Copy and move support

Parameter
Name	Description
	`VmMigrationClient &&`

VmMigrationClient(std::shared_ptr< VmMigrationConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< VmMigrationConnection >`
`opts`	`Options`

Operators

operator=(VmMigrationClient const &)

Copy and move support

Parameter
Name	Description
	`VmMigrationClient const &`

Returns
Type	Description
`VmMigrationClient &`

operator=(VmMigrationClient &&)

Copy and move support

Parameter
Name	Description
	`VmMigrationClient &&`

Returns
Type	Description
`VmMigrationClient &`

Functions

ListSources(std::string const &, Options)

Lists Sources in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of sources.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::vmmigration::v1::Source >

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.vmmigration.v1.Source, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSources(google::cloud::vmmigration::v1::ListSourcesRequest, Options)

Lists Sources in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ListSourcesRequest` 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.vmmigration.v1.ListSourcesRequest. 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::vmmigration::v1::Source >

GetSource(std::string const &, Options)

Gets details of a single Source.

Parameters
Name	Description
`name`	`std::string const &` Required. The Source name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetSource(google::cloud::vmmigration::v1::GetSourceRequest const &, Options)

Gets details of a single Source.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::GetSourceRequest 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.vmmigration.v1.GetSourceRequest. 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::vmmigration::v1::Source >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateSource(std::string const &, google::cloud::vmmigration::v1::Source const &, std::string const &, Options)

Creates a new Source in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The Source's parent.
`source`	`google::cloud::vmmigration::v1::Source const &` Required. The create request body.
`source_id`	`std::string const &` Required. The source identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::Source > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.Source proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSource(google::cloud::vmmigration::v1::CreateSourceRequest const &, Options)

Creates a new Source in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CreateSourceRequest 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.vmmigration.v1.CreateSourceRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::Source > >

UpdateSource(google::cloud::vmmigration::v1::Source const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Source.

Parameters
Name	Description
`source`	`google::cloud::vmmigration::v1::Source const &` Required. The update request body.
`update_mask`	`google::protobuf::FieldMask const &` Field mask is used to specify the fields to be overwritten in the Source resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::Source > >

UpdateSource(google::cloud::vmmigration::v1::UpdateSourceRequest const &, Options)

Updates the parameters of a single Source.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::UpdateSourceRequest 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.vmmigration.v1.UpdateSourceRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::Source > >

DeleteSource(std::string const &, Options)

Deletes a single Source.

Parameters
Name	Description
`name`	`std::string const &` Required. The Source name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSource(google::cloud::vmmigration::v1::DeleteSourceRequest const &, Options)

Deletes a single Source.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::DeleteSourceRequest 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.vmmigration.v1.DeleteSourceRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

FetchInventory(std::string const &, Options)

List remote source's inventory of VMs.

The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.

Parameters
Name	Description
`source`	`std::string const &` Required. The name of the Source.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

FetchInventory(google::cloud::vmmigration::v1::FetchInventoryRequest const &, Options)

List remote source's inventory of VMs.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::FetchInventoryRequest 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.vmmigration.v1.FetchInventoryRequest. 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::vmmigration::v1::FetchInventoryResponse >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.FetchInventoryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListUtilizationReports(std::string const &, Options)

Lists Utilization Reports of the given Source.

Parameters
Name	Description
`parent`	`std::string const &` Required. The Utilization Reports parent.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::vmmigration::v1::UtilizationReport >

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.vmmigration.v1.UtilizationReport, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListUtilizationReports(google::cloud::vmmigration::v1::ListUtilizationReportsRequest, Options)

Lists Utilization Reports of the given Source.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ListUtilizationReportsRequest` 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.vmmigration.v1.ListUtilizationReportsRequest. 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::vmmigration::v1::UtilizationReport >

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.vmmigration.v1.UtilizationReport, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetUtilizationReport(std::string const &, Options)

Gets a single Utilization Report.

Parameters
Name	Description
`name`	`std::string const &` Required. The Utilization Report name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetUtilizationReport(google::cloud::vmmigration::v1::GetUtilizationReportRequest const &, Options)

Gets a single Utilization Report.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::GetUtilizationReportRequest 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.vmmigration.v1.GetUtilizationReportRequest. 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::vmmigration::v1::UtilizationReport >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.UtilizationReport) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateUtilizationReport(std::string const &, google::cloud::vmmigration::v1::UtilizationReport const &, std::string const &, Options)

Creates a new UtilizationReport.

Parameters
Name	Description
`parent`	`std::string const &` Required. The Utilization Report's parent.
`utilization_report`	`google::cloud::vmmigration::v1::UtilizationReport const &` Required. The report to create.
`utilization_report_id`	`std::string const &` Required. The ID to use for the report, which will become the final component of the reports's resource name. This value maximum length is 63 characters, and valid characters are /[a-z][0-9]-/. It must start with an english letter and must not end with a hyphen.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::UtilizationReport > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.UtilizationReport proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateUtilizationReport(google::cloud::vmmigration::v1::CreateUtilizationReportRequest const &, Options)

Creates a new UtilizationReport.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CreateUtilizationReportRequest 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.vmmigration.v1.CreateUtilizationReportRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::UtilizationReport > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.UtilizationReport proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteUtilizationReport(std::string const &, Options)

Deletes a single Utilization Report.

Parameters
Name	Description
`name`	`std::string const &` Required. The Utilization Report name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteUtilizationReport(google::cloud::vmmigration::v1::DeleteUtilizationReportRequest const &, Options)

Deletes a single Utilization Report.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::DeleteUtilizationReportRequest 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.vmmigration.v1.DeleteUtilizationReportRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListDatacenterConnectors(std::string const &, Options)

Lists DatacenterConnectors in a given Source.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of connectors.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::vmmigration::v1::DatacenterConnector >

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.vmmigration.v1.DatacenterConnector, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatacenterConnectors(google::cloud::vmmigration::v1::ListDatacenterConnectorsRequest, Options)

Lists DatacenterConnectors in a given Source.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ListDatacenterConnectorsRequest` 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.vmmigration.v1.ListDatacenterConnectorsRequest. 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::vmmigration::v1::DatacenterConnector >

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.vmmigration.v1.DatacenterConnector, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDatacenterConnector(std::string const &, Options)

Gets details of a single DatacenterConnector.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the DatacenterConnector.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetDatacenterConnector(google::cloud::vmmigration::v1::GetDatacenterConnectorRequest const &, Options)

Gets details of a single DatacenterConnector.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::GetDatacenterConnectorRequest 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.vmmigration.v1.GetDatacenterConnectorRequest. 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::vmmigration::v1::DatacenterConnector >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.DatacenterConnector) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateDatacenterConnector(std::string const &, google::cloud::vmmigration::v1::DatacenterConnector const &, std::string const &, Options)

Creates a new DatacenterConnector in a given Source.

Parameters
Name	Description
`parent`	`std::string const &` Required. The DatacenterConnector's parent. Required. The Source in where the new DatacenterConnector will be created. For example: `projects/my-project/locations/us-central1/sources/my-source`
`datacenter_connector`	`google::cloud::vmmigration::v1::DatacenterConnector const &` Required. The create request body.
`datacenter_connector_id`	`std::string const &` Required. The datacenterConnector identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::DatacenterConnector > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.DatacenterConnector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDatacenterConnector(google::cloud::vmmigration::v1::CreateDatacenterConnectorRequest const &, Options)

Creates a new DatacenterConnector in a given Source.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CreateDatacenterConnectorRequest 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.vmmigration.v1.CreateDatacenterConnectorRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::DatacenterConnector > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.DatacenterConnector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDatacenterConnector(std::string const &, Options)

Deletes a single DatacenterConnector.

Parameters
Name	Description
`name`	`std::string const &` Required. The DatacenterConnector name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDatacenterConnector(google::cloud::vmmigration::v1::DeleteDatacenterConnectorRequest const &, Options)

Deletes a single DatacenterConnector.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::DeleteDatacenterConnectorRequest 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.vmmigration.v1.DeleteDatacenterConnectorRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpgradeAppliance(google::cloud::vmmigration::v1::UpgradeApplianceRequest const &, Options)

Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::UpgradeApplianceRequest 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.vmmigration.v1.UpgradeApplianceRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::UpgradeApplianceResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.UpgradeApplianceResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateMigratingVm(std::string const &, google::cloud::vmmigration::v1::MigratingVm const &, std::string const &, Options)

Creates a new MigratingVm in a given Source.

Parameters
Name	Description
`parent`	`std::string const &` Required. The MigratingVm's parent.
`migrating_vm`	`google::cloud::vmmigration::v1::MigratingVm const &` Required. The create request body.
`migrating_vm_id`	`std::string const &` Required. The migratingVm identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::MigratingVm > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.MigratingVm proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateMigratingVm(google::cloud::vmmigration::v1::CreateMigratingVmRequest const &, Options)

Creates a new MigratingVm in a given Source.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CreateMigratingVmRequest 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.vmmigration.v1.CreateMigratingVmRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::MigratingVm > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.MigratingVm proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListMigratingVms(std::string const &, Options)

Lists MigratingVms in a given Source.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of MigratingVms.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::vmmigration::v1::MigratingVm >

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.vmmigration.v1.MigratingVm, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMigratingVms(google::cloud::vmmigration::v1::ListMigratingVmsRequest, Options)

Lists MigratingVms in a given Source.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ListMigratingVmsRequest` 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.vmmigration.v1.ListMigratingVmsRequest. 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::vmmigration::v1::MigratingVm >

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.vmmigration.v1.MigratingVm, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetMigratingVm(std::string const &, Options)

Gets details of a single MigratingVm.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the MigratingVm.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetMigratingVm(google::cloud::vmmigration::v1::GetMigratingVmRequest const &, Options)

Gets details of a single MigratingVm.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::GetMigratingVmRequest 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.vmmigration.v1.GetMigratingVmRequest. 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::vmmigration::v1::MigratingVm >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.MigratingVm) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateMigratingVm(google::cloud::vmmigration::v1::MigratingVm const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single MigratingVm.

Parameters
Name	Description
`migrating_vm`	`google::cloud::vmmigration::v1::MigratingVm const &` Required. The update request body.
`update_mask`	`google::protobuf::FieldMask const &` Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::MigratingVm > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.MigratingVm proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateMigratingVm(google::cloud::vmmigration::v1::UpdateMigratingVmRequest const &, Options)

Updates the parameters of a single MigratingVm.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::UpdateMigratingVmRequest 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.vmmigration.v1.UpdateMigratingVmRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::MigratingVm > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.MigratingVm proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteMigratingVm(std::string const &, Options)

Deletes a single MigratingVm.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the MigratingVm.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteMigratingVm(google::cloud::vmmigration::v1::DeleteMigratingVmRequest const &, Options)

Deletes a single MigratingVm.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::DeleteMigratingVmRequest 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.vmmigration.v1.DeleteMigratingVmRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartMigration(std::string const &, Options)

Starts migration for a VM.

Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy.

Parameters
Name	Description
`migrating_vm`	`std::string const &` Required. The name of the MigratingVm.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::StartMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.StartMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartMigration(google::cloud::vmmigration::v1::StartMigrationRequest const &, Options)

Starts migration for a VM.

Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::StartMigrationRequest 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.vmmigration.v1.StartMigrationRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::StartMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.StartMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ResumeMigration(google::cloud::vmmigration::v1::ResumeMigrationRequest const &, Options)

Resumes a migration for a VM.

When called on a paused migration, will start the process of uploading data and creating snapshots; when called on a completed cut-over migration, will update the migration to active state and start the process of uploading data and creating snapshots.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ResumeMigrationRequest 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.vmmigration.v1.ResumeMigrationRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::ResumeMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.ResumeMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PauseMigration(google::cloud::vmmigration::v1::PauseMigrationRequest const &, Options)

Pauses a migration for a VM.

If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered while the VM is paused.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::PauseMigrationRequest 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.vmmigration.v1.PauseMigrationRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::PauseMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.PauseMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

FinalizeMigration(std::string const &, Options)

Marks a migration as completed, deleting migration resources that are no longer being used.

Only applicable after cutover is done.

Parameters
Name	Description
`migrating_vm`	`std::string const &` Required. The name of the MigratingVm.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::FinalizeMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.FinalizeMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

FinalizeMigration(google::cloud::vmmigration::v1::FinalizeMigrationRequest const &, Options)

Marks a migration as completed, deleting migration resources that are no longer being used.

Only applicable after cutover is done.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::FinalizeMigrationRequest 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.vmmigration.v1.FinalizeMigrationRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::FinalizeMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.FinalizeMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCloneJob(std::string const &, google::cloud::vmmigration::v1::CloneJob const &, std::string const &, Options)

Initiates a Clone of a specific migrating VM.

Parameters
Name	Description
`parent`	`std::string const &` Required. The Clone's parent.
`clone_job`	`google::cloud::vmmigration::v1::CloneJob const &` Required. The clone request body.
`clone_job_id`	`std::string const &` Required. The clone job identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::CloneJob > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.CloneJob proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCloneJob(google::cloud::vmmigration::v1::CreateCloneJobRequest const &, Options)

Initiates a Clone of a specific migrating VM.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CreateCloneJobRequest 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.vmmigration.v1.CreateCloneJobRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::CloneJob > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.CloneJob proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CancelCloneJob(std::string const &, Options)

Initiates the cancellation of a running clone job.

Parameters
Name	Description
`name`	`std::string const &` Required. The clone job id
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::CancelCloneJobResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.CancelCloneJobResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CancelCloneJob(google::cloud::vmmigration::v1::CancelCloneJobRequest const &, Options)

Initiates the cancellation of a running clone job.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CancelCloneJobRequest 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.vmmigration.v1.CancelCloneJobRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::CancelCloneJobResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.CancelCloneJobResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListCloneJobs(std::string const &, Options)

Lists CloneJobs of a given migrating VM.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of source VMs.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::vmmigration::v1::CloneJob >

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.vmmigration.v1.CloneJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCloneJobs(google::cloud::vmmigration::v1::ListCloneJobsRequest, Options)

Lists CloneJobs of a given migrating VM.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ListCloneJobsRequest` 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.vmmigration.v1.ListCloneJobsRequest. 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::vmmigration::v1::CloneJob >

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.vmmigration.v1.CloneJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetCloneJob(std::string const &, Options)

Gets details of a single CloneJob.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the CloneJob.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetCloneJob(google::cloud::vmmigration::v1::GetCloneJobRequest const &, Options)

Gets details of a single CloneJob.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::GetCloneJobRequest 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.vmmigration.v1.GetCloneJobRequest. 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::vmmigration::v1::CloneJob >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.CloneJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateCutoverJob(std::string const &, google::cloud::vmmigration::v1::CutoverJob const &, std::string const &, Options)

Initiates a Cutover of a specific migrating VM.

The returned LRO is completed when the cutover job resource is created and the job is initiated.

Parameters
Name	Description
`parent`	`std::string const &` Required. The Cutover's parent.
`cutover_job`	`google::cloud::vmmigration::v1::CutoverJob const &` Required. The cutover request body.
`cutover_job_id`	`std::string const &` Required. The cutover job identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::CutoverJob > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.CutoverJob proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCutoverJob(google::cloud::vmmigration::v1::CreateCutoverJobRequest const &, Options)

Initiates a Cutover of a specific migrating VM.

The returned LRO is completed when the cutover job resource is created and the job is initiated.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CreateCutoverJobRequest 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.vmmigration.v1.CreateCutoverJobRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::CutoverJob > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.CutoverJob proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CancelCutoverJob(std::string const &, Options)

Initiates the cancellation of a running cutover job.

Parameters
Name	Description
`name`	`std::string const &` Required. The cutover job id
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::CancelCutoverJobResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.CancelCutoverJobResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CancelCutoverJob(google::cloud::vmmigration::v1::CancelCutoverJobRequest const &, Options)

Initiates the cancellation of a running cutover job.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CancelCutoverJobRequest 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.vmmigration.v1.CancelCutoverJobRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::CancelCutoverJobResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.CancelCutoverJobResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListCutoverJobs(std::string const &, Options)

Lists CutoverJobs of a given migrating VM.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of migrating VMs.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::vmmigration::v1::CutoverJob >

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.vmmigration.v1.CutoverJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCutoverJobs(google::cloud::vmmigration::v1::ListCutoverJobsRequest, Options)

Lists CutoverJobs of a given migrating VM.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ListCutoverJobsRequest` 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.vmmigration.v1.ListCutoverJobsRequest. 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::vmmigration::v1::CutoverJob >

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.vmmigration.v1.CutoverJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetCutoverJob(std::string const &, Options)

Gets details of a single CutoverJob.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the CutoverJob.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetCutoverJob(google::cloud::vmmigration::v1::GetCutoverJobRequest const &, Options)

Gets details of a single CutoverJob.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::GetCutoverJobRequest 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.vmmigration.v1.GetCutoverJobRequest. 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::vmmigration::v1::CutoverJob >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.CutoverJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListGroups(std::string const &, Options)

Lists Groups in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of groups.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::vmmigration::v1::Group >

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.vmmigration.v1.Group, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListGroups(google::cloud::vmmigration::v1::ListGroupsRequest, Options)

Lists Groups in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ListGroupsRequest` 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.vmmigration.v1.ListGroupsRequest. 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::vmmigration::v1::Group >

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.vmmigration.v1.Group, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetGroup(std::string const &, Options)

Gets details of a single Group.

Parameters
Name	Description
`name`	`std::string const &` Required. The group name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetGroup(google::cloud::vmmigration::v1::GetGroupRequest const &, Options)

Gets details of a single Group.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::GetGroupRequest 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.vmmigration.v1.GetGroupRequest. 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::vmmigration::v1::Group >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateGroup(std::string const &, google::cloud::vmmigration::v1::Group const &, std::string const &, Options)

Creates a new Group in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The Group's parent.
`group`	`google::cloud::vmmigration::v1::Group const &` Required. The create request body.
`group_id`	`std::string const &` Required. The group identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::Group > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.Group proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateGroup(google::cloud::vmmigration::v1::CreateGroupRequest const &, Options)

Creates a new Group in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CreateGroupRequest 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.vmmigration.v1.CreateGroupRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::Group > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.Group proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateGroup(google::cloud::vmmigration::v1::Group const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Group.

Parameters
Name	Description
`group`	`google::cloud::vmmigration::v1::Group const &` Required. The update request body.
`update_mask`	`google::protobuf::FieldMask const &` Field mask is used to specify the fields to be overwritten in the Group resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::Group > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.Group proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateGroup(google::cloud::vmmigration::v1::UpdateGroupRequest const &, Options)

Updates the parameters of a single Group.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::UpdateGroupRequest 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.vmmigration.v1.UpdateGroupRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::Group > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.Group proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteGroup(std::string const &, Options)

Deletes a single Group.

Parameters
Name	Description
`name`	`std::string const &` Required. The Group name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteGroup(google::cloud::vmmigration::v1::DeleteGroupRequest const &, Options)

Deletes a single Group.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::DeleteGroupRequest 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.vmmigration.v1.DeleteGroupRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AddGroupMigration(std::string const &, Options)

Adds a MigratingVm to a Group.

Parameters
Name	Description
`group`	`std::string const &` Required. The full path name of the Group to add to.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::AddGroupMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.AddGroupMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AddGroupMigration(google::cloud::vmmigration::v1::AddGroupMigrationRequest const &, Options)

Adds a MigratingVm to a Group.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::AddGroupMigrationRequest 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.vmmigration.v1.AddGroupMigrationRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::AddGroupMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.AddGroupMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RemoveGroupMigration(std::string const &, Options)

Removes a MigratingVm from a Group.

Parameters
Name	Description
`group`	`std::string const &` Required. The name of the Group.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::RemoveGroupMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.RemoveGroupMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RemoveGroupMigration(google::cloud::vmmigration::v1::RemoveGroupMigrationRequest const &, Options)

Removes a MigratingVm from a Group.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::RemoveGroupMigrationRequest 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.vmmigration.v1.RemoveGroupMigrationRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::RemoveGroupMigrationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.RemoveGroupMigrationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListTargetProjects(std::string const &, Options)

Lists TargetProjects in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of targets.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::vmmigration::v1::TargetProject >

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.vmmigration.v1.TargetProject, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTargetProjects(google::cloud::vmmigration::v1::ListTargetProjectsRequest, Options)

Lists TargetProjects in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ListTargetProjectsRequest` 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.vmmigration.v1.ListTargetProjectsRequest. 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::vmmigration::v1::TargetProject >

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.vmmigration.v1.TargetProject, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetTargetProject(std::string const &, Options)

Gets details of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`name`	`std::string const &` Required. The TargetProject name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetTargetProject(google::cloud::vmmigration::v1::GetTargetProjectRequest const &, Options)

Gets details of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::GetTargetProjectRequest 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.vmmigration.v1.GetTargetProjectRequest. 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::vmmigration::v1::TargetProject >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.TargetProject) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateTargetProject(std::string const &, google::cloud::vmmigration::v1::TargetProject const &, std::string const &, Options)

Creates a new TargetProject in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`parent`	`std::string const &` Required. The TargetProject's parent.
`target_project`	`google::cloud::vmmigration::v1::TargetProject const &` Required. The create request body.
`target_project_id`	`std::string const &` Required. The target_project identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::TargetProject > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.TargetProject proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTargetProject(google::cloud::vmmigration::v1::CreateTargetProjectRequest const &, Options)

Creates a new TargetProject in a given project.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::CreateTargetProjectRequest 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.vmmigration.v1.CreateTargetProjectRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::TargetProject > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.TargetProject proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTargetProject(google::cloud::vmmigration::v1::TargetProject const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`target_project`	`google::cloud::vmmigration::v1::TargetProject const &` Required. The update request body.
`update_mask`	`google::protobuf::FieldMask const &` Field mask is used to specify the fields to be overwritten in the TargetProject resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::TargetProject > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.TargetProject proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTargetProject(google::cloud::vmmigration::v1::UpdateTargetProjectRequest const &, Options)

Updates the parameters of a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::UpdateTargetProjectRequest 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.vmmigration.v1.UpdateTargetProjectRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::TargetProject > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.TargetProject proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTargetProject(std::string const &, Options)

Deletes a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`name`	`std::string const &` Required. The TargetProject name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTargetProject(google::cloud::vmmigration::v1::DeleteTargetProjectRequest const &, Options)

Deletes a single TargetProject.

NOTE: TargetProject is a global resource; hence the only supported value for location is global.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::DeleteTargetProjectRequest 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.vmmigration.v1.DeleteTargetProjectRequest. 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

future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vmmigration.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListReplicationCycles(std::string const &, Options)

Lists ReplicationCycles in a given MigratingVM.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent, which owns this collection of ReplicationCycles.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::vmmigration::v1::ReplicationCycle >

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.vmmigration.v1.ReplicationCycle, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListReplicationCycles(google::cloud::vmmigration::v1::ListReplicationCyclesRequest, Options)

Lists ReplicationCycles in a given MigratingVM.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::ListReplicationCyclesRequest` 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.vmmigration.v1.ListReplicationCyclesRequest. 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::vmmigration::v1::ReplicationCycle >

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.vmmigration.v1.ReplicationCycle, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetReplicationCycle(std::string const &, Options)

Gets details of a single ReplicationCycle.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the ReplicationCycle.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetReplicationCycle(google::cloud::vmmigration::v1::GetReplicationCycleRequest const &, Options)

Gets details of a single ReplicationCycle.

Parameters
Name	Description
`request`	`google::cloud::vmmigration::v1::GetReplicationCycleRequest 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.vmmigration.v1.GetReplicationCycleRequest. 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::vmmigration::v1::ReplicationCycle >`	the result of the RPC. The response message type (google.cloud.vmmigration.v1.ReplicationCycle) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.