public interface ListDocumentsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getPageSize()
public abstract int getPageSize()
Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is
- Values above 1000 will be coerced to 1000.
If this field is negative, an
INVALID_ARGUMENT
error is returned.
int32 page_size = 2;
Returns | |
---|---|
Type | Description |
int | The pageSize. |
getPageToken()
public abstract String 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 page_token = 3;
Returns | |
---|---|
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()
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 page_token = 3;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public abstract String 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][]s under this
branch, regardless of whether or not this branch exists, a
PERMISSION_DENIED
error is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The parent. |
getParentBytes()
public abstract ByteString getParentBytes()
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][]s under this
branch, regardless of whether or not this branch exists, a
PERMISSION_DENIED
error is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for parent. |