Class: Google::Cloud::ContactCenterInsights::V1::ListConversationsRequest

Inherits:

Object

• Object
• Google::Cloud::ContactCenterInsights::V1::ListConversationsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb

Overview

Request to list conversations.

Instance Attribute Summary

• #filter ⇒ ::String

  A filter to reduce results to a specific subset.

• #order_by ⇒ ::String

  Optional.

• #page_size ⇒ ::Integer

  The maximum number of conversations to return in the response.

• #page_token ⇒ ::String

  The value returned by the last ListConversationsResponse.

• #parent ⇒ ::String

  Required.

• #view ⇒ ::Google::Cloud::ContactCenterInsights::V1::ConversationView

  The level of details of the conversation.

Instance Attribute Details

#filter ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 266

class ListConversationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns 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.

Returns:

• (::String) —

  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.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 266

class ListConversationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.

Returns:

• (::Integer) —

  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.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 266

class ListConversationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.

Returns:

• (::String) —

  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.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 266

class ListConversationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The parent resource of the conversation.

Returns:

• (::String) —

  Required. The parent resource of the conversation.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 266

class ListConversationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#view ⇒ ::Google::Cloud::ContactCenterInsights::V1::ConversationView

Returns 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.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 266

class ListConversationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end