- 2.57.0 (latest)
- 2.56.0
- 2.55.0
- 2.53.0
- 2.52.0
- 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 static final class ListDocumentsRequest.Builder extends GeneratedMessageV3.Builder<ListDocumentsRequest.Builder> implements ListDocumentsRequestOrBuilder
Protobuf type google.cloud.documentai.v1beta3.ListDocumentsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListDocumentsRequest.BuilderImplements
ListDocumentsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
build()
public ListDocumentsRequest build()
Returns | |
---|---|
Type | Description |
ListDocumentsRequest |
buildPartial()
public ListDocumentsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListDocumentsRequest |
clear()
public ListDocumentsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
clearDataset()
public ListDocumentsRequest.Builder clearDataset()
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 |
ListDocumentsRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ListDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
clearFilter()
public ListDocumentsRequest.Builder clearFilter()
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 |
ListDocumentsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
clearPageSize()
public ListDocumentsRequest.Builder clearPageSize()
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 |
ListDocumentsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListDocumentsRequest.Builder clearPageToken()
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 |
ListDocumentsRequest.Builder | This builder for chaining. |
clearReturnTotalSize()
public ListDocumentsRequest.Builder clearReturnTotalSize()
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 |
ListDocumentsRequest.Builder | This builder for chaining. |
clearSkip()
public ListDocumentsRequest.Builder clearSkip()
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 |
ListDocumentsRequest.Builder | This builder for chaining. |
clone()
public ListDocumentsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
getDataset()
public 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 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. |
getDefaultInstanceForType()
public ListDocumentsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListDocumentsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFilter()
public 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListDocumentsRequest other)
public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListDocumentsRequest |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListDocumentsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
setDataset(String value)
public ListDocumentsRequest.Builder setDataset(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The dataset to set. |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder | This builder for chaining. |
setDatasetBytes(ByteString value)
public ListDocumentsRequest.Builder setDatasetBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for dataset to set. |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ListDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
setFilter(String value)
public ListDocumentsRequest.Builder setFilter(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The filter to set. |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListDocumentsRequest.Builder setFilterBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder | This builder for chaining. |
setPageSize(int value)
public ListDocumentsRequest.Builder setPageSize(int value)
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;
Parameter | |
---|---|
Name | Description |
value | int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListDocumentsRequest.Builder setPageToken(String value)
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;
Parameter | |
---|---|
Name | Description |
value | String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListDocumentsRequest.Builder setPageTokenBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListDocumentsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |
setReturnTotalSize(boolean value)
public ListDocumentsRequest.Builder setReturnTotalSize(boolean value)
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];
Parameter | |
---|---|
Name | Description |
value | boolean The returnTotalSize to set. |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder | This builder for chaining. |
setSkip(int value)
public ListDocumentsRequest.Builder setSkip(int value)
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];
Parameter | |
---|---|
Name | Description |
value | int The skip to set. |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListDocumentsRequest.Builder |