Interface ListConversationsRequestOrBuilder (2.52.0) 

public interface ListConversationsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public abstract 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.

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

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public abstract 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.

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

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public abstract 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
Type Description
int

The pageSize.

getPageToken()

public abstract 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
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract 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
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The parent resource of the conversation.

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

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The parent resource of the conversation.

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

Returns
Type Description
ByteString

The bytes for parent.

getView()

public abstract ConversationView getView()

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

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

Returns
Type Description
ConversationView

The view.

getViewValue()

public abstract int getViewValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for view.