Class IntentsClient (2.32.0)

Service for managing Intents.

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

IntentsClient(IntentsClient const &)

Copy and move support

Parameter
Name Description
IntentsClient const &

IntentsClient(IntentsClient &&)

Copy and move support

Parameter
Name Description
IntentsClient &&

IntentsClient(std::shared_ptr< IntentsConnection >, Options)

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

Operators

operator=(IntentsClient const &)

Copy and move support

Parameter
Name Description
IntentsClient const &
Returns
Type Description
IntentsClient &

operator=(IntentsClient &&)

Copy and move support

Parameter
Name Description
IntentsClient &&
Returns
Type Description
IntentsClient &

Functions

ListIntents(std::string const &, Options)

Returns the list of all intents in the specified agent.

Parameters
Name Description
parent std::string const &

Required. The agent to list all intents from. Format: projects/<ProjectID>/agent or projects/<ProjectID>/locations/<LocationID>/agent.
Alternatively, you can specify the environment to list intents for. Format: projects/<ProjectID>/agent/environments/<Environment ID> or projects/<ProjectID>/locations/<LocationID>/agent/environments/<Environment ID>. Note: training phrases of the intents will not be returned for non-draft environment.

opts Options

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

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

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

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

Returns the list of all intents in the specified agent.

Parameters
Name Description
parent std::string const &

Required. The agent to list all intents from. Format: projects/<ProjectID>/agent or projects/<ProjectID>/locations/<LocationID>/agent.
Alternatively, you can specify the environment to list intents for. Format: projects/<ProjectID>/agent/environments/<Environment ID> or projects/<ProjectID>/locations/<LocationID>/agent/environments/<Environment ID>. Note: training phrases of the intents will not be returned for non-draft environment.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

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

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

ListIntents(google::cloud::dialogflow::v2::ListIntentsRequest, Options)

Returns the list of all intents in the specified agent.

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

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.ListIntentsRequest. 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::Intent >

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

GetIntent(std::string const &, Options)

Retrieves the specified intent.

Parameters
Name Description
name std::string const &

Required. The name of the intent. Format: projects/<ProjectID>/agent/intents/<Intent ID>.

opts Options

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

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

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

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

Retrieves the specified intent.

Parameters
Name Description
name std::string const &

Required. The name of the intent. Format: projects/<ProjectID>/agent/intents/<Intent ID>.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

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

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

GetIntent(google::cloud::dialogflow::v2::GetIntentRequest const &, Options)

Retrieves the specified intent.

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

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

CreateIntent(std::string const &, google::cloud::dialogflow::v2::Intent const &, Options)

Creates an intent in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
parent std::string const &

Required. The agent to create a intent for. Format: projects/<ProjectID>/agent.

intent google::cloud::dialogflow::v2::Intent const &

Required. The intent to create.

opts Options

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

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

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

CreateIntent(std::string const &, google::cloud::dialogflow::v2::Intent const &, std::string const &, Options)

Creates an intent in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
parent std::string const &

Required. The agent to create a intent for. Format: projects/<ProjectID>/agent.

intent google::cloud::dialogflow::v2::Intent const &

Required. The intent to create.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

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

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

CreateIntent(google::cloud::dialogflow::v2::CreateIntentRequest const &, Options)

Creates an intent in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

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

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

UpdateIntent(google::cloud::dialogflow::v2::Intent const &, std::string const &, Options)

Updates the specified intent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
intent google::cloud::dialogflow::v2::Intent const &

Required. The intent to update.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

opts Options

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

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

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

UpdateIntent(google::cloud::dialogflow::v2::Intent const &, std::string const &, google::protobuf::FieldMask const &, Options)

Updates the specified intent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
intent google::cloud::dialogflow::v2::Intent const &

Required. The intent to update.

language_code std::string const &

Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

update_mask google::protobuf::FieldMask const &

Optional. The mask to control which fields get updated.

opts Options

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

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

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

UpdateIntent(google::cloud::dialogflow::v2::UpdateIntentRequest const &, Options)

Updates the specified intent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

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

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

DeleteIntent(std::string const &, Options)

Deletes the specified intent and its direct or indirect followup intents.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
name std::string const &

Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: projects/<ProjectID>/agent/intents/<Intent 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.

DeleteIntent(google::cloud::dialogflow::v2::DeleteIntentRequest const &, Options)

Deletes the specified intent and its direct or indirect followup intents.

Note: You should always train an agent prior to sending it queries. See the training documentation.

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

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

Updates/Creates multiple intents in the specified agent.

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

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
parent std::string const &

Required. The name of the agent to update or create intents in. Format: projects/<ProjectID>/agent.

intent_batch_uri std::string const &

The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".

opts Options

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

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

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

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

Updates/Creates multiple intents in the specified agent.

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

BatchUpdateIntents(std::string const &, google::cloud::dialogflow::v2::IntentBatch const &, Options)

Updates/Creates multiple intents in the specified agent.

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

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
parent std::string const &

Required. The name of the agent to update or create intents in. Format: projects/<ProjectID>/agent.

intent_batch_inline google::cloud::dialogflow::v2::IntentBatch const &

The collection of intents to update or create.

opts Options

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

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

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

BatchUpdateIntents(NoAwaitTag, std::string const &, google::cloud::dialogflow::v2::IntentBatch const &, Options)

Updates/Creates multiple intents in the specified agent.

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

BatchUpdateIntents(google::cloud::dialogflow::v2::BatchUpdateIntentsRequest const &, Options)

Updates/Creates multiple intents in the specified agent.

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

Note: You should always train an agent prior to sending it queries. See the training documentation.

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

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

BatchUpdateIntents(NoAwaitTag, google::cloud::dialogflow::v2::BatchUpdateIntentsRequest const &, Options)

Updates/Creates multiple intents in the specified agent.

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

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

Updates/Creates multiple intents in the specified agent.

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

BatchDeleteIntents(std::string const &, std::vector< google::cloud::dialogflow::v2::Intent > const &, Options)

Deletes intents in the specified agent.

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

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
parent std::string const &

Required. The name of the agent to delete all entities types for. Format: projects/<ProjectID>/agent.

intents std::vector< google::cloud::dialogflow::v2::Intent > const &

Required. The collection of intents to delete. Only intent name must be filled in.

opts Options

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

Returns
Type Description
future< StatusOr< google::protobuf::Struct > >

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

BatchDeleteIntents(NoAwaitTag, std::string const &, std::vector< google::cloud::dialogflow::v2::Intent > const &, Options)

Deletes intents in the specified agent.

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 &
intents std::vector< google::cloud::dialogflow::v2::Intent > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchDeleteIntents(google::cloud::dialogflow::v2::BatchDeleteIntentsRequest const &, Options)

Deletes intents in the specified agent.

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

Note: You should always train an agent prior to sending it queries. See the training documentation.

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

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

BatchDeleteIntents(NoAwaitTag, google::cloud::dialogflow::v2::BatchDeleteIntentsRequest const &, Options)

Deletes intents in the specified agent.

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

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

Deletes intents in the specified agent.

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::protobuf::Struct > >

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.