Class ConversationProfilesClient (2.34.0-rc)

Service for managing ConversationProfiles.

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

ConversationProfilesClient(ConversationProfilesClient const &)

Copy and move support

Parameter
Name Description
ConversationProfilesClient const &

ConversationProfilesClient(ConversationProfilesClient &&)

Copy and move support

Parameter
Name Description
ConversationProfilesClient &&

ConversationProfilesClient(std::shared_ptr< ConversationProfilesConnection >, Options)

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

Operators

operator=(ConversationProfilesClient const &)

Copy and move support

Parameter
Name Description
ConversationProfilesClient const &
Returns
Type Description
ConversationProfilesClient &

operator=(ConversationProfilesClient &&)

Copy and move support

Parameter
Name Description
ConversationProfilesClient &&
Returns
Type Description
ConversationProfilesClient &

Functions

ListConversationProfiles(std::string const &, Options)

Returns the list of all conversation profiles in the specified project.

Parameters
Name Description
parent std::string const &

Required. The project to list all conversation profiles from. Format: projects/<ProjectID>/locations/<LocationID>.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::dialogflow::v2::ConversationProfile >

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

ListConversationProfiles(google::cloud::dialogflow::v2::ListConversationProfilesRequest, Options)

Returns the list of all conversation profiles in the specified project.

Parameters
Name Description
request google::cloud::dialogflow::v2::ListConversationProfilesRequest

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.dialogflow.v2.ListConversationProfilesRequest. 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::dialogflow::v2::ConversationProfile >

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

GetConversationProfile(std::string const &, Options)

Retrieves the specified conversation profile.

Parameters
Name Description
name std::string const &

Required. The resource name of the conversation profile. Format: projects/<ProjectID>/locations/<LocationID>/conversationProfiles/<Conversation Profile ID>.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::ConversationProfile >

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

GetConversationProfile(google::cloud::dialogflow::v2::GetConversationProfileRequest const &, Options)

Retrieves the specified conversation profile.

Parameters
Name Description
request google::cloud::dialogflow::v2::GetConversationProfileRequest 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.dialogflow.v2.GetConversationProfileRequest. 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::dialogflow::v2::ConversationProfile >

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

CreateConversationProfile(std::string const &, google::cloud::dialogflow::v2::ConversationProfile const &, Options)

Creates a conversation profile in the specified project.

ConversationProfile.create_time and ConversationProfile.update_time aren't populated in the response. You can retrieve them via GetConversationProfile API.

Parameters
Name Description
parent std::string const &

Required. The project to create a conversation profile for. Format: projects/<ProjectID>/locations/<LocationID>.

conversation_profile google::cloud::dialogflow::v2::ConversationProfile const &

Required. The conversation profile to create.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::ConversationProfile >

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

CreateConversationProfile(google::cloud::dialogflow::v2::CreateConversationProfileRequest const &, Options)

Creates a conversation profile in the specified project.

ConversationProfile.create_time and ConversationProfile.update_time aren't populated in the response. You can retrieve them via GetConversationProfile API.

Parameters
Name Description
request google::cloud::dialogflow::v2::CreateConversationProfileRequest 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.dialogflow.v2.CreateConversationProfileRequest. 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::dialogflow::v2::ConversationProfile >

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

UpdateConversationProfile(google::cloud::dialogflow::v2::ConversationProfile const &, google::protobuf::FieldMask const &, Options)

Updates the specified conversation profile.

ConversationProfile.create_time and ConversationProfile.update_time aren't populated in the response. You can retrieve them via GetConversationProfile API.

Parameters
Name Description
conversation_profile google::cloud::dialogflow::v2::ConversationProfile const &

Required. The conversation profile to update.

update_mask google::protobuf::FieldMask const &

Required. The mask to control which fields to update.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::ConversationProfile >

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

UpdateConversationProfile(google::cloud::dialogflow::v2::UpdateConversationProfileRequest const &, Options)

Updates the specified conversation profile.

ConversationProfile.create_time and ConversationProfile.update_time aren't populated in the response. You can retrieve them via GetConversationProfile API.

Parameters
Name Description
request google::cloud::dialogflow::v2::UpdateConversationProfileRequest 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.dialogflow.v2.UpdateConversationProfileRequest. 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::dialogflow::v2::ConversationProfile >

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

DeleteConversationProfile(std::string const &, Options)

Deletes the specified conversation profile.

Parameters
Name Description
name std::string const &

Required. The name of the conversation profile to delete. Format: projects/<ProjectID>/locations/<LocationID>/conversationProfiles/<Conversation Profile ID>.

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.

DeleteConversationProfile(google::cloud::dialogflow::v2::DeleteConversationProfileRequest const &, Options)

Deletes the specified conversation profile.

Parameters
Name Description
request google::cloud::dialogflow::v2::DeleteConversationProfileRequest 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.dialogflow.v2.DeleteConversationProfileRequest. 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.

SetSuggestionFeatureConfig(std::string const &, Options)

Adds or updates a suggestion feature in a conversation profile.

If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Parameters
Name Description
conversation_profile std::string const &

