Package com.google.cloud.dialogflow.v2

Interface ListDocumentsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListDocumentsRequest, ListDocumentsRequest.Builder
    public interface ListDocumentsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      The filter expression used to filter documents returned by the list method.
      com.google.protobuf.ByteString getFilterBytes()
      The filter expression used to filter documents returned by the list method.
      int getPageSize()
      The maximum number of items to return in a single page.
      String getPageToken()
      The next_page_token value returned from a previous list request.
      com.google.protobuf.ByteString getPageTokenBytes()
      The next_page_token value returned from a previous list request.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         Required. The knowledge base to list all documents for.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The knowledge base to list all documents for.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getPageSize

        int getPageSize()
         The maximum number of items to return in a single page. By
 default 10 and at most 100.
        int32 page_size = 2;
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         The next_page_token value returned from a previous list request.
        string page_token = 3;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         The next_page_token value returned from a previous list request.
        string page_token = 3;
        Returns:
        The bytes for pageToken.

      • getFilter

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

   <field> <operator> <value> [AND <field> <operator> <value>] ...

 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](https://aip.dev/160).
        string filter = 4;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         The filter expression used to filter documents returned by the list method.
 The expression has the following syntax:

   <field> <operator> <value> [AND <field> <operator> <value>] ...

 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](https://aip.dev/160).
        string filter = 4;
        Returns:
        The bytes for filter.