Class ContactCenterInsightsClient (2.27.0)

An API that lets users analyze and explore their business conversation data.

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

ContactCenterInsightsClient(ContactCenterInsightsClient const &)

Copy and move support

Parameter
Name Description
ContactCenterInsightsClient const &

ContactCenterInsightsClient(ContactCenterInsightsClient &&)

Copy and move support

Parameter
Name Description
ContactCenterInsightsClient &&

ContactCenterInsightsClient(std::shared_ptr< ContactCenterInsightsConnection >, Options)

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

Operators

operator=(ContactCenterInsightsClient const &)

Copy and move support

Parameter
Name Description
ContactCenterInsightsClient const &
Returns
Type Description
ContactCenterInsightsClient &

operator=(ContactCenterInsightsClient &&)

Copy and move support

Parameter
Name Description
ContactCenterInsightsClient &&
Returns
Type Description
ContactCenterInsightsClient &

Functions

CreateConversation(std::string const &, google::cloud::contactcenterinsights::v1::Conversation const &, std::string const &, Options)

Creates a conversation.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the conversation.

conversation google::cloud::contactcenterinsights::v1::Conversation const &

Required. The conversation resource to create.

conversation_id std::string const &

A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used.
This value should be 4-64 characters and must match the regular expression ^[a-z0-9-]{4,64}$. Valid characters are [a-z][0-9]-

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::Conversation >

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

CreateConversation(google::cloud::contactcenterinsights::v1::CreateConversationRequest const &, Options)

Creates a conversation.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::CreateConversationRequest 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.contactcenterinsights.v1.CreateConversationRequest. 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::contactcenterinsights::v1::Conversation >

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

UploadConversation(google::cloud::contactcenterinsights::v1::UploadConversationRequest const &, Options)

Create a longrunning conversation upload operation.

This method differs from CreateConversation by allowing audio transcription and optional DLP redaction.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::UploadConversationRequest 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.contactcenterinsights.v1.UploadConversationRequest. 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::contactcenterinsights::v1::Conversation > >

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

UploadConversation(NoAwaitTag, google::cloud::contactcenterinsights::v1::UploadConversationRequest const &, Options)

Create a longrunning conversation upload operation.

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

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

Create a longrunning conversation upload operation.

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::contactcenterinsights::v1::Conversation > >

UpdateConversation(google::cloud::contactcenterinsights::v1::Conversation const &, google::protobuf::FieldMask const &, Options)

Updates a conversation.

Parameters
Name Description
conversation google::cloud::contactcenterinsights::v1::Conversation const &

Required. The new values for the conversation.

update_mask google::protobuf::FieldMask const &

The list of fields to be updated.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::Conversation >

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

UpdateConversation(google::cloud::contactcenterinsights::v1::UpdateConversationRequest const &, Options)

Updates a conversation.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::UpdateConversationRequest 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.contactcenterinsights.v1.UpdateConversationRequest. 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::contactcenterinsights::v1::Conversation >

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

GetConversation(std::string const &, Options)

Gets a conversation.

Parameters
Name Description
name std::string const &

Required. The name of the conversation to get.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::Conversation >

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

GetConversation(google::cloud::contactcenterinsights::v1::GetConversationRequest const &, Options)

Gets a conversation.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::GetConversationRequest 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.contactcenterinsights.v1.GetConversationRequest. 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::contactcenterinsights::v1::Conversation >

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

ListConversations(std::string const &, Options)

Lists conversations.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the conversation.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::contactcenterinsights::v1::Conversation >

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

ListConversations(google::cloud::contactcenterinsights::v1::ListConversationsRequest, Options)

Lists conversations.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::ListConversationsRequest

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.contactcenterinsights.v1.ListConversationsRequest. 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::contactcenterinsights::v1::Conversation >

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

DeleteConversation(std::string const &, Options)

Deletes a conversation.

Parameters
Name Description
name std::string const &

Required. The name of the conversation to delete.

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.

DeleteConversation(google::cloud::contactcenterinsights::v1::DeleteConversationRequest const &, Options)

Deletes a conversation.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::DeleteConversationRequest 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.contactcenterinsights.v1.DeleteConversationRequest. 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.

CreateAnalysis(std::string const &, google::cloud::contactcenterinsights::v1::Analysis const &, Options)

Creates an analysis.

