Google Cloud Dialogflow V2 Client - Class ListKnowledgeBasesRequest (1.2.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ListKnowledgeBasesRequest.

Request message for KnowledgeBases.ListKnowledgeBases .

Generated from protobuf message google.cloud.dialogflow.v2.ListKnowledgeBasesRequest

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

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

↳ page_size
int

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

↳ page_token
string

The next_page_token value returned from a previous list request.

↳ filter
string

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

getParent

Required. The project to list of knowledge bases for.

Format: projects/<Project ID>/locations/<Location ID> .

Returns
Type
Description
string

setParent

Required. The project to list of knowledge bases for.

Format: projects/<Project ID>/locations/<Location ID> .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

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

Returns
Type
Description
int

setPageSize

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

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

The next_page_token value returned from a previous list request.

Returns
Type
Description
string

setPageToken

The next_page_token value returned from a previous list request.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFilter

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

  • 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
Type
Description
string

setFilter

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

  • 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 .
Parameter
Name
Description
var
string
Returns
Type
Description
$this