Class ConversationModelsClient (2.31.0)

Manages a collection of models for human agent assistant.

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

ConversationModelsClient(ConversationModelsClient const &)

Copy and move support

Parameter
Name Description
ConversationModelsClient const &

ConversationModelsClient(ConversationModelsClient &&)

Copy and move support

Parameter
Name Description
ConversationModelsClient &&

ConversationModelsClient(std::shared_ptr< ConversationModelsConnection >, Options)

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

Operators

operator=(ConversationModelsClient const &)

Copy and move support

Parameter
Name Description
ConversationModelsClient const &
Returns
Type Description
ConversationModelsClient &

operator=(ConversationModelsClient &&)

Copy and move support

Parameter
Name Description
ConversationModelsClient &&
Returns
Type Description
ConversationModelsClient &

Functions

CreateConversationModel(std::string const &, google::cloud::dialogflow::v2::ConversationModel const &, Options)

Creates a model.

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

Parameters
Name Description
parent std::string const &

The project to create conversation model for. Format: projects/<ProjectID>
conversation_model google::cloud::dialogflow::v2::ConversationModel const &

Required. The conversation model to create.

opts Options

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

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

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

CreateConversationModel(NoAwaitTag, std::string const &, google::cloud::dialogflow::v2::ConversationModel const &, Options)

Creates a model.

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

CreateConversationModel(google::cloud::dialogflow::v2::CreateConversationModelRequest const &, Options)

Creates a model.

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::CreateConversationModelRequest 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.CreateConversationModelRequest. 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::ConversationModel > >

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

CreateConversationModel(NoAwaitTag, google::cloud::dialogflow::v2::CreateConversationModelRequest const &, Options)

Creates a model.

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

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

Creates a model.

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::ConversationModel > >

GetConversationModel(std::string const &, Options)

Gets conversation model.

Parameters
Name Description
name std::string const &

Required. The conversation model to retrieve. Format: projects/<ProjectID>/conversationModels/<Conversation Model ID>
opts Options

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

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

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

GetConversationModel(google::cloud::dialogflow::v2::GetConversationModelRequest const &, Options)

Gets conversation model.

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

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

ListConversationModels(std::string const &, Options)

Lists conversation models.

Parameters
Name Description
parent std::string const &

Required. The project to list all conversation models for. Format: projects/<ProjectID>
opts Options

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

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

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

ListConversationModels(google::cloud::dialogflow::v2::ListConversationModelsRequest, Options)

Lists conversation models.

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

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.ListConversationModelsRequest. 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::ConversationModel >

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

DeleteConversationModel(std::string const &, Options)

Deletes a model.

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

Parameters
Name Description
name std::string const &

Required. The conversation model to delete. Format: projects/<ProjectID>/conversationModels/<Conversation Model ID>
opts Options

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

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

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

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

Deletes a model.

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 >

DeleteConversationModel(google::cloud::dialogflow::v2::DeleteConversationModelRequest const &, Options)

Deletes a model.

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::DeleteConversationModelRequest 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.DeleteConversationModelRequest. 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::DeleteConversationModelOperationMetadata > >

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

DeleteConversationModel(NoAwaitTag, google::cloud::dialogflow::v2::DeleteConversationModelRequest const &, Options)

Deletes a model.

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

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

Deletes a model.

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::DeleteConversationModelOperationMetadata > >

DeployConversationModel(google::cloud::dialogflow::v2::DeployConversationModelRequest const &, Options)

Deploys a model.

If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed.

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::DeployConversationModelRequest 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.DeployConversationModelRequest. 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::DeployConversationModelOperationMetadata > >

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

DeployConversationModel(NoAwaitTag, google::cloud::dialogflow::v2::DeployConversationModelRequest const &, Options)

Deploys a model.

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

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

Deploys a model.

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::DeployConversationModelOperationMetadata > >

UndeployConversationModel(google::cloud::dialogflow::v2::UndeployConversationModelRequest const &, Options)

Undeploys a model.

If the model is not deployed this method has no effect. If the model is currently being used:

  • For article suggestion, article suggestion will fallback to the default model if model is undeployed.

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::UndeployConversationModelRequest 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.UndeployConversationModelRequest. 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::UndeployConversationModelOperationMetadata > >

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

UndeployConversationModel(NoAwaitTag, google::cloud::dialogflow::v2::UndeployConversationModelRequest const &, Options)

Undeploys a model.

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

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

Undeploys a model.

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::UndeployConversationModelOperationMetadata > >

GetConversationModelEvaluation(std::string const &, Options)

Gets an evaluation of conversation model.

Parameters
Name Description
name std::string const &

Required. The conversation model evaluation resource name. Format: projects/<ProjectID>/conversationModels/<Conversation Model ID>/evaluations/<Evaluation ID>
opts Options

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

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

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

GetConversationModelEvaluation(google::cloud::dialogflow::v2::GetConversationModelEvaluationRequest const &, Options)

Gets an evaluation of conversation model.

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

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

ListConversationModelEvaluations(std::string const &, Options)

Lists evaluations of a conversation model.

Parameters
Name Description
parent std::string const &

Required. The conversation model resource name. Format: projects/<ProjectID>/conversationModels/<Conversation Model ID>
opts Options

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

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

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

ListConversationModelEvaluations(google::cloud::dialogflow::v2::ListConversationModelEvaluationsRequest, Options)

Lists evaluations of a conversation model.

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

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.ListConversationModelEvaluationsRequest. 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::ConversationModelEvaluation >

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

CreateConversationModelEvaluation(std::string const &, google::cloud::dialogflow::v2::ConversationModelEvaluation const &, Options)

Creates evaluation of a conversation model.

Parameters
Name Description
parent std::string const &

Required. The conversation model resource name. Format: projects/<ProjectID>/locations/<LocationID>/conversationModels/<Conversation Model ID>
conversation_model_evaluation google::cloud::dialogflow::v2::ConversationModelEvaluation const &

Required. The conversation model evaluation to be created.

opts Options

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

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

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

CreateConversationModelEvaluation(NoAwaitTag, std::string const &, google::cloud::dialogflow::v2::ConversationModelEvaluation const &, Options)

Creates evaluation of a conversation model.

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

CreateConversationModelEvaluation(google::cloud::dialogflow::v2::CreateConversationModelEvaluationRequest const &, Options)

Creates evaluation of a conversation model.

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

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

CreateConversationModelEvaluation(NoAwaitTag, google::cloud::dialogflow::v2::CreateConversationModelEvaluationRequest const &, Options)

Creates evaluation of a conversation model.

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

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

Creates evaluation of a conversation model.

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::ConversationModelEvaluation > >

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.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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.