Class: Google::Cloud::Dialogflow::V2::ListConversationsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/conversation.rb

Overview

The request message for Conversations.ListConversations.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering:

  • The value must be a string, a number, or a boolean.
  • The comparison operator must be either `=`,`!=`, `>`, or `<`.
  • To filter on multiple expressions, separate the expressions with `AND` or `OR` (omitting both implies `AND`).
  • For clarity, expressions can be enclosed in parentheses.

Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations:

lifecycle_state = "COMPLETED"

For more information about filtering, see API Filtering.

Returns:

  • (::String) —

    A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering:

    • The value must be a string, a number, or a boolean.
    • The comparison operator must be either `=`,`!=`, `>`, or `<`.
    • To filter on multiple expressions, separate the expressions with `AND` or `OR` (omitting both implies `AND`).
    • For clarity, expressions can be enclosed in parentheses.

    Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations:

    lifecycle_state = "COMPLETED"

    For more information about filtering, see API Filtering.



162
163
164
165
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 162

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

#page_size ⇒ ::Integer

Returns Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

Returns:

  • (::Integer) —

    Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.



162
163
164
165
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 162

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

#page_token ⇒ ::String

Returns Optional. The next_page_token value returned from a previous list request.

Returns:

  • (::String) —

    Optional. The next_page_token value returned from a previous list request.



162
163
164
165
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 162

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

#parent ⇒ ::String

Returns Required. The project from which to list all conversation. Format: projects/<Project ID>/locations/<Location ID>.

Returns:

  • (::String) —

    Required. The project from which to list all conversation. Format: projects/<Project ID>/locations/<Location ID>.



162
163
164
165
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 162

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