com.google.cloud.contactcenterinsights.v1

Interface ListConversationsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListConversationsRequest, ListConversationsRequest.Builder

public interface ListConversationsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() A filter to reduce results to a specific subset.
com.google.protobuf.ByteString	getFilterBytes() A filter to reduce results to a specific subset.
String	getOrderBy() Optional.
com.google.protobuf.ByteString	getOrderByBytes() Optional.
int	getPageSize() The maximum number of conversations to return in the response.
String	getPageToken() The value returned by the last `ListConversationsResponse`.
com.google.protobuf.ByteString	getPageTokenBytes() The value returned by the last `ListConversationsResponse`.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
ConversationView	getView() The level of details of the conversation.
int	getViewValue() The level of details of the conversation.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. The parent resource of the conversation.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. The parent resource of the conversation.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getPageSize

int getPageSize()

 The maximum number of conversations to return in the response. A valid page
 size ranges from 0 to 100,000 inclusive. If the page size is zero or
 unspecified, a default page size of 100 will be chosen. Note that a call
 might return fewer results than the requested page size.
 

int32 page_size = 2;

Returns:

The pageSize.

getPageToken

String getPageToken()

 The value returned by the last `ListConversationsResponse`. This value
 indicates that this is a continuation of a prior `ListConversations` call
 and that the system should return the next page of data.
 

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 The value returned by the last `ListConversationsResponse`. This value
 indicates that this is a continuation of a prior `ListConversations` call
 and that the system should return the next page of data.
 

string page_token = 3;

Returns:

The bytes for pageToken.

getFilter

String getFilter()

 A filter to reduce results to a specific subset. Useful for querying
 conversations with specific properties.
 

string filter = 4;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 A filter to reduce results to a specific subset. Useful for querying
 conversations with specific properties.
 

string filter = 4;

Returns:

The bytes for filter.

getOrderBy

String getOrderBy()

 Optional. The attribute by which to order conversations in the response.
 If empty, conversations will be ordered by descending creation time.
 Supported values are one of the following:

 * create_time
 * customer_satisfaction_rating
 * duration
 * latest_analysis
 * start_time
 * turn_count

 The default sort order is ascending. To specify order, append `asc` or
 `desc` (`create_time desc`).
 For more details, see [Google AIPs
 Ordering](https://google.aip.dev/132#ordering).
 

string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 Optional. The attribute by which to order conversations in the response.
 If empty, conversations will be ordered by descending creation time.
 Supported values are one of the following:

 * create_time
 * customer_satisfaction_rating
 * duration
 * latest_analysis
 * start_time
 * turn_count

 The default sort order is ascending. To specify order, append `asc` or
 `desc` (`create_time desc`).
 For more details, see [Google AIPs
 Ordering](https://google.aip.dev/132#ordering).
 

string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for orderBy.

getViewValue

int getViewValue()

 The level of details of the conversation. Default is `BASIC`.
 

.google.cloud.contactcenterinsights.v1.ConversationView view = 5;

Returns:

The enum numeric value on the wire for view.

getView

ConversationView getView()

 The level of details of the conversation. Default is `BASIC`.
 

.google.cloud.contactcenterinsights.v1.ConversationView view = 5;

Returns:

The view.