Class: Google::Cloud::DiscoveryEngine::V1::ListConversationsRequest

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::ListConversationsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb

Overview

Request for ListConversations method.

Instance Attribute Summary

• #filter ⇒ ::String

  A filter to apply on the list results.

• #order_by ⇒ ::String

  A comma-separated list of fields to order by, sorted in ascending order.

• #page_size ⇒ ::Integer

  Maximum number of results to return.

• #page_token ⇒ ::String

  A page token, received from a previous ListConversations call.

• #parent ⇒ ::String

  Required.

Instance Attribute Details

#filter ⇒ ::String

Returns A filter to apply on the list results. The supported features are: user_pseudo_id, state.

Example: "user_pseudo_id = some_id".

Returns:

• (::String) —

  A filter to apply on the list results. The supported features are: user_pseudo_id, state.

  Example: "user_pseudo_id = some_id"

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 187

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

#order_by ⇒ ::String

Returns A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

• update_time
• create_time
• conversation_name

Example: "update_time desc" "create_time".

Returns:

• (::String) —

  A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • update_time
  • create_time
  • conversation_name

  Example: "update_time desc" "create_time"

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 187

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

#page_size ⇒ ::Integer

Returns Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

Returns:

• (::Integer) —

  Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 187

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

#page_token ⇒ ::String

Returns A page token, received from a previous ListConversations call. Provide this to retrieve the subsequent page.

Returns:

• (::String) —

  A page token, received from a previous ListConversations call. Provide this to retrieve the subsequent page.

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 187

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

#parent ⇒ ::String

Returns Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}.

Returns:

• (::String) —

  Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 187

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