public static final class ListDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder> implements ListDocumentsRequestOrBuilder
google.cloud.documentai.v1beta3.ListDocumentsRequest| Modifier and Type | Method and Description |
|---|---|
ListDocumentsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListDocumentsRequest |
build() |
ListDocumentsRequest |
buildPartial() |
ListDocumentsRequest.Builder |
clear() |
ListDocumentsRequest.Builder |
clearDataset()
Required.
|
ListDocumentsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ListDocumentsRequest.Builder |
clearFilter()
Optional.
|
ListDocumentsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ListDocumentsRequest.Builder |
clearPageSize()
The maximum number of documents to return.
|
ListDocumentsRequest.Builder |
clearPageToken()
A page token, received from a previous `ListDocuments` call.
|
ListDocumentsRequest.Builder |
clearReturnTotalSize()
Optional.
|
ListDocumentsRequest.Builder |
clearSkip()
Optional.
|
ListDocumentsRequest.Builder |
clone() |
String |
getDataset()
Required.
|
com.google.protobuf.ByteString |
getDatasetBytes()
Required.
|
ListDocumentsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getFilter()
Optional.
|
com.google.protobuf.ByteString |
getFilterBytes()
Optional.
|
int |
getPageSize()
The maximum number of documents to return.
|
String |
getPageToken()
A page token, received from a previous `ListDocuments` call.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
A page token, received from a previous `ListDocuments` call.
|
boolean |
getReturnTotalSize()
Optional.
|
int |
getSkip()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ListDocumentsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ListDocumentsRequest.Builder |
mergeFrom(ListDocumentsRequest other) |
ListDocumentsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ListDocumentsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ListDocumentsRequest.Builder |
setDataset(String value)
Required.
|
ListDocumentsRequest.Builder |
setDatasetBytes(com.google.protobuf.ByteString value)
Required.
|
ListDocumentsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListDocumentsRequest.Builder |
setFilter(String value)
Optional.
|
ListDocumentsRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Optional.
|
ListDocumentsRequest.Builder |
setPageSize(int value)
The maximum number of documents to return.
|
ListDocumentsRequest.Builder |
setPageToken(String value)
A page token, received from a previous `ListDocuments` call.
|
ListDocumentsRequest.Builder |
setPageTokenBytes(com.google.protobuf.ByteString value)
A page token, received from a previous `ListDocuments` call.
|
ListDocumentsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ListDocumentsRequest.Builder |
setReturnTotalSize(boolean value)
Optional.
|
ListDocumentsRequest.Builder |
setSkip(int value)
Optional.
|
ListDocumentsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ListDocumentsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ListDocumentsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ListDocumentsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public ListDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDocumentsRequest.Builder>IOExceptionpublic 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) = { ... }
getDataset in interface ListDocumentsRequestOrBuilderpublic com.google.protobuf.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) = { ... }
getDatasetBytes in interface ListDocumentsRequestOrBuilderpublic 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) = { ... }
value - The dataset to set.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) = { ... }
public ListDocumentsRequest.Builder setDatasetBytes(com.google.protobuf.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) = { ... }
value - The bytes for dataset to set.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;getPageSize in interface ListDocumentsRequestOrBuilderpublic 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;value - The pageSize to set.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;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;getPageToken in interface ListDocumentsRequestOrBuilderpublic com.google.protobuf.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;getPageTokenBytes in interface ListDocumentsRequestOrBuilderpublic 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;value - The pageToken to set.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;public ListDocumentsRequest.Builder setPageTokenBytes(com.google.protobuf.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;value - The bytes for pageToken to set.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 in `DisplayName` 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];getFilter in interface ListDocumentsRequestOrBuilderpublic com.google.protobuf.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 in `DisplayName` 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];getFilterBytes in interface ListDocumentsRequestOrBuilderpublic 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 in `DisplayName` 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];value - The filter to set.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 in `DisplayName` 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];public ListDocumentsRequest.Builder setFilterBytes(com.google.protobuf.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 in `DisplayName` 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];value - The bytes for filter to set.public boolean getReturnTotalSize()
Optional. Controls if the request requires a total size of matched documents. See [ListDocumentsResponse.total_size][google.cloud.documentai.v1beta3.ListDocumentsResponse.total_size]. Enabling this flag may adversely impact performance. Defaults to false.
bool return_total_size = 6 [(.google.api.field_behavior) = OPTIONAL];getReturnTotalSize in interface ListDocumentsRequestOrBuilderpublic ListDocumentsRequest.Builder setReturnTotalSize(boolean value)
Optional. Controls if the request requires a total size of matched documents. See [ListDocumentsResponse.total_size][google.cloud.documentai.v1beta3.ListDocumentsResponse.total_size]. Enabling this flag may adversely impact performance. Defaults to false.
bool return_total_size = 6 [(.google.api.field_behavior) = OPTIONAL];value - The returnTotalSize to set.public ListDocumentsRequest.Builder clearReturnTotalSize()
Optional. Controls if the request requires a total size of matched documents. See [ListDocumentsResponse.total_size][google.cloud.documentai.v1beta3.ListDocumentsResponse.total_size]. Enabling this flag may adversely impact performance. Defaults to false.
bool return_total_size = 6 [(.google.api.field_behavior) = OPTIONAL];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][google.cloud.documentai.v1beta3.ListDocumentsResponse.document_metadata] and [ListDocumentsResponse.next_page_token][google.cloud.documentai.v1beta3.ListDocumentsResponse.next_page_token] will be empty.
int32 skip = 8 [(.google.api.field_behavior) = OPTIONAL];getSkip in interface ListDocumentsRequestOrBuilderpublic 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][google.cloud.documentai.v1beta3.ListDocumentsResponse.document_metadata] and [ListDocumentsResponse.next_page_token][google.cloud.documentai.v1beta3.ListDocumentsResponse.next_page_token] will be empty.
int32 skip = 8 [(.google.api.field_behavior) = OPTIONAL];value - The skip to set.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][google.cloud.documentai.v1beta3.ListDocumentsResponse.document_metadata] and [ListDocumentsResponse.next_page_token][google.cloud.documentai.v1beta3.ListDocumentsResponse.next_page_token] will be empty.
int32 skip = 8 [(.google.api.field_behavior) = OPTIONAL];public final ListDocumentsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>public final ListDocumentsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>Copyright © 2024 Google LLC. All rights reserved.