Class: Google::Cloud::Dialogflow::V2::ListKnowledgeBasesRequest

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

Overview

Request message for KnowledgeBases.ListKnowledgeBases.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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

[AND ] ...

The following fields and operators are supported:

  • display_name with has(:) operator
  • language_code with equals(=) operator

Examples:

  • 'language_code=en-us' matches knowledge bases with en-us language code.
  • 'display_name:articles' matches knowledge bases whose display name contains "articles".
  • 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles".
  • 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb".

Note: An empty filter string (i.e. "") is a no-op and will result in no filtering.

For more information about filtering, see API Filtering.

Returns:

  • (::String) —

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

    [AND ] ...

    The following fields and operators are supported:

    • display_name with has(:) operator
    • language_code with equals(=) operator

    Examples:

    • 'language_code=en-us' matches knowledge bases with en-us language code.
    • 'display_name:articles' matches knowledge bases whose display name contains "articles".
    • 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles".
    • 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb".

    Note: An empty filter string (i.e. "") is a no-op and will result in no filtering.

    For more information about filtering, see API Filtering.



95
96
97
98
 
# File 'proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb', line 95

class ListKnowledgeBasesRequest
  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.



95
96
97
98
 
# File 'proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb', line 95

class ListKnowledgeBasesRequest
  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.



95
96
97
98
 
# File 'proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb', line 95

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

#parent ⇒ ::String

Returns Required. The project to list of knowledge bases for. Format: projects/<Project ID>/locations/<Location ID>.

Returns:

  • (::String) —

    Required. The project to list of knowledge bases for. Format: projects/<Project ID>/locations/<Location ID>.



95
96
97
98
 
# File 'proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb', line 95

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