Generated from protobuf message google.cloud.dialogflow.v2.ListDocumentsRequest
Namespace
Google \ Cloud \ Dialogflow \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base 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 documents returned by the list method. The expression has the following syntax:
getParent
Required. The knowledge base to list all documents for.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>.
Returns
Type
Description
string
setParent
Required. The knowledge base to list all documents for.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base 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 documents returned by the list method.
The expression has the following syntax:
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.
Returns
Type
Description
string
setFilter
The filter expression used to filter documents returned by the list method.
The expression has the following syntax:
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The knowledge base to list all documents for.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>. Please see
DocumentsClient::knowledgeBaseName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dialogflow V2 Client - Class ListDocumentsRequest (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-dialogflow/latest/V2.ListDocumentsRequest)\n- [2.1.1](/php/docs/reference/cloud-dialogflow/2.1.1/V2.ListDocumentsRequest)\n- [2.0.1](/php/docs/reference/cloud-dialogflow/2.0.1/V2.ListDocumentsRequest)\n- [1.17.2](/php/docs/reference/cloud-dialogflow/1.17.2/V2.ListDocumentsRequest)\n- [1.16.0](/php/docs/reference/cloud-dialogflow/1.16.0/V2.ListDocumentsRequest)\n- [1.15.1](/php/docs/reference/cloud-dialogflow/1.15.1/V2.ListDocumentsRequest)\n- [1.14.0](/php/docs/reference/cloud-dialogflow/1.14.0/V2.ListDocumentsRequest)\n- [1.13.0](/php/docs/reference/cloud-dialogflow/1.13.0/V2.ListDocumentsRequest)\n- [1.12.3](/php/docs/reference/cloud-dialogflow/1.12.3/V2.ListDocumentsRequest)\n- [1.11.0](/php/docs/reference/cloud-dialogflow/1.11.0/V2.ListDocumentsRequest)\n- [1.10.2](/php/docs/reference/cloud-dialogflow/1.10.2/V2.ListDocumentsRequest)\n- [1.9.0](/php/docs/reference/cloud-dialogflow/1.9.0/V2.ListDocumentsRequest)\n- [1.8.0](/php/docs/reference/cloud-dialogflow/1.8.0/V2.ListDocumentsRequest)\n- [1.7.2](/php/docs/reference/cloud-dialogflow/1.7.2/V2.ListDocumentsRequest)\n- [1.6.0](/php/docs/reference/cloud-dialogflow/1.6.0/V2.ListDocumentsRequest)\n- [1.5.0](/php/docs/reference/cloud-dialogflow/1.5.0/V2.ListDocumentsRequest)\n- [1.4.0](/php/docs/reference/cloud-dialogflow/1.4.0/V2.ListDocumentsRequest)\n- [1.3.2](/php/docs/reference/cloud-dialogflow/1.3.2/V2.ListDocumentsRequest)\n- [1.2.0](/php/docs/reference/cloud-dialogflow/1.2.0/V2.ListDocumentsRequest)\n- [1.1.1](/php/docs/reference/cloud-dialogflow/1.1.1/V2.ListDocumentsRequest)\n- [1.0.1](/php/docs/reference/cloud-dialogflow/1.0.1/V2.ListDocumentsRequest) \nReference documentation and code samples for the Google Cloud Dialogflow V2 Client class ListDocumentsRequest.\n\nRequest message for\n[Documents.ListDocuments](/php/docs/reference/cloud-dialogflow/latest/V2.Client.DocumentsClient#_Google_Cloud_Dialogflow_V2_Client_DocumentsClient__listDocuments__).\n\nGenerated from protobuf message `google.cloud.dialogflow.v2.ListDocumentsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The knowledge base to list all documents for.\n\nFormat: `projects/\u003cProject ID\u003e/locations/\u003cLocation\nID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.\n\n### setParent\n\nRequired. The knowledge base to list all documents for.\n\nFormat: `projects/\u003cProject ID\u003e/locations/\u003cLocation\nID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.\n\n### getPageSize\n\nThe maximum number of items to return in a single page. By\ndefault 10 and at most 100.\n\n### setPageSize\n\nThe maximum number of items to return in a single page. By\ndefault 10 and at most 100.\n\n### getPageToken\n\nThe next_page_token value returned from a previous list request.\n\n### setPageToken\n\nThe next_page_token value returned from a previous list request.\n\n### getFilter\n\nThe filter expression used to filter documents returned by the list method.\n\nThe expression has the following syntax:\n\n\n- knowledge_types with has(:) operator\n- display_name with has(:) operator\n- state with equals(=) operator Examples:\n- \"knowledge_types:FAQ\" matches documents with FAQ knowledge type.\n- \"display_name:customer\" matches documents whose display name contains \"customer\".\n- \"state=ACTIVE\" matches documents with ACTIVE state.\n- \"knowledge_types:FAQ AND state=ACTIVE\" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).\n\n### setFilter\n\nThe filter expression used to filter documents returned by the list method.\n\nThe expression has the following syntax:\n\n\n- knowledge_types with has(:) operator\n- display_name with has(:) operator\n- state with equals(=) operator Examples:\n- \"knowledge_types:FAQ\" matches documents with FAQ knowledge type.\n- \"display_name:customer\" matches documents whose display name contains \"customer\".\n- \"state=ACTIVE\" matches documents with ACTIVE state.\n- \"knowledge_types:FAQ AND state=ACTIVE\" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).\n\n### static::build"]]
