Class ListDocumentsRequest (2.58.0) 

public final class ListDocumentsRequest extends GeneratedMessageV3 implements ListDocumentsRequestOrBuilder

Protobuf type google.cloud.documentai.v1beta3.ListDocumentsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListDocumentsRequest

Static Fields

DATASET_FIELD_NUMBER

public static final int DATASET_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

RETURN_TOTAL_SIZE_FIELD_NUMBER

public static final int RETURN_TOTAL_SIZE_FIELD_NUMBER
Field Value
Type Description
int

SKIP_FIELD_NUMBER

public static final int SKIP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListDocumentsRequest getDefaultInstance()
Returns
Type Description
ListDocumentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListDocumentsRequest.Builder newBuilder()
Returns
Type Description
ListDocumentsRequest.Builder

newBuilder(ListDocumentsRequest prototype)

public static ListDocumentsRequest.Builder newBuilder(ListDocumentsRequest prototype)
Parameter
Name Description
prototype ListDocumentsRequest
Returns
Type Description
ListDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListDocumentsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListDocumentsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListDocumentsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListDocumentsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListDocumentsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListDocumentsRequest> parser()
Returns
Type Description
Parser<ListDocumentsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
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

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

getParserForType()

public Parser<ListDocumentsRequest> getParserForType()
Returns
Type Description
Parser<ListDocumentsRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListDocumentsRequest.Builder newBuilderForType()
Returns
Type Description
ListDocumentsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListDocumentsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListDocumentsRequest.Builder toBuilder()
Returns
Type Description
ListDocumentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException