Class RapidMigrationAssessmentClient (2.33.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

RapidMigrationAssessmentClient(RapidMigrationAssessmentClient const &)

Copy and move support

Parameter
Name Description
RapidMigrationAssessmentClient const &

RapidMigrationAssessmentClient(RapidMigrationAssessmentClient &&)

Copy and move support

Parameter
Name Description
RapidMigrationAssessmentClient &&

RapidMigrationAssessmentClient(std::shared_ptr< RapidMigrationAssessmentConnection >, Options)

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

Operators

operator=(RapidMigrationAssessmentClient const &)

Copy and move support

Parameter
Name Description
RapidMigrationAssessmentClient const &
Returns
Type Description
RapidMigrationAssessmentClient &

operator=(RapidMigrationAssessmentClient &&)

Copy and move support

Parameter
Name Description
RapidMigrationAssessmentClient &&
Returns
Type Description
RapidMigrationAssessmentClient &

Functions

CreateCollector(std::string const &, google::cloud::rapidmigrationassessment::v1::Collector const &, std::string const &, Options)

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

Parameters
Name Description
parent std::string const &

Required. Name of the parent (project+location).

collector google::cloud::rapidmigrationassessment::v1::Collector const &

Required. The resource being created.

collector_id std::string const &

Required. Id of the requesting object.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCollector(NoAwaitTag, std::string const &, google::cloud::rapidmigrationassessment::v1::Collector const &, std::string const &, Options)

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
collector google::cloud::rapidmigrationassessment::v1::Collector const &
collector_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCollector(google::cloud::rapidmigrationassessment::v1::CreateCollectorRequest const &, Options)

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::CreateCollectorRequest 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.rapidmigrationassessment.v1.CreateCollectorRequest. 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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCollector(NoAwaitTag, google::cloud::rapidmigrationassessment::v1::CreateCollectorRequest const &, Options)

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::rapidmigrationassessment::v1::CreateCollectorRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCollector(google::longrunning::Operation const &, Options)

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Collector > >

CreateAnnotation(std::string const &, google::cloud::rapidmigrationassessment::v1::Annotation const &, Options)

Creates an Annotation.

Parameters
Name Description
parent std::string const &

Required. Name of the parent (project+location).

annotation google::cloud::rapidmigrationassessment::v1::Annotation const &

Required. The resource being created.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Annotation > >

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.rapidmigrationassessment.v1.Annotation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAnnotation(NoAwaitTag, std::string const &, google::cloud::rapidmigrationassessment::v1::Annotation const &, Options)

Creates an Annotation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
annotation google::cloud::rapidmigrationassessment::v1::Annotation const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateAnnotation(google::cloud::rapidmigrationassessment::v1::CreateAnnotationRequest const &, Options)

Creates an Annotation.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::CreateAnnotationRequest 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.rapidmigrationassessment.v1.CreateAnnotationRequest. 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::rapidmigrationassessment::v1::Annotation > >

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.rapidmigrationassessment.v1.Annotation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAnnotation(NoAwaitTag, google::cloud::rapidmigrationassessment::v1::CreateAnnotationRequest const &, Options)

Creates an Annotation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::rapidmigrationassessment::v1::CreateAnnotationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateAnnotation(google::longrunning::Operation const &, Options)

Creates an Annotation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Annotation > >

GetAnnotation(std::string const &, Options)

Gets details of a single Annotation.

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::rapidmigrationassessment::v1::Annotation >

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

GetAnnotation(google::cloud::rapidmigrationassessment::v1::GetAnnotationRequest const &, Options)

Gets details of a single Annotation.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::GetAnnotationRequest 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.rapidmigrationassessment.v1.GetAnnotationRequest. 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::rapidmigrationassessment::v1::Annotation >

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

ListCollectors(std::string const &, Options)

Lists Collectors in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListCollectorsRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::rapidmigrationassessment::v1::Collector >

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

ListCollectors(google::cloud::rapidmigrationassessment::v1::ListCollectorsRequest, Options)

Lists Collectors in a given project and location.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::ListCollectorsRequest

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.rapidmigrationassessment.v1.ListCollectorsRequest. 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::rapidmigrationassessment::v1::Collector >

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

GetCollector(std::string const &, Options)

Gets details of a single Collector.

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::rapidmigrationassessment::v1::Collector >

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

GetCollector(google::cloud::rapidmigrationassessment::v1::GetCollectorRequest const &, Options)

Gets details of a single Collector.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::GetCollectorRequest 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.rapidmigrationassessment.v1.GetCollectorRequest. 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::rapidmigrationassessment::v1::Collector >

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

UpdateCollector(google::cloud::rapidmigrationassessment::v1::Collector const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Collector.

Parameters
Name Description
collector google::cloud::rapidmigrationassessment::v1::Collector 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 Collector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCollector(NoAwaitTag, google::cloud::rapidmigrationassessment::v1::Collector const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Collector.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
collector google::cloud::rapidmigrationassessment::v1::Collector const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateCollector(google::cloud::rapidmigrationassessment::v1::UpdateCollectorRequest const &, Options)

Updates the parameters of a single Collector.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::UpdateCollectorRequest 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.rapidmigrationassessment.v1.UpdateCollectorRequest. 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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCollector(NoAwaitTag, google::cloud::rapidmigrationassessment::v1::UpdateCollectorRequest const &, Options)

Updates the parameters of a single Collector.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::rapidmigrationassessment::v1::UpdateCollectorRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateCollector(google::longrunning::Operation const &, Options)

Updates the parameters of a single Collector.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Collector > >

DeleteCollector(std::string const &, Options)

Deletes a single Collector - changes state of collector to "Deleting".

Background jobs does final deletion thorugh producer api.

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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCollector(NoAwaitTag, std::string const &, Options)

Deletes a single Collector - changes state of collector to "Deleting".

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCollector(google::cloud::rapidmigrationassessment::v1::DeleteCollectorRequest const &, Options)

Deletes a single Collector - changes state of collector to "Deleting".

Background jobs does final deletion thorugh producer api.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::DeleteCollectorRequest 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.rapidmigrationassessment.v1.DeleteCollectorRequest. 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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCollector(NoAwaitTag, google::cloud::rapidmigrationassessment::v1::DeleteCollectorRequest const &, Options)

Deletes a single Collector - changes state of collector to "Deleting".

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::rapidmigrationassessment::v1::DeleteCollectorRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCollector(google::longrunning::Operation const &, Options)

Deletes a single Collector - changes state of collector to "Deleting".

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Collector > >

ResumeCollector(std::string const &, Options)

Resumes the given collector.

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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ResumeCollector(NoAwaitTag, std::string const &, Options)

Resumes the given collector.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ResumeCollector(google::cloud::rapidmigrationassessment::v1::ResumeCollectorRequest const &, Options)

Resumes the given collector.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::ResumeCollectorRequest 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.rapidmigrationassessment.v1.ResumeCollectorRequest. 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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ResumeCollector(NoAwaitTag, google::cloud::rapidmigrationassessment::v1::ResumeCollectorRequest const &, Options)

Resumes the given collector.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::rapidmigrationassessment::v1::ResumeCollectorRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ResumeCollector(google::longrunning::Operation const &, Options)

Resumes the given collector.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Collector > >

RegisterCollector(std::string const &, Options)

Registers the given collector.

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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RegisterCollector(NoAwaitTag, std::string const &, Options)

Registers the given collector.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RegisterCollector(google::cloud::rapidmigrationassessment::v1::RegisterCollectorRequest const &, Options)

Registers the given collector.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::RegisterCollectorRequest 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.rapidmigrationassessment.v1.RegisterCollectorRequest. 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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RegisterCollector(NoAwaitTag, google::cloud::rapidmigrationassessment::v1::RegisterCollectorRequest const &, Options)

Registers the given collector.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::rapidmigrationassessment::v1::RegisterCollectorRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RegisterCollector(google::longrunning::Operation const &, Options)

Registers the given collector.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Collector > >

PauseCollector(std::string const &, Options)

Pauses the given collector.

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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PauseCollector(NoAwaitTag, std::string const &, Options)

Pauses the given collector.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

PauseCollector(google::cloud::rapidmigrationassessment::v1::PauseCollectorRequest const &, Options)

Pauses the given collector.

Parameters
Name Description
request google::cloud::rapidmigrationassessment::v1::PauseCollectorRequest 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.rapidmigrationassessment.v1.PauseCollectorRequest. 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::rapidmigrationassessment::v1::Collector > >

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.rapidmigrationassessment.v1.Collector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PauseCollector(NoAwaitTag, google::cloud::rapidmigrationassessment::v1::PauseCollectorRequest const &, Options)

Pauses the given collector.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::rapidmigrationassessment::v1::PauseCollectorRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

PauseCollector(google::longrunning::Operation const &, Options)

Pauses the given collector.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::rapidmigrationassessment::v1::Collector > >

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name Description
request google::cloud::location::ListLocationsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. 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::location::Location >

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

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name Description
request google::cloud::location::GetLocationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. 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::location::Location >

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

ListOperations(std::string const &, std::string const &, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation's parent resource.

filter std::string const &

The standard list filter.

opts Options

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

Returns
Type Description
StreamRange< google::longrunning::Operation >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has 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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::ListOperationsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

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

Returns
Type Description
StatusOr< google::longrunning::Operation >

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

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request google::longrunning::GetOperationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. 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::longrunning::Operation >

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

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be deleted.

opts Options

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

Returns
Type Description
Status

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

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::DeleteOperationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.DeleteOperationRequest. 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.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be cancelled.

opts Options

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

Returns
Type Description
Status

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

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request google::longrunning::CancelOperationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.CancelOperationRequest. 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.