The long running operation is done when the analysis has completed.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the analysis.

analysis google::cloud::contactcenterinsights::v1::Analysis const &

Required. The analysis to create.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::contactcenterinsights::v1::Analysis > >

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

CreateAnalysis(NoAwaitTag, std::string const &, google::cloud::contactcenterinsights::v1::Analysis const &, Options)

Creates an analysis.

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 &
analysis google::cloud::contactcenterinsights::v1::Analysis const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateAnalysis(google::cloud::contactcenterinsights::v1::CreateAnalysisRequest const &, Options)

Creates an analysis.

The long running operation is done when the analysis has completed.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::CreateAnalysisRequest 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.contactcenterinsights.v1.CreateAnalysisRequest. 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::contactcenterinsights::v1::Analysis > >

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

CreateAnalysis(NoAwaitTag, google::cloud::contactcenterinsights::v1::CreateAnalysisRequest const &, Options)

Creates an analysis.

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

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

Creates an analysis.

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::contactcenterinsights::v1::Analysis > >

GetAnalysis(std::string const &, Options)

Gets an analysis.

Parameters
Name Description
name std::string const &

Required. The name of the analysis to get.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::Analysis >

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

GetAnalysis(google::cloud::contactcenterinsights::v1::GetAnalysisRequest const &, Options)

Gets an analysis.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::GetAnalysisRequest 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.contactcenterinsights.v1.GetAnalysisRequest. 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::contactcenterinsights::v1::Analysis >

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

ListAnalyses(std::string const &, Options)

Lists analyses.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the analyses.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::contactcenterinsights::v1::Analysis >

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

ListAnalyses(google::cloud::contactcenterinsights::v1::ListAnalysesRequest, Options)

Lists analyses.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::ListAnalysesRequest

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.contactcenterinsights.v1.ListAnalysesRequest. 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::contactcenterinsights::v1::Analysis >

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

DeleteAnalysis(std::string const &, Options)

Deletes an analysis.

Parameters
Name Description
name std::string const &

Required. The name of the analysis to delete.

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.

DeleteAnalysis(google::cloud::contactcenterinsights::v1::DeleteAnalysisRequest const &, Options)

Deletes an analysis.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::DeleteAnalysisRequest 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.contactcenterinsights.v1.DeleteAnalysisRequest. 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.

BulkAnalyzeConversations(std::string const &, std::string const &, float, Options)

Analyzes multiple conversations in a single request.

Parameters
Name Description
parent std::string const &

Required. The parent resource to create analyses in.

filter std::string const &

Required. Filter used to select the subset of conversations to analyze.

analysis_percentage float

Required. Percentage of selected conversation to analyze, between [0, 100].

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::contactcenterinsights::v1::BulkAnalyzeConversationsResponse > >

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

BulkAnalyzeConversations(NoAwaitTag, std::string const &, std::string const &, float, Options)

Analyzes multiple conversations in a single request.

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

BulkAnalyzeConversations(google::cloud::contactcenterinsights::v1::BulkAnalyzeConversationsRequest const &, Options)

Analyzes multiple conversations in a single request.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::BulkAnalyzeConversationsRequest 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.contactcenterinsights.v1.BulkAnalyzeConversationsRequest. 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::contactcenterinsights::v1::BulkAnalyzeConversationsResponse > >

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

BulkAnalyzeConversations(NoAwaitTag, google::cloud::contactcenterinsights::v1::BulkAnalyzeConversationsRequest const &, Options)

Analyzes multiple conversations in a single request.

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

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

Analyzes multiple conversations in a single request.

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::contactcenterinsights::v1::BulkAnalyzeConversationsResponse > >

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

Deletes multiple conversations in a single request.

Parameters
Name Description
parent std::string const &

Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}

filter std::string const &

Filter used to select the subset of conversations to delete.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::contactcenterinsights::v1::BulkDeleteConversationsResponse > >

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

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

Deletes multiple conversations in a single request.

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

BulkDeleteConversations(google::cloud::contactcenterinsights::v1::BulkDeleteConversationsRequest const &, Options)

Deletes multiple conversations in a single request.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::BulkDeleteConversationsRequest 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.contactcenterinsights.v1.BulkDeleteConversationsRequest. 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::contactcenterinsights::v1::BulkDeleteConversationsResponse > >

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

