Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::ListConversationsRequest (v0.19.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::ListConversationsRequest.

The request message for Conversations.ListConversations.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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.

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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. The next_page_token value returned from a previous list request.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The project from which to list all conversation. Format: projects/<Project ID>/locations/<Location ID>.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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>.