Class MigrationCenterClient (2.16.0)

Service describing handlers for resources.

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

MigrationCenterClient(MigrationCenterClient const &)

Copy and move support

Parameter
Name Description
MigrationCenterClient const &

MigrationCenterClient(MigrationCenterClient &&)

Copy and move support

Parameter
Name Description
MigrationCenterClient &&

MigrationCenterClient(std::shared_ptr< MigrationCenterConnection >, Options)

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

Operators

operator=(MigrationCenterClient const &)

Copy and move support

Parameter
Name Description
MigrationCenterClient const &
Returns
Type Description
MigrationCenterClient &

operator=(MigrationCenterClient &&)

Copy and move support

Parameter
Name Description
MigrationCenterClient &&
Returns
Type Description
MigrationCenterClient &

Functions

ListAssets(std::string const &, Options)

Lists all the assets in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListAssetsRequest.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::Asset >

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

ListAssets(google::cloud::migrationcenter::v1::ListAssetsRequest, Options)

Lists all the assets in a given project and location.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ListAssetsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ListAssetsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::Asset >

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

GetAsset(std::string const &, Options)

Gets the details of an asset.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Asset >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Asset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAsset(google::cloud::migrationcenter::v1::GetAssetRequest const &, Options)

Gets the details of an asset.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetAssetRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetAssetRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Asset >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Asset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateAsset(google::cloud::migrationcenter::v1::Asset const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of an asset.

Parameters
Name Description
asset google::cloud::migrationcenter::v1::Asset const &

Required. The resource being updated.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Asset resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Asset >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Asset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateAsset(google::cloud::migrationcenter::v1::UpdateAssetRequest const &, Options)

Updates the parameters of an asset.

Parameters
Name Description
request google::cloud::migrationcenter::v1::UpdateAssetRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.UpdateAssetRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Asset >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Asset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

BatchUpdateAssets(std::string const &, std::vector< google::cloud::migrationcenter::v1::UpdateAssetRequest > const &, Options)

Updates the parameters of a list of assets.

Parameters
Name Description
parent std::string const &

Required. Parent value for batch asset update.

requests std::vector< google::cloud::migrationcenter::v1::UpdateAssetRequest > const &

Required. The request message specifying the resources to update. A maximum of 1000 assets can be modified in a batch.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::BatchUpdateAssetsResponse >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.BatchUpdateAssetsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

BatchUpdateAssets(google::cloud::migrationcenter::v1::BatchUpdateAssetsRequest const &, Options)

Updates the parameters of a list of assets.

Parameters
Name Description
request google::cloud::migrationcenter::v1::BatchUpdateAssetsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.BatchUpdateAssetsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::BatchUpdateAssetsResponse >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.BatchUpdateAssetsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteAsset(std::string const &, Options)

Deletes an asset.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

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

DeleteAsset(google::cloud::migrationcenter::v1::DeleteAssetRequest const &, Options)

Deletes an asset.

Parameters
Name Description
request google::cloud::migrationcenter::v1::DeleteAssetRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.DeleteAssetRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

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

BatchDeleteAssets(std::string const &, std::vector< std::string > const &, Options)

Deletes list of Assets.

Parameters
Name Description
parent std::string const &

Required. Parent value for batch asset delete.

names std::vector< std::string > const &

Required. The IDs of the assets to delete. A maximum of 1000 assets can be deleted in a batch. Format: projects/{project}/locations/{location}/assets/{name}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

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

BatchDeleteAssets(google::cloud::migrationcenter::v1::BatchDeleteAssetsRequest const &, Options)

Deletes list of Assets.

Parameters
Name Description
request google::cloud::migrationcenter::v1::BatchDeleteAssetsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.BatchDeleteAssetsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

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

ReportAssetFrames(google::cloud::migrationcenter::v1::ReportAssetFramesRequest const &, Options)

Reports a set of frames.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ReportAssetFramesRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ReportAssetFramesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::ReportAssetFramesResponse >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.ReportAssetFramesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AggregateAssetsValues(google::cloud::migrationcenter::v1::AggregateAssetsValuesRequest const &, Options)

Aggregates the requested fields based on provided function.

Parameters
Name Description
request google::cloud::migrationcenter::v1::AggregateAssetsValuesRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.AggregateAssetsValuesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::AggregateAssetsValuesResponse >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.AggregateAssetsValuesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateImportJob(std::string const &, google::cloud::migrationcenter::v1::ImportJob const &, std::string const &, Options)

Creates an import job.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

import_job google::cloud::migrationcenter::v1::ImportJob const &

Required. The resource being created.

import_job_id std::string const &

Required. ID of the import job.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::ImportJob > >

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

CreateImportJob(google::cloud::migrationcenter::v1::CreateImportJobRequest const &, Options)

Creates an import job.

Parameters
Name Description
request google::cloud::migrationcenter::v1::CreateImportJobRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.CreateImportJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::ImportJob > >

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

ListImportJobs(std::string const &, Options)

Lists all import jobs.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListImportJobsRequest.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::ImportJob >

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

ListImportJobs(google::cloud::migrationcenter::v1::ListImportJobsRequest, Options)

Lists all import jobs.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ListImportJobsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ListImportJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::ImportJob >

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

GetImportJob(std::string const &, Options)

Gets the details of an import job.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::ImportJob >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.ImportJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetImportJob(google::cloud::migrationcenter::v1::GetImportJobRequest const &, Options)

Gets the details of an import job.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetImportJobRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetImportJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::ImportJob >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.ImportJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteImportJob(std::string const &, Options)

Deletes an import job.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

DeleteImportJob(google::cloud::migrationcenter::v1::DeleteImportJobRequest const &, Options)

Deletes an import job.

Parameters
Name Description
request google::cloud::migrationcenter::v1::DeleteImportJobRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.DeleteImportJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

UpdateImportJob(google::cloud::migrationcenter::v1::ImportJob const &, google::protobuf::FieldMask const &, Options)

Updates an import job.

Parameters
Name Description
import_job google::cloud::migrationcenter::v1::ImportJob const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Asset resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::ImportJob > >

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

UpdateImportJob(google::cloud::migrationcenter::v1::UpdateImportJobRequest const &, Options)

Updates an import job.

Parameters
Name Description
request google::cloud::migrationcenter::v1::UpdateImportJobRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.UpdateImportJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::ImportJob > >

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

ValidateImportJob(std::string const &, Options)

Validates an import job.

Parameters
Name Description
name std::string const &

Required. The name of the import job to validate.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

ValidateImportJob(google::cloud::migrationcenter::v1::ValidateImportJobRequest const &, Options)

Validates an import job.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ValidateImportJobRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ValidateImportJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

RunImportJob(std::string const &, Options)

Runs an import job.

Parameters
Name Description
name std::string const &

Required. The name of the import job to run.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

RunImportJob(google::cloud::migrationcenter::v1::RunImportJobRequest const &, Options)

Runs an import job.

Parameters
Name Description
request google::cloud::migrationcenter::v1::RunImportJobRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.RunImportJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

GetImportDataFile(std::string const &, Options)

Gets an import data file.

Parameters
Name Description
name std::string const &

Required. Name of the ImportDataFile.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::ImportDataFile >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.ImportDataFile) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetImportDataFile(google::cloud::migrationcenter::v1::GetImportDataFileRequest const &, Options)