BulkDeleteConversations(NoAwaitTag, google::cloud::contactcenterinsights::v1::BulkDeleteConversationsRequest const &, Options)

Deletes multiple conversations in a single request.

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

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

Deletes multiple conversations in a single request.

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::contactcenterinsights::v1::BulkDeleteConversationsResponse > >

IngestConversations(std::string const &, Options)

Imports conversations and processes them according to the user's configuration.

Parameters
Name Description
parent std::string const &

Required. The parent resource for new conversations.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::contactcenterinsights::v1::IngestConversationsResponse > >

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

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

Imports conversations and processes them according to the user's configuration.

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

IngestConversations(google::cloud::contactcenterinsights::v1::IngestConversationsRequest const &, Options)

Imports conversations and processes them according to the user's configuration.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::IngestConversationsRequest 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.contactcenterinsights.v1.IngestConversationsRequest. 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::contactcenterinsights::v1::IngestConversationsResponse > >

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

IngestConversations(NoAwaitTag, google::cloud::contactcenterinsights::v1::IngestConversationsRequest const &, Options)

Imports conversations and processes them according to the user's configuration.

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

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

Imports conversations and processes them according to the user's configuration.

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::contactcenterinsights::v1::IngestConversationsResponse > >

ExportInsightsData(std::string const &, Options)

Export insights data to a destination defined in the request body.

Parameters
Name Description
parent std::string const &

Required. The parent resource to export data from.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::contactcenterinsights::v1::ExportInsightsDataResponse > >

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

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

Export insights data to a destination defined in the request body.

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

ExportInsightsData(google::cloud::contactcenterinsights::v1::ExportInsightsDataRequest const &, Options)

Export insights data to a destination defined in the request body.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::ExportInsightsDataRequest 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.contactcenterinsights.v1.ExportInsightsDataRequest. 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::contactcenterinsights::v1::ExportInsightsDataResponse > >

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

ExportInsightsData(NoAwaitTag, google::cloud::contactcenterinsights::v1::ExportInsightsDataRequest const &, Options)

Export insights data to a destination defined in the request body.

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

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

Export insights data to a destination defined in the request body.

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::contactcenterinsights::v1::ExportInsightsDataResponse > >

CreateIssueModel(std::string const &, google::cloud::contactcenterinsights::v1::IssueModel const &, Options)

Creates an issue model.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the issue model.

issue_model google::cloud::contactcenterinsights::v1::IssueModel const &

Required. The issue model to create.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::contactcenterinsights::v1::IssueModel > >

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

CreateIssueModel(NoAwaitTag, std::string const &, google::cloud::contactcenterinsights::v1::IssueModel const &, Options)

Creates an issue 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 &
issue_model google::cloud::contactcenterinsights::v1::IssueModel const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateIssueModel(google::cloud::contactcenterinsights::v1::CreateIssueModelRequest const &, Options)

Creates an issue model.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::CreateIssueModelRequest 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.contactcenterinsights.v1.CreateIssueModelRequest. 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::contactcenterinsights::v1::IssueModel > >

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

CreateIssueModel(NoAwaitTag, google::cloud::contactcenterinsights::v1::CreateIssueModelRequest const &, Options)

Creates an issue 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::contactcenterinsights::v1::CreateIssueModelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates an issue 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::contactcenterinsights::v1::IssueModel > >

UpdateIssueModel(google::cloud::contactcenterinsights::v1::IssueModel const &, google::protobuf::FieldMask const &, Options)

Updates an issue model.

Parameters
Name Description
issue_model google::cloud::contactcenterinsights::v1::IssueModel const &

Required. The new values for the issue model.

update_mask google::protobuf::FieldMask const &

The list of fields to be updated.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::IssueModel >

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

UpdateIssueModel(google::cloud::contactcenterinsights::v1::UpdateIssueModelRequest const &, Options)

Updates an issue model.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::UpdateIssueModelRequest 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.contactcenterinsights.v1.UpdateIssueModelRequest. 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::contactcenterinsights::v1::IssueModel >

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

GetIssueModel(std::string const &, Options)

Gets an issue model.

Parameters
Name Description
name std::string const &

Required. The name of the issue model to get.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::IssueModel >

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

GetIssueModel(google::cloud::contactcenterinsights::v1::GetIssueModelRequest const &, Options)

