google.cloud.dialogflow.v2.ListDocumentsRequest */ class ListDocumentsRequest extends \Google\Protobuf\Internal\Message { /** * Required. The knowledge base to list all documents for. * Format: `projects//locations//knowledgeBases/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $parent = ''; /** * The maximum number of items to return in a single page. By * default 10 and at most 100. * * Generated from protobuf field int32 page_size = 2; */ private $page_size = 0; /** * The next_page_token value returned from a previous list request. * * Generated from protobuf field string page_token = 3; */ private $page_token = ''; /** * The filter expression used to filter documents returned by the list method. * The expression has the following syntax: * [AND ] ... * 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). * * Generated from protobuf field string filter = 4; */ private $filter = ''; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $parent * Required. The knowledge base to list all documents for. * Format: `projects//locations//knowledgeBases/`. * @type int $page_size * The maximum number of items to return in a single page. By * default 10 and at most 100. * @type string $page_token * The next_page_token value returned from a previous list request. * @type string $filter * The filter expression used to filter documents returned by the list method. * The expression has the following syntax: * [AND ] ... * 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). * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Cloud\Dialogflow\V2\Document::initOnce(); parent::__construct($data); } /** * Required. The knowledge base to list all documents for. * Format: `projects//locations//knowledgeBases/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getParent() { return $this->parent; } /** * Required. The knowledge base to list all documents for. * Format: `projects//locations//knowledgeBases/`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ public function setParent($var) { GPBUtil::checkString($var, True); $this->parent = $var; return $this; } /** * The maximum number of items to return in a single page. By * default 10 and at most 100. * * Generated from protobuf field int32 page_size = 2; * @return int */ public function getPageSize() { return $this->page_size; } /** * The maximum number of items to return in a single page. By * default 10 and at most 100. * * Generated from protobuf field int32 page_size = 2; * @param int $var * @return $this */ public function setPageSize($var) { GPBUtil::checkInt32($var); $this->page_size = $var; return $this; } /** * The next_page_token value returned from a previous list request. * * Generated from protobuf field string page_token = 3; * @return string */ public function getPageToken() { return $this->page_token; } /** * The next_page_token value returned from a previous list request. * * Generated from protobuf field string page_token = 3; * @param string $var * @return $this */ public function setPageToken($var) { GPBUtil::checkString($var, True); $this->page_token = $var; return $this; } /** * The filter expression used to filter documents returned by the list method. * The expression has the following syntax: * [AND ] ... * 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). * * Generated from protobuf field string filter = 4; * @return string */ public function getFilter() { return $this->filter; } /** * The filter expression used to filter documents returned by the list method. * The expression has the following syntax: * [AND ] ... * 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). * * Generated from protobuf field string filter = 4; * @param string $var * @return $this */ public function setFilter($var) { GPBUtil::checkString($var, True); $this->filter = $var; return $this; } }