Required. The Conversation Profile to add or update the suggestion feature config. Format: projects/<ProjectID>/locations/<LocationID>/conversationProfiles/<Conversation Profile ID>.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::ConversationProfile > >

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

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

Adds or updates a suggestion feature in a conversation profile.

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
conversation_profile std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

SetSuggestionFeatureConfig(std::string const &, google::cloud::dialogflow::v2::Participant::Role, google::cloud::dialogflow::v2::HumanAgentAssistantConfig::SuggestionFeatureConfig const &, Options)

Adds or updates a suggestion feature in a conversation profile.

If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Parameters
Name Description
conversation_profile std::string const &

Required. The Conversation Profile to add or update the suggestion feature config. Format: projects/<ProjectID>/locations/<LocationID>/conversationProfiles/<Conversation Profile ID>.

participant_role google::cloud::dialogflow::v2::Participant::Role

Required. The participant role to add or update the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.

suggestion_feature_config google::cloud::dialogflow::v2::HumanAgentAssistantConfig::SuggestionFeatureConfig const &

Required. The suggestion feature config to add or update.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::ConversationProfile > >

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

SetSuggestionFeatureConfig(NoAwaitTag, std::string const &, google::cloud::dialogflow::v2::Participant::Role, google::cloud::dialogflow::v2::HumanAgentAssistantConfig::SuggestionFeatureConfig const &, Options)

Adds or updates a suggestion feature in a conversation profile.

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
conversation_profile std::string const &
participant_role google::cloud::dialogflow::v2::Participant::Role
suggestion_feature_config google::cloud::dialogflow::v2::HumanAgentAssistantConfig::SuggestionFeatureConfig const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

SetSuggestionFeatureConfig(google::cloud::dialogflow::v2::SetSuggestionFeatureConfigRequest const &, Options)

Adds or updates a suggestion feature in a conversation profile.

If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Parameters
Name Description
request google::cloud::dialogflow::v2::SetSuggestionFeatureConfigRequest 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.dialogflow.v2.SetSuggestionFeatureConfigRequest. 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::dialogflow::v2::ConversationProfile > >

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

SetSuggestionFeatureConfig(NoAwaitTag, google::cloud::dialogflow::v2::SetSuggestionFeatureConfigRequest const &, Options)

Adds or updates a suggestion feature in a conversation profile.

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::dialogflow::v2::SetSuggestionFeatureConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Adds or updates a suggestion feature in a conversation profile.

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::dialogflow::v2::ConversationProfile > >

ClearSuggestionFeatureConfig(std::string const &, Options)

Clears a suggestion feature from a conversation profile for the given participant role.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Parameters
Name Description
conversation_profile std::string const &

Required. The Conversation Profile to add or update the suggestion feature config. Format: projects/<ProjectID>/locations/<LocationID>/conversationProfiles/<Conversation Profile ID>.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::ConversationProfile > >

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

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

Clears a suggestion feature from a conversation profile for the given participant role.

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
conversation_profile std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ClearSuggestionFeatureConfig(std::string const &, google::cloud::dialogflow::v2::Participant::Role, google::cloud::dialogflow::v2::SuggestionFeature::Type, Options)

Clears a suggestion feature from a conversation profile for the given participant role.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Parameters
Name Description
conversation_profile std::string const &

Required. The Conversation Profile to add or update the suggestion feature config. Format: projects/<ProjectID>/locations/<LocationID>/conversationProfiles/<Conversation Profile ID>.

participant_role google::cloud::dialogflow::v2::Participant::Role

Required. The participant role to remove the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.

suggestion_feature_type google::cloud::dialogflow::v2::SuggestionFeature::Type

Required. The type of the suggestion feature to remove.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::dialogflow::v2::ConversationProfile > >

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

ClearSuggestionFeatureConfig(NoAwaitTag, std::string const &, google::cloud::dialogflow::v2::Participant::Role, google::cloud::dialogflow::v2::SuggestionFeature::Type, Options)

Clears a suggestion feature from a conversation profile for the given participant role.

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
conversation_profile std::string const &
participant_role google::cloud::dialogflow::v2::Participant::Role
suggestion_feature_type google::cloud::dialogflow::v2::SuggestionFeature::Type
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ClearSuggestionFeatureConfig(google::cloud::dialogflow::v2::ClearSuggestionFeatureConfigRequest const &, Options)

Clears a suggestion feature from a conversation profile for the given participant role.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Parameters
Name Description
request google::cloud::dialogflow::v2::ClearSuggestionFeatureConfigRequest 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.dialogflow.v2.ClearSuggestionFeatureConfigRequest. 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::dialogflow::v2::ConversationProfile > >

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

ClearSuggestionFeatureConfig(NoAwaitTag, google::cloud::dialogflow::v2::ClearSuggestionFeatureConfigRequest const &, Options)

Clears a suggestion feature from a conversation profile for the given participant role.

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::dialogflow::v2::ClearSuggestionFeatureConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Clears a suggestion feature from a conversation profile for the given participant role.

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::dialogflow::v2::ConversationProfile > >

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.

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.