Gets an issue model.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::GetIssueModelRequest 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.contactcenterinsights.v1.GetIssueModelRequest. 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::contactcenterinsights::v1::IssueModel >

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

ListIssueModels(std::string const &, Options)

Lists issue models.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the issue model.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::ListIssueModelsResponse >

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

ListIssueModels(google::cloud::contactcenterinsights::v1::ListIssueModelsRequest const &, Options)

Lists issue models.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::ListIssueModelsRequest 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.contactcenterinsights.v1.ListIssueModelsRequest. 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::contactcenterinsights::v1::ListIssueModelsResponse >

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

DeleteIssueModel(std::string const &, Options)

Deletes an issue model.

Parameters
Name Description
name std::string const &

Required. The name of the issue model to delete.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::contactcenterinsights::v1::DeleteIssueModelMetadata > >

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

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

Deletes an issue 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 >

DeleteIssueModel(google::cloud::contactcenterinsights::v1::DeleteIssueModelRequest const &, Options)

Deletes an issue model.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::DeleteIssueModelRequest 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.contactcenterinsights.v1.DeleteIssueModelRequest. 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::contactcenterinsights::v1::DeleteIssueModelMetadata > >

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

DeleteIssueModel(NoAwaitTag, google::cloud::contactcenterinsights::v1::DeleteIssueModelRequest const &, Options)

Deletes an issue 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::contactcenterinsights::v1::DeleteIssueModelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes an issue 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::contactcenterinsights::v1::DeleteIssueModelMetadata > >

DeployIssueModel(std::string const &, Options)

Deploys an issue model.

Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.

Parameters
Name Description
name std::string const &

Required. The issue model to deploy.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::contactcenterinsights::v1::DeployIssueModelResponse > >

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

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

Deploys an issue 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 >

DeployIssueModel(google::cloud::contactcenterinsights::v1::DeployIssueModelRequest const &, Options)

Deploys an issue model.

Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::DeployIssueModelRequest 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.contactcenterinsights.v1.DeployIssueModelRequest. 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::contactcenterinsights::v1::DeployIssueModelResponse > >

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

DeployIssueModel(NoAwaitTag, google::cloud::contactcenterinsights::v1::DeployIssueModelRequest const &, Options)

Deploys an issue 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::contactcenterinsights::v1::DeployIssueModelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deploys an issue 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::contactcenterinsights::v1::DeployIssueModelResponse > >

UndeployIssueModel(std::string const &, Options)

Undeploys an issue model.

An issue model can not be used in analysis after it has been undeployed.

Parameters
Name Description
name std::string const &

Required. The issue model to undeploy.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::contactcenterinsights::v1::UndeployIssueModelResponse > >

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

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

Undeploys an issue 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 >

UndeployIssueModel(google::cloud::contactcenterinsights::v1::UndeployIssueModelRequest const &, Options)

Undeploys an issue model.

An issue model can not be used in analysis after it has been undeployed.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::UndeployIssueModelRequest 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.contactcenterinsights.v1.UndeployIssueModelRequest. 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::contactcenterinsights::v1::UndeployIssueModelResponse > >

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

UndeployIssueModel(NoAwaitTag, google::cloud::contactcenterinsights::v1::UndeployIssueModelRequest const &, Options)

Undeploys an issue 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::contactcenterinsights::v1::UndeployIssueModelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Undeploys an issue 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::contactcenterinsights::v1::UndeployIssueModelResponse > >

GetIssue(std::string const &, Options)

Gets an issue.

Parameters
Name Description
name std::string const &

Required. The name of the issue to get.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::Issue >

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

GetIssue(google::cloud::contactcenterinsights::v1::GetIssueRequest const &, Options)

Gets an issue.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::GetIssueRequest 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.contactcenterinsights.v1.GetIssueRequest. 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::contactcenterinsights::v1::Issue >

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

ListIssues(std::string const &, Options)

Lists issues.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the issue.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::ListIssuesResponse >

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

ListIssues(google::cloud::contactcenterinsights::v1::ListIssuesRequest const &, Options)

Lists issues.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::ListIssuesRequest 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.contactcenterinsights.v1.ListIssuesRequest. 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::contactcenterinsights::v1::ListIssuesResponse >

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

