- 2.52.0 (latest)
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.5
- 2.6.2
- 2.5.1
- 2.4.3
- 2.3.1
- 2.2.1
- 2.1.9
public interface ListDocumentsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getDataset()
public abstract String getDataset()
Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The dataset. |
getDatasetBytes()
public abstract ByteString getDatasetBytes()
Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for dataset. |
getFilter()
public abstract String getFilter()
Optional. Query to filter the documents based on https://google.aip.dev/160.
Currently support query strings are:
SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED
LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED
DisplayName=\"file_name.pdf\"
EntityType=abc/def
TagName=\"auto-labeling-running\"|\"sampled\"
Note:
- Only
AND
,=
and!=
are supported. e.g.DisplayName=file_name AND EntityType!=abc
IS supported. - Wildcard
*
is supported only inDisplayName
filter - No duplicate filter keys are allowed,
e.g.
EntityType=a AND EntityType=b
is NOT supported. - String match is case sensitive (for filter
DisplayName
&EntityType
).
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()
Optional. Query to filter the documents based on https://google.aip.dev/160.
Currently support query strings are:
SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED
LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED
DisplayName=\"file_name.pdf\"
EntityType=abc/def
TagName=\"auto-labeling-running\"|\"sampled\"
Note:
- Only
AND
,=
and!=
are supported. e.g.DisplayName=file_name AND EntityType!=abc
IS supported. - Wildcard
*
is supported only inDisplayName
filter - No duplicate filter keys are allowed,
e.g.
EntityType=a AND EntityType=b
is NOT supported. - String match is case sensitive (for filter
DisplayName
&EntityType
).
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for filter. |
getPageSize()
public abstract int getPageSize()
The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100.
int32 page_size = 2;
Returns | |
---|---|
Type | Description |
int | The pageSize. |
getPageToken()
public abstract String getPageToken()
A page token, received from a previous ListDocuments
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDocuments
must match the call that provided the page token.
string page_token = 3;
Returns | |
---|---|
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()
A page token, received from a previous ListDocuments
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDocuments
must match the call that provided the page token.
string page_token = 3;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pageToken. |
getReturnTotalSize()
public abstract boolean getReturnTotalSize()
Optional. Controls if the request requires a total size of matched documents. See ListDocumentsResponse.total_size.
Enabling this flag may adversely impact performance.
Defaults to false.
bool return_total_size = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | The returnTotalSize. |
getSkip()
public abstract int getSkip()
Optional. Number of results to skip beginning from the page_token
if
provided. https://google.aip.dev/158#skipping-results. It must be a
non-negative integer. Negative values will be rejected. Note that this is
not the number of pages to skip. If this value causes the cursor to move
past the end of results,
ListDocumentsResponse.document_metadata
and
ListDocumentsResponse.next_page_token
will be empty.
int32 skip = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The skip. |