Class ListDocumentsRequest.Builder (2.39.0) 

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.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides

build()

public ListDocumentsRequest build()
Returns
TypeDescription
ListDocumentsRequest

buildPartial()

public ListDocumentsRequest buildPartial()
Returns
TypeDescription
ListDocumentsRequest

clear()

public ListDocumentsRequest.Builder clear()
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides

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
TypeDescription
ListDocumentsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ListDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides

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 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];

Returns
TypeDescription
ListDocumentsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
ListDocumentsRequest.Builder

This builder for chaining.

clearReturnTotalSize()

public ListDocumentsRequest.Builder clearReturnTotalSize()

Optional. Controls if the ListDocuments 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
TypeDescription
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 wil 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
TypeDescription
ListDocumentsRequest.Builder

This builder for chaining.

clone()

public ListDocumentsRequest.Builder clone()
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for dataset.

getDefaultInstanceForType()

public ListDocumentsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListDocumentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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 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];

Returns
TypeDescription
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 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];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for pageToken.

getReturnTotalSize()

public boolean getReturnTotalSize()

Optional. Controls if the ListDocuments 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
TypeDescription
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 wil 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
TypeDescription
int

The skip.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListDocumentsRequest other)

public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)
Parameter
NameDescription
otherListDocumentsRequest
Returns
TypeDescription
ListDocumentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListDocumentsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides

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
NameDescription
valueString

The dataset to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for dataset to set.

Returns
TypeDescription
ListDocumentsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ListDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides

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 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];

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
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 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];

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides

setReturnTotalSize(boolean value)

public ListDocumentsRequest.Builder setReturnTotalSize(boolean value)

Optional. Controls if the ListDocuments 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
NameDescription
valueboolean

The returnTotalSize to set.

Returns
TypeDescription
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 wil 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
NameDescription
valueint

The skip to set.

Returns
TypeDescription
ListDocumentsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListDocumentsRequest.Builder
Overrides