UpdateIssue(google::cloud::contactcenterinsights::v1::Issue const &, google::protobuf::FieldMask const &, Options)

Updates an issue.

Parameters
Name Description
issue google::cloud::contactcenterinsights::v1::Issue const &

Required. The new values for the issue.

update_mask google::protobuf::FieldMask const &

The list of fields to be updated.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::Issue >

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

UpdateIssue(google::cloud::contactcenterinsights::v1::UpdateIssueRequest const &, Options)

Updates an issue.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::UpdateIssueRequest 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.contactcenterinsights.v1.UpdateIssueRequest. 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::contactcenterinsights::v1::Issue >

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

DeleteIssue(std::string const &, Options)

Deletes an issue.

Parameters
Name Description
name std::string const &

Required. The name of the issue to delete.

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.

DeleteIssue(google::cloud::contactcenterinsights::v1::DeleteIssueRequest const &, Options)

Deletes an issue.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::DeleteIssueRequest 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.contactcenterinsights.v1.DeleteIssueRequest. 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.

CalculateIssueModelStats(std::string const &, Options)

Gets an issue model's statistics.

Parameters
Name Description
issue_model std::string const &

Required. The resource name of the issue model to query against.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::CalculateIssueModelStatsResponse >

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

CalculateIssueModelStats(google::cloud::contactcenterinsights::v1::CalculateIssueModelStatsRequest const &, Options)

Gets an issue model's statistics.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::CalculateIssueModelStatsRequest 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.contactcenterinsights.v1.CalculateIssueModelStatsRequest. 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::contactcenterinsights::v1::CalculateIssueModelStatsResponse >

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

CreatePhraseMatcher(std::string const &, google::cloud::contactcenterinsights::v1::PhraseMatcher const &, Options)

Creates a phrase matcher.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: projects/<ProjectID>/locations/<LocationID> or projects/<ProjectNumber>/locations/<LocationID>

phrase_matcher google::cloud::contactcenterinsights::v1::PhraseMatcher const &

Required. The phrase matcher resource to create.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::PhraseMatcher >

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

CreatePhraseMatcher(google::cloud::contactcenterinsights::v1::CreatePhraseMatcherRequest const &, Options)

Creates a phrase matcher.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::CreatePhraseMatcherRequest 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.contactcenterinsights.v1.CreatePhraseMatcherRequest. 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::contactcenterinsights::v1::PhraseMatcher >

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

GetPhraseMatcher(std::string const &, Options)

Gets a phrase matcher.

Parameters
Name Description
name std::string const &

Required. The name of the phrase matcher to get.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::PhraseMatcher >

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

GetPhraseMatcher(google::cloud::contactcenterinsights::v1::GetPhraseMatcherRequest const &, Options)

Gets a phrase matcher.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::GetPhraseMatcherRequest 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.contactcenterinsights.v1.GetPhraseMatcherRequest. 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::contactcenterinsights::v1::PhraseMatcher >

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

ListPhraseMatchers(std::string const &, Options)

Lists phrase matchers.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the phrase matcher.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::contactcenterinsights::v1::PhraseMatcher >

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

ListPhraseMatchers(google::cloud::contactcenterinsights::v1::ListPhraseMatchersRequest, Options)

Lists phrase matchers.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::ListPhraseMatchersRequest

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.contactcenterinsights.v1.ListPhraseMatchersRequest. 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::contactcenterinsights::v1::PhraseMatcher >

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

DeletePhraseMatcher(std::string const &, Options)

Deletes a phrase matcher.

Parameters
Name Description
name std::string const &

Required. The name of the phrase matcher to delete.

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.

DeletePhraseMatcher(google::cloud::contactcenterinsights::v1::DeletePhraseMatcherRequest const &, Options)

Deletes a phrase matcher.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::DeletePhraseMatcherRequest 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.contactcenterinsights.v1.DeletePhraseMatcherRequest. 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.

UpdatePhraseMatcher(google::cloud::contactcenterinsights::v1::PhraseMatcher const &, google::protobuf::FieldMask const &, Options)

Updates a phrase matcher.

Parameters
Name Description
phrase_matcher google::cloud::contactcenterinsights::v1::PhraseMatcher const &

Required. The new values for the phrase matcher.

update_mask google::protobuf::FieldMask const &

The list of fields to be updated.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::PhraseMatcher >

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

