Class RapidMigrationAssessmentClient (2.24.0)

Version 2.24.0

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

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(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.

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(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.

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(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.

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(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.

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(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.

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(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.

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(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.