Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::ListConversationsRequest.
Request to list conversations.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
Returns
- (::String) — A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
#filter=
def filter=(value) -> ::String
Parameter
- value (::String) — A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
Returns
- (::String) — A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
#page_size
def page_size() -> ::Integer
Returns
- (::Integer) — The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,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.
#page_size=
def page_size=(value) -> ::Integer
Parameter
- value (::Integer) — The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,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.
Returns
- (::Integer) — The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,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.
#page_token
def page_token() -> ::String
Returns
-
(::String) — The value returned by the last
ListConversationsResponse
. This value indicates that this is a continuation of a priorListConversations
call and that the system should return the next page of data.
#page_token=
def page_token=(value) -> ::String
Parameter
-
value (::String) — The value returned by the last
ListConversationsResponse
. This value indicates that this is a continuation of a priorListConversations
call and that the system should return the next page of data.
Returns
-
(::String) — The value returned by the last
ListConversationsResponse
. This value indicates that this is a continuation of a priorListConversations
call and that the system should return the next page of data.
#parent
def parent() -> ::String
Returns
- (::String) — Required. The parent resource of the conversation.
#parent=
def parent=(value) -> ::String
Parameter
- value (::String) — Required. The parent resource of the conversation.
Returns
- (::String) — Required. The parent resource of the conversation.
#view
def view() -> ::Google::Cloud::ContactCenterInsights::V1::ConversationView
Returns
-
(::Google::Cloud::ContactCenterInsights::V1::ConversationView) — The level of details of the conversation. Default is
BASIC
.
#view=
def view=(value) -> ::Google::Cloud::ContactCenterInsights::V1::ConversationView
Parameter
-
value (::Google::Cloud::ContactCenterInsights::V1::ConversationView) — The level of details of the conversation. Default is
BASIC
.
Returns
-
(::Google::Cloud::ContactCenterInsights::V1::ConversationView) — The level of details of the conversation. Default is
BASIC
.