Interface ListKnowledgeBasesRequestOrBuilder (4.34.0) 

public interface ListKnowledgeBasesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

The filter expression used to filter knowledge bases 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:

  • 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.

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

The filter expression used to filter knowledge bases 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:

  • 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.

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 project to list of knowledge bases for. Format: projects/<Project ID>/locations/<Location 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 project to list of knowledge bases for. Format: projects/<Project ID>/locations/<Location ID>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.