Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListDocumentsRequest.
Request message for DocumentService.ListDocuments method.
Generated from protobuf message google.cloud.discoveryengine.v1.ListDocumentsRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent branch resource name, such as |
↳ page_size |
int
Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an |
↳ page_token |
string
A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an |
getParent
Required. The parent branch resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Use default_branch as the branch ID, to list documents under the default
branch.
If the caller does not have permission to list
Documents under this branch,
regardless of whether or not this branch exists, a PERMISSION_DENIED
error is returned.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent branch resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Use default_branch as the branch ID, to list documents under the default
branch.
If the caller does not have permission to list
Documents under this branch,
regardless of whether or not this branch exists, a PERMISSION_DENIED
error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000.
Values above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000.
Values above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
DocumentService.ListDocuments
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
DocumentService.ListDocuments
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent branch resource name, such as
If the caller does not have permission to list
Documents under this branch,
regardless of whether or not this branch exists, a |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\ListDocumentsRequest | |