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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateSource(NoAwaitTag, std::string const &, google::cloud::vmmigration::v1::Source const &, std::string const &, Options)
Creates a new Source in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
source |
google::cloud::vmmigration::v1::Source const &
|
source_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateSource(NoAwaitTag, google::cloud::vmmigration::v1::CreateSourceRequest const &, Options)
Creates a new Source in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CreateSourceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateSource(google::longrunning::Operation const &, Options)
Creates a new Source in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
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 > > |
A |
UpdateSource(NoAwaitTag, google::cloud::vmmigration::v1::Source const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Source.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
source |
google::cloud::vmmigration::v1::Source const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateSource(NoAwaitTag, google::cloud::vmmigration::v1::UpdateSourceRequest const &, Options)
Updates the parameters of a single Source.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::UpdateSourceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateSource(google::longrunning::Operation const &, Options)
Updates the parameters of a single Source.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
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 |
DeleteSource(NoAwaitTag, std::string const &, Options)
Deletes a single Source.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteSource(NoAwaitTag, google::cloud::vmmigration::v1::DeleteSourceRequest const &, Options)
Deletes a single Source.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::DeleteSourceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteSource(google::longrunning::Operation const &, Options)
Deletes a single Source.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > > |
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 |
FetchInventory(google::cloud::vmmigration::v1::FetchInventoryRequest 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 |
request |
google::cloud::vmmigration::v1::FetchInventoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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. |
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 |
CreateUtilizationReport(NoAwaitTag, std::string const &, google::cloud::vmmigration::v1::UtilizationReport const &, std::string const &, Options)
Creates a new UtilizationReport.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
utilization_report |
google::cloud::vmmigration::v1::UtilizationReport const &
|
utilization_report_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateUtilizationReport(NoAwaitTag, google::cloud::vmmigration::v1::CreateUtilizationReportRequest const &, Options)
Creates a new UtilizationReport.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CreateUtilizationReportRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateUtilizationReport(google::longrunning::Operation const &, Options)
Creates a new UtilizationReport.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::UtilizationReport > > |
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 |
DeleteUtilizationReport(NoAwaitTag, std::string const &, Options)
Deletes a single Utilization Report.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteUtilizationReport(NoAwaitTag, google::cloud::vmmigration::v1::DeleteUtilizationReportRequest const &, Options)
Deletes a single Utilization Report.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::DeleteUtilizationReportRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteUtilizationReport(google::longrunning::Operation const &, Options)
Deletes a single Utilization Report.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > > |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
CreateDatacenterConnector(NoAwaitTag, std::string const &, google::cloud::vmmigration::v1::DatacenterConnector const &, std::string const &, Options)
Creates a new DatacenterConnector in a given Source.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
datacenter_connector |
google::cloud::vmmigration::v1::DatacenterConnector const &
|
datacenter_connector_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateDatacenterConnector(NoAwaitTag, google::cloud::vmmigration::v1::CreateDatacenterConnectorRequest const &, Options)
Creates a new DatacenterConnector in a given Source.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CreateDatacenterConnectorRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateDatacenterConnector(google::longrunning::Operation const &, Options)
Creates a new DatacenterConnector in a given Source.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::DatacenterConnector > > |
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 |
DeleteDatacenterConnector(NoAwaitTag, std::string const &, Options)
Deletes a single DatacenterConnector.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteDatacenterConnector(NoAwaitTag, google::cloud::vmmigration::v1::DeleteDatacenterConnectorRequest const &, Options)
Deletes a single DatacenterConnector.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::DeleteDatacenterConnectorRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteDatacenterConnector(google::longrunning::Operation const &, Options)
Deletes a single DatacenterConnector.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > > |
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 |
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 |
UpgradeAppliance(NoAwaitTag, google::cloud::vmmigration::v1::UpgradeApplianceRequest const &, Options)
Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::UpgradeApplianceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpgradeAppliance(google::longrunning::Operation const &, Options)
Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::UpgradeApplianceResponse > > |
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 |
CreateMigratingVm(NoAwaitTag, std::string const &, google::cloud::vmmigration::v1::MigratingVm const &, std::string const &, Options)
Creates a new MigratingVm in a given Source.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
migrating_vm |
google::cloud::vmmigration::v1::MigratingVm const &
|
migrating_vm_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateMigratingVm(NoAwaitTag, google::cloud::vmmigration::v1::CreateMigratingVmRequest const &, Options)
Creates a new MigratingVm in a given Source.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CreateMigratingVmRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateMigratingVm(google::longrunning::Operation const &, Options)
Creates a new MigratingVm in a given Source.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::MigratingVm > > |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
UpdateMigratingVm(NoAwaitTag, google::cloud::vmmigration::v1::MigratingVm const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single MigratingVm.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
migrating_vm |
google::cloud::vmmigration::v1::MigratingVm const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateMigratingVm(NoAwaitTag, google::cloud::vmmigration::v1::UpdateMigratingVmRequest const &, Options)
Updates the parameters of a single MigratingVm.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::UpdateMigratingVmRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateMigratingVm(google::longrunning::Operation const &, Options)
Updates the parameters of a single MigratingVm.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::MigratingVm > > |
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 |
DeleteMigratingVm(NoAwaitTag, std::string const &, Options)
Deletes a single MigratingVm.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteMigratingVm(NoAwaitTag, google::cloud::vmmigration::v1::DeleteMigratingVmRequest const &, Options)
Deletes a single MigratingVm.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::DeleteMigratingVmRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteMigratingVm(google::longrunning::Operation const &, Options)
Deletes a single MigratingVm.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > > |
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 |
StartMigration(NoAwaitTag, std::string const &, Options)
Starts migration for a VM.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
migrating_vm |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
StartMigration(NoAwaitTag, google::cloud::vmmigration::v1::StartMigrationRequest const &, Options)
Starts migration for a VM.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::StartMigrationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
StartMigration(google::longrunning::Operation const &, Options)
Starts migration for a VM.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::StartMigrationResponse > > |
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 |
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 |
ResumeMigration(NoAwaitTag, google::cloud::vmmigration::v1::ResumeMigrationRequest const &, Options)
Resumes a migration for a VM.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::ResumeMigrationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ResumeMigration(google::longrunning::Operation const &, Options)
Resumes a migration for a VM.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::ResumeMigrationResponse > > |
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 |
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 |
PauseMigration(NoAwaitTag, google::cloud::vmmigration::v1::PauseMigrationRequest const &, Options)
Pauses a migration for a VM.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::PauseMigrationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
PauseMigration(google::longrunning::Operation const &, Options)
Pauses a migration for a VM.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::PauseMigrationResponse > > |
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 |
FinalizeMigration(NoAwaitTag, std::string const &, Options)
Marks a migration as completed, deleting migration resources that are no longer being used.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
migrating_vm |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
FinalizeMigration(NoAwaitTag, google::cloud::vmmigration::v1::FinalizeMigrationRequest const &, Options)
Marks a migration as completed, deleting migration resources that are no longer being used.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::FinalizeMigrationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
FinalizeMigration(google::longrunning::Operation const &, Options)
Marks a migration as completed, deleting migration resources that are no longer being used.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::FinalizeMigrationResponse > > |
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 |
CreateCloneJob(NoAwaitTag, std::string const &, google::cloud::vmmigration::v1::CloneJob const &, std::string const &, Options)
Initiates a Clone of a specific migrating VM.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
clone_job |
google::cloud::vmmigration::v1::CloneJob const &
|
clone_job_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateCloneJob(NoAwaitTag, google::cloud::vmmigration::v1::CreateCloneJobRequest const &, Options)
Initiates a Clone of a specific migrating VM.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CreateCloneJobRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateCloneJob(google::longrunning::Operation const &, Options)
Initiates a Clone of a specific migrating VM.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::CloneJob > > |
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 |
CancelCloneJob(NoAwaitTag, std::string const &, Options)
Initiates the cancellation of a running clone job.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CancelCloneJob(NoAwaitTag, google::cloud::vmmigration::v1::CancelCloneJobRequest const &, Options)
Initiates the cancellation of a running clone job.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CancelCloneJobRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CancelCloneJob(google::longrunning::Operation const &, Options)
Initiates the cancellation of a running clone job.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::CancelCloneJobResponse > > |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateCutoverJob(NoAwaitTag, std::string const &, google::cloud::vmmigration::v1::CutoverJob const &, std::string const &, Options)
Initiates a Cutover of a specific migrating VM.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
cutover_job |
google::cloud::vmmigration::v1::CutoverJob const &
|
cutover_job_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateCutoverJob(NoAwaitTag, google::cloud::vmmigration::v1::CreateCutoverJobRequest const &, Options)
Initiates a Cutover of a specific migrating VM.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CreateCutoverJobRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateCutoverJob(google::longrunning::Operation const &, Options)
Initiates a Cutover of a specific migrating VM.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::CutoverJob > > |
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 |
CancelCutoverJob(NoAwaitTag, std::string const &, Options)
Initiates the cancellation of a running cutover job.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CancelCutoverJob(NoAwaitTag, google::cloud::vmmigration::v1::CancelCutoverJobRequest const &, Options)
Initiates the cancellation of a running cutover job.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CancelCutoverJobRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CancelCutoverJob(google::longrunning::Operation const &, Options)
Initiates the cancellation of a running cutover job.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::CancelCutoverJobResponse > > |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateGroup(NoAwaitTag, std::string const &, google::cloud::vmmigration::v1::Group const &, std::string const &, Options)
Creates a new Group in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
group |
google::cloud::vmmigration::v1::Group const &
|
group_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateGroup(NoAwaitTag, google::cloud::vmmigration::v1::CreateGroupRequest const &, Options)
Creates a new Group in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CreateGroupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateGroup(google::longrunning::Operation const &, Options)
Creates a new Group in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::Group > > |
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 |
UpdateGroup(NoAwaitTag, google::cloud::vmmigration::v1::Group const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Group.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
group |
google::cloud::vmmigration::v1::Group const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateGroup(NoAwaitTag, google::cloud::vmmigration::v1::UpdateGroupRequest const &, Options)
Updates the parameters of a single Group.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::UpdateGroupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateGroup(google::longrunning::Operation const &, Options)
Updates the parameters of a single Group.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::Group > > |
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 |
DeleteGroup(NoAwaitTag, std::string const &, Options)
Deletes a single Group.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteGroup(NoAwaitTag, google::cloud::vmmigration::v1::DeleteGroupRequest const &, Options)
Deletes a single Group.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::DeleteGroupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteGroup(google::longrunning::Operation const &, Options)
Deletes a single Group.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > > |
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 |
AddGroupMigration(NoAwaitTag, std::string const &, Options)
Adds a MigratingVm to a Group.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
group |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
AddGroupMigration(NoAwaitTag, google::cloud::vmmigration::v1::AddGroupMigrationRequest const &, Options)
Adds a MigratingVm to a Group.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::AddGroupMigrationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
AddGroupMigration(google::longrunning::Operation const &, Options)
Adds a MigratingVm to a Group.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::AddGroupMigrationResponse > > |
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 |
RemoveGroupMigration(NoAwaitTag, std::string const &, Options)
Removes a MigratingVm from a Group.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
group |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
RemoveGroupMigration(NoAwaitTag, google::cloud::vmmigration::v1::RemoveGroupMigrationRequest const &, Options)
Removes a MigratingVm from a Group.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::RemoveGroupMigrationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RemoveGroupMigration(google::longrunning::Operation const &, Options)
Removes a MigratingVm from a Group.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::RemoveGroupMigrationResponse > > |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateTargetProject(NoAwaitTag, std::string const &, google::cloud::vmmigration::v1::TargetProject const &, std::string const &, Options)
Creates a new TargetProject in a given project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
target_project |
google::cloud::vmmigration::v1::TargetProject const &
|
target_project_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateTargetProject(NoAwaitTag, google::cloud::vmmigration::v1::CreateTargetProjectRequest const &, Options)
Creates a new TargetProject in a given project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::CreateTargetProjectRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateTargetProject(google::longrunning::Operation const &, Options)
Creates a new TargetProject in a given project.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::TargetProject > > |
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 |
UpdateTargetProject(NoAwaitTag, google::cloud::vmmigration::v1::TargetProject const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single TargetProject.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
target_project |
google::cloud::vmmigration::v1::TargetProject const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateTargetProject(NoAwaitTag, google::cloud::vmmigration::v1::UpdateTargetProjectRequest const &, Options)
Updates the parameters of a single TargetProject.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::UpdateTargetProjectRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateTargetProject(google::longrunning::Operation const &, Options)
Updates the parameters of a single TargetProject.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::TargetProject > > |
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 |
DeleteTargetProject(NoAwaitTag, std::string const &, Options)
Deletes a single TargetProject.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteTargetProject(NoAwaitTag, google::cloud::vmmigration::v1::DeleteTargetProjectRequest const &, Options)
Deletes a single TargetProject.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::vmmigration::v1::DeleteTargetProjectRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteTargetProject(google::longrunning::Operation const &, Options)
Deletes a single TargetProject.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::vmmigration::v1::OperationMetadata > > |
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 |
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 |
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 |
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 |
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 |
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 |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::DeleteOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |