Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class ListDocumentsRequest.
Request message for DocumentService.ListDocuments method.
Generated from protobuf message google.cloud.discoveryengine.v1beta.ListDocumentsRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
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 Document
s under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED
error is returned.
↳ page_size
int
Maximum number of Document
s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an INVALID_ARGUMENT
error is returned.
↳ 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 INVALID_ARGUMENT
error is returned.
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 Document
s under this
branch, regardless of whether or not this branch exists, a PERMISSION_DENIED
error is returned.
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 Document
s under this
branch, regardless of whether or not this branch exists, a PERMISSION_DENIED
error is returned.
var
string
$this
getPageSize
Maximum number of Document s to return. If unspecified, defaults to 100. The maximum allowed value is
- Values above 1000 are set to 1000.
If this field is negative, an INVALID_ARGUMENT
error is returned.
int
setPageSize
Maximum number of Document s to return. If unspecified, defaults to 100. The maximum allowed value is
- Values above 1000 are set to 1000.
If this field is negative, an INVALID_ARGUMENT
error is returned.
var
int
$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.
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.
var
string
$this
static::build
parent
string
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 Document
s under this
branch, regardless of whether or not this branch exists, a PERMISSION_DENIED
error is returned. Please see Google\Cloud\DiscoveryEngine\V1beta\DocumentServiceClient::branchName()
for help formatting this field.
