Class: Google::Cloud::Dialogflow::V2::ListDocumentsRequest

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

Overview

Request message for Documents.ListDocuments.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns The filter expression used to filter documents returned by the list method. The expression has the following syntax:

[AND ] ...

The following fields and operators are supported:

  • knowledge_types with has(:) operator
  • display_name with has(:) operator
  • state with equals(=) operator

Examples:

  • "knowledge_types:FAQ" matches documents with FAQ knowledge type.
  • "display_name:customer" matches documents whose display name contains "customer".
  • "state=ACTIVE" matches documents with ACTIVE state.
  • "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

For more information about filtering, see API Filtering.

Returns:

  • (::String) —

    The filter expression used to filter documents returned by the list method. The expression has the following syntax:

    [AND ] ...

    The following fields and operators are supported:

    • knowledge_types with has(:) operator
    • display_name with has(:) operator
    • state with equals(=) operator

    Examples:

    • "knowledge_types:FAQ" matches documents with FAQ knowledge type.
    • "display_name:customer" matches documents whose display name contains "customer".
    • "state=ACTIVE" matches documents with ACTIVE state.
    • "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

    For more information about filtering, see API Filtering.



219
220
221
222
 
# File 'proto_docs/google/cloud/dialogflow/v2/document.rb', line 219

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

#page_size ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



219
220
221
222
 
# File 'proto_docs/google/cloud/dialogflow/v2/document.rb', line 219

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

#page_token ⇒ ::String

Returns The next_page_token value returned from a previous list request.

Returns:

  • (::String) —

    The next_page_token value returned from a previous list request.



219
220
221
222
 
# File 'proto_docs/google/cloud/dialogflow/v2/document.rb', line 219

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

#parent ⇒ ::String

Returns Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

Returns:

  • (::String) —

    Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.



219
220
221
222
 
# File 'proto_docs/google/cloud/dialogflow/v2/document.rb', line 219

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