Gets an import data file.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetImportDataFileRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetImportDataFileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::ImportDataFile >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.ImportDataFile) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListImportDataFiles(std::string const &, Options)

List import data files.

Parameters
Name Description
parent std::string const &

Required. Name of the parent of the ImportDataFiles resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::ImportDataFile >

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

ListImportDataFiles(google::cloud::migrationcenter::v1::ListImportDataFilesRequest, Options)

List import data files.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ListImportDataFilesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ListImportDataFilesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::ImportDataFile >

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

CreateImportDataFile(std::string const &, google::cloud::migrationcenter::v1::ImportDataFile const &, std::string const &, Options)

Creates an import data file.

Parameters
Name Description
parent std::string const &

Required. Name of the parent of the ImportDataFile.

import_data_file google::cloud::migrationcenter::v1::ImportDataFile const &

Required. The resource being created.

import_data_file_id std::string const &

Required. The ID of the new data file.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::ImportDataFile > >

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

CreateImportDataFile(google::cloud::migrationcenter::v1::CreateImportDataFileRequest const &, Options)

Creates an import data file.

Parameters
Name Description
request google::cloud::migrationcenter::v1::CreateImportDataFileRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.CreateImportDataFileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::ImportDataFile > >

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

DeleteImportDataFile(std::string const &, Options)