UpdatePhraseMatcher(google::cloud::contactcenterinsights::v1::UpdatePhraseMatcherRequest const &, Options)

Updates a phrase matcher.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::UpdatePhraseMatcherRequest 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.contactcenterinsights.v1.UpdatePhraseMatcherRequest. 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::contactcenterinsights::v1::PhraseMatcher >

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

CalculateStats(std::string const &, Options)

Gets conversation statistics.

Parameters
Name Description
location std::string const &

Required. The location of the conversations.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::CalculateStatsResponse >

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

CalculateStats(google::cloud::contactcenterinsights::v1::CalculateStatsRequest const &, Options)

Gets conversation statistics.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::CalculateStatsRequest 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.contactcenterinsights.v1.CalculateStatsRequest. 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::contactcenterinsights::v1::CalculateStatsResponse >

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

GetSettings(std::string const &, Options)

Gets project-level settings.

Parameters
Name Description
name std::string const &

Required. The name of the settings resource to get.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::Settings >

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

GetSettings(google::cloud::contactcenterinsights::v1::GetSettingsRequest const &, Options)

Gets project-level settings.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::GetSettingsRequest 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.contactcenterinsights.v1.GetSettingsRequest. 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::contactcenterinsights::v1::Settings >

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

UpdateSettings(google::cloud::contactcenterinsights::v1::Settings const &, google::protobuf::FieldMask const &, Options)

Updates project-level settings.

Parameters
Name Description
settings google::cloud::contactcenterinsights::v1::Settings const &

Required. The new settings values.

update_mask google::protobuf::FieldMask const &

Required. The list of fields to be updated.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::Settings >

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

UpdateSettings(google::cloud::contactcenterinsights::v1::UpdateSettingsRequest const &, Options)

Updates project-level settings.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::UpdateSettingsRequest 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.contactcenterinsights.v1.UpdateSettingsRequest. 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::contactcenterinsights::v1::Settings >

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

CreateView(std::string const &, google::cloud::contactcenterinsights::v1::View const &, Options)

Creates a view.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the view. Required. The location to create a view for. Format: projects/<ProjectID>/locations/<LocationID> or projects/<ProjectNumber>/locations/<LocationID>

view google::cloud::contactcenterinsights::v1::View const &

Required. The view resource to create.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::View >

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

CreateView(google::cloud::contactcenterinsights::v1::CreateViewRequest const &, Options)

Creates a view.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::CreateViewRequest 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.contactcenterinsights.v1.CreateViewRequest. 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::contactcenterinsights::v1::View >

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

GetView(std::string const &, Options)

Gets a view.

Parameters
Name Description
name std::string const &

Required. The name of the view to get.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::View >

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

GetView(google::cloud::contactcenterinsights::v1::GetViewRequest const &, Options)

Gets a view.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::GetViewRequest 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.contactcenterinsights.v1.GetViewRequest. 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::contactcenterinsights::v1::View >

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

ListViews(std::string const &, Options)

Lists views.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the views.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::contactcenterinsights::v1::View >

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

ListViews(google::cloud::contactcenterinsights::v1::ListViewsRequest, Options)

Lists views.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::ListViewsRequest

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.contactcenterinsights.v1.ListViewsRequest. 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::contactcenterinsights::v1::View >

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

UpdateView(google::cloud::contactcenterinsights::v1::View const &, google::protobuf::FieldMask const &, Options)

Updates a view.

Parameters
Name Description
view google::cloud::contactcenterinsights::v1::View const &

Required. The new view.

update_mask google::protobuf::FieldMask const &

The list of fields to be updated.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::contactcenterinsights::v1::View >

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

UpdateView(google::cloud::contactcenterinsights::v1::UpdateViewRequest const &, Options)

Updates a view.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::UpdateViewRequest 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.contactcenterinsights.v1.UpdateViewRequest. 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::contactcenterinsights::v1::View >

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

DeleteView(std::string const &, Options)

Deletes a view.

Parameters
Name Description
name std::string const &

Required. The name of the view to delete.

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.

DeleteView(google::cloud::contactcenterinsights::v1::DeleteViewRequest const &, Options)

Deletes a view.

Parameters
Name Description
request google::cloud::contactcenterinsights::v1::DeleteViewRequest 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.contactcenterinsights.v1.DeleteViewRequest. 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.