Interface ListDocumentsRequestOrBuilder (4.36.0) 

public interface ListDocumentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract 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.

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract 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.

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract 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
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract 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
Type Description
String

The parent.

getParentBytes()

public abstract 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
Type Description
ByteString

The bytes for parent.