Delete an import data file.

Parameters
Name Description
name std::string const &

Required. Name of the ImportDataFile to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

DeleteImportDataFile(google::cloud::migrationcenter::v1::DeleteImportDataFileRequest const &, Options)

Delete an import data file.

Parameters
Name Description
request google::cloud::migrationcenter::v1::DeleteImportDataFileRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.DeleteImportDataFileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

ListGroups(std::string const &, Options)

Lists all groups in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListGroupsRequest.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::Group >

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

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

Lists all groups in a given project and location.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ListGroupsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ListGroupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::Group >

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

GetGroup(std::string const &, Options)

Gets the details of a group.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Group >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Gets the details of a group.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetGroupRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Group >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateGroup(std::string const &, google::cloud::migrationcenter::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. Value for parent.

group google::cloud::migrationcenter::v1::Group const &

Required. The group resource being created.

group_id std::string const &

Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Group > >

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

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

Creates a new group in a given project and location.

Parameters
Name Description
request google::cloud::migrationcenter::v1::CreateGroupRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.CreateGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Group > >

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

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

Updates the parameters of a group.

Parameters
Name Description
group google::cloud::migrationcenter::v1::Group const &

Required. The group resource being updated.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Group resource by the update. The values 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. A single * value in the mask lets you to overwrite all fields.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Group > >

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

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

Updates the parameters of a group.

Parameters
Name Description
request google::cloud::migrationcenter::v1::UpdateGroupRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.UpdateGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Group > >

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

DeleteGroup(std::string const &, Options)

Deletes a group.

Parameters
Name Description
name std::string const &

Required. Name of the group resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

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

Deletes a group.

Parameters
Name Description
request google::cloud::migrationcenter::v1::DeleteGroupRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.DeleteGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

AddAssetsToGroup(std::string const &, Options)

Adds assets to a group.

Parameters
Name Description
group std::string const &

Required. Group reference.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Group > >

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

AddAssetsToGroup(google::cloud::migrationcenter::v1::AddAssetsToGroupRequest const &, Options)

Adds assets to a group.

Parameters
Name Description
request google::cloud::migrationcenter::v1::AddAssetsToGroupRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.AddAssetsToGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Group > >

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

RemoveAssetsFromGroup(std::string const &, Options)

Removes assets from a group.

Parameters
Name Description
group std::string const &

Required. Group reference.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Group > >

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

RemoveAssetsFromGroup(google::cloud::migrationcenter::v1::RemoveAssetsFromGroupRequest const &, Options)

Removes assets from a group.

Parameters
Name Description
request google::cloud::migrationcenter::v1::RemoveAssetsFromGroupRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.RemoveAssetsFromGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Group > >

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

ListErrorFrames(std::string const &, Options)

Lists all error frames in a given source and location.

Parameters
Name Description
parent std::string const &

Required. Parent value (the source) for ListErrorFramesRequest.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::ErrorFrame >

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

ListErrorFrames(google::cloud::migrationcenter::v1::ListErrorFramesRequest, Options)

Lists all error frames in a given source and location.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ListErrorFramesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ListErrorFramesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::ErrorFrame >

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

GetErrorFrame(std::string const &, Options)

Gets the details of an error frame.

Parameters
Name Description
name std::string const &

Required. The name of the frame to retrieve. Format: projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::ErrorFrame >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.ErrorFrame) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetErrorFrame(google::cloud::migrationcenter::v1::GetErrorFrameRequest const &, Options)

Gets the details of an error frame.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetErrorFrameRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetErrorFrameRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::ErrorFrame >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.ErrorFrame) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListSources(std::string const &, Options)

Lists all the sources in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListSourcesRequest.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::Source >

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

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

Lists all the sources in a given project and location.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ListSourcesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ListSourcesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::Source >

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

GetSource(std::string const &, Options)

Gets the details of a source.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Source >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Gets the details of a source.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetSourceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetSourceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Source >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSource(std::string const &, google::cloud::migrationcenter::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. Value for parent.

source google::cloud::migrationcenter::v1::Source const &

Required. The resource being created.

source_id std::string const &

Required. User specified ID for the source. It will become the last component of the source name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Source > >

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

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

Creates a new source in a given project and location.

Parameters
Name Description
request google::cloud::migrationcenter::v1::CreateSourceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.CreateSourceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Source > >

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

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

Updates the parameters of a source.

Parameters
Name Description
source google::cloud::migrationcenter::v1::Source const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Source resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Source > >

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

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

Updates the parameters of a source.

Parameters
Name Description
request google::cloud::migrationcenter::v1::UpdateSourceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.UpdateSourceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Source > >

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

DeleteSource(std::string const &, Options)

Deletes a source.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

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

Deletes a source.

Parameters
Name Description
request google::cloud::migrationcenter::v1::DeleteSourceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.DeleteSourceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

ListPreferenceSets(std::string const &, Options)

Lists all the preference sets in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListPreferenceSetsRequest.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::PreferenceSet >

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

ListPreferenceSets(google::cloud::migrationcenter::v1::ListPreferenceSetsRequest, Options)

Lists all the preference sets in a given project and location.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ListPreferenceSetsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ListPreferenceSetsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::PreferenceSet >

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

GetPreferenceSet(std::string const &, Options)

Gets the details of a preference set.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::PreferenceSet >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.PreferenceSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPreferenceSet(google::cloud::migrationcenter::v1::GetPreferenceSetRequest const &, Options)

Gets the details of a preference set.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetPreferenceSetRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetPreferenceSetRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::PreferenceSet >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.PreferenceSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreatePreferenceSet(std::string const &, google::cloud::migrationcenter::v1::PreferenceSet const &, std::string const &, Options)

Creates a new preference set in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

preference_set google::cloud::migrationcenter::v1::PreferenceSet const &

Required. The preference set resource being created.

preference_set_id std::string const &

Required. User specified ID for the preference set. It will become the last component of the preference set name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::PreferenceSet > >

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

CreatePreferenceSet(google::cloud::migrationcenter::v1::CreatePreferenceSetRequest const &, Options)

Creates a new preference set in a given project and location.

Parameters
Name Description
request google::cloud::migrationcenter::v1::CreatePreferenceSetRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.CreatePreferenceSetRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::PreferenceSet > >

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

UpdatePreferenceSet(google::cloud::migrationcenter::v1::PreferenceSet const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a preference set.

Parameters
Name Description
preference_set google::cloud::migrationcenter::v1::PreferenceSet const &

Required. The preference set resource being updated.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the PreferenceSet resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::PreferenceSet > >

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

UpdatePreferenceSet(google::cloud::migrationcenter::v1::UpdatePreferenceSetRequest const &, Options)

Updates the parameters of a preference set.

Parameters
Name Description
request google::cloud::migrationcenter::v1::UpdatePreferenceSetRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.UpdatePreferenceSetRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::PreferenceSet > >

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

DeletePreferenceSet(std::string const &, Options)

Deletes a preference set.

Parameters
Name Description
name std::string const &

Required. Name of the group resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

DeletePreferenceSet(google::cloud::migrationcenter::v1::DeletePreferenceSetRequest const &, Options)

Deletes a preference set.

Parameters
Name Description
request google::cloud::migrationcenter::v1::DeletePreferenceSetRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.DeletePreferenceSetRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

GetSettings(std::string const &, Options)

Gets the details of regional settings.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Settings >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Settings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSettings(google::cloud::migrationcenter::v1::GetSettingsRequest const &, Options)

Gets the details of regional settings.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetSettingsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetSettingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Settings >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Settings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateSettings(google::cloud::migrationcenter::v1::Settings const &, google::protobuf::FieldMask const &, Options)

Updates the regional-level project settings.

Parameters
Name Description
settings google::cloud::migrationcenter::v1::Settings const &

Required. The project settings resource being updated.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Settings resource by the update. The values specified in the update_mask field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Settings > >

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

UpdateSettings(google::cloud::migrationcenter::v1::UpdateSettingsRequest const &, Options)

Updates the regional-level project settings.

Parameters
Name Description
request google::cloud::migrationcenter::v1::UpdateSettingsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.UpdateSettingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Settings > >

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

CreateReportConfig(std::string const &, google::cloud::migrationcenter::v1::ReportConfig const &, std::string const &, Options)

Creates a report configuration.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

report_config google::cloud::migrationcenter::v1::ReportConfig const &

Required. The report config set resource being created.

report_config_id std::string const &

Required. User specified ID for the report config. It will become the last component of the report config name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: a-z?.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::ReportConfig > >

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

CreateReportConfig(google::cloud::migrationcenter::v1::CreateReportConfigRequest const &, Options)

Creates a report configuration.

Parameters
Name Description
request google::cloud::migrationcenter::v1::CreateReportConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.CreateReportConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::ReportConfig > >

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

GetReportConfig(std::string const &, Options)

Gets details of a single ReportConfig.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::ReportConfig >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.ReportConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetReportConfig(google::cloud::migrationcenter::v1::GetReportConfigRequest const &, Options)

Gets details of a single ReportConfig.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetReportConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetReportConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::ReportConfig >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.ReportConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListReportConfigs(std::string const &, Options)

Lists ReportConfigs in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListReportConfigsRequest.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::ReportConfig >

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

ListReportConfigs(google::cloud::migrationcenter::v1::ListReportConfigsRequest, Options)

Lists ReportConfigs in a given project and location.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ListReportConfigsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ListReportConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::ReportConfig >

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

DeleteReportConfig(std::string const &, Options)

Deletes a ReportConfig.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

DeleteReportConfig(google::cloud::migrationcenter::v1::DeleteReportConfigRequest const &, Options)

Deletes a ReportConfig.

Parameters
Name Description
request google::cloud::migrationcenter::v1::DeleteReportConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.DeleteReportConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

CreateReport(std::string const &, google::cloud::migrationcenter::v1::Report const &, std::string const &, Options)

Creates a report.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

report google::cloud::migrationcenter::v1::Report const &

Required. The report resource being created.

report_id std::string const &

Required. User specified id for the report. It will become the last component of the report name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The id must match the regular expression: a-z?.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Report > >

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

CreateReport(google::cloud::migrationcenter::v1::CreateReportRequest const &, Options)

Creates a report.

Parameters
Name Description
request google::cloud::migrationcenter::v1::CreateReportRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.CreateReportRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::Report > >

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

GetReport(std::string const &, Options)

Gets details of a single Report.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Report >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Report) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetReport(google::cloud::migrationcenter::v1::GetReportRequest const &, Options)

Gets details of a single Report.

Parameters
Name Description
request google::cloud::migrationcenter::v1::GetReportRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.GetReportRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::migrationcenter::v1::Report >

the result of the RPC. The response message type (google.cloud.migrationcenter.v1.Report) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListReports(std::string const &, Options)

Lists Reports in a given ReportConfig.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListReportsRequest.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::Report >

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

ListReports(google::cloud::migrationcenter::v1::ListReportsRequest, Options)

Lists Reports in a given ReportConfig.

Parameters
Name Description
request google::cloud::migrationcenter::v1::ListReportsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.ListReportsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::migrationcenter::v1::Report >

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

DeleteReport(std::string const &, Options)

Deletes a Report.

Parameters
Name Description
name std::string const &

Required. Name of the resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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

DeleteReport(google::cloud::migrationcenter::v1::DeleteReportRequest const &, Options)

Deletes a Report.

Parameters
Name Description
request google::cloud::migrationcenter::v1::DeleteReportRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.migrationcenter.v1.DeleteReportRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::migrationcenter::v1::OperationMetadata > >

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