Class BatchDatasetDocuments (2.28.0)

public final class BatchDatasetDocuments extends GeneratedMessageV3 implements BatchDatasetDocumentsOrBuilder

Dataset documents that the batch operation will be applied to.

Protobuf type google.cloud.documentai.v1beta3.BatchDatasetDocuments

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

INDIVIDUAL_DOCUMENT_IDS_FIELD_NUMBER

public static final int INDIVIDUAL_DOCUMENT_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchDatasetDocuments getDefaultInstance()
Returns
TypeDescription
BatchDatasetDocuments

getDescriptor()

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

newBuilder()

public static BatchDatasetDocuments.Builder newBuilder()
Returns
TypeDescription
BatchDatasetDocuments.Builder

newBuilder(BatchDatasetDocuments prototype)

public static BatchDatasetDocuments.Builder newBuilder(BatchDatasetDocuments prototype)
Parameter
NameDescription
prototypeBatchDatasetDocuments
Returns
TypeDescription
BatchDatasetDocuments.Builder

parseDelimitedFrom(InputStream input)

public static BatchDatasetDocuments parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchDatasetDocuments parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BatchDatasetDocuments parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchDatasetDocuments parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchDatasetDocuments parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchDatasetDocuments parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchDatasetDocuments parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchDatasetDocuments parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BatchDatasetDocuments parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchDatasetDocuments parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BatchDatasetDocuments parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchDatasetDocuments parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchDatasetDocuments
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BatchDatasetDocuments> parser()
Returns
TypeDescription
Parser<BatchDatasetDocuments>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCriteriaCase()

public BatchDatasetDocuments.CriteriaCase getCriteriaCase()
Returns
TypeDescription
BatchDatasetDocuments.CriteriaCase

getDefaultInstanceForType()

public BatchDatasetDocuments getDefaultInstanceForType()
Returns
TypeDescription
BatchDatasetDocuments

getFilter()

public String getFilter()

A filter matching the documents. Follows the same format and restriction as [google.cloud.documentai.master.ListDocumentsRequest.filter].

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter matching the documents. Follows the same format and restriction as [google.cloud.documentai.master.ListDocumentsRequest.filter].

string filter = 2;

Returns
TypeDescription
ByteString

The bytes for filter.

getIndividualDocumentIds()

public BatchDatasetDocuments.IndividualDocumentIds getIndividualDocumentIds()

Document identifiers.

.google.cloud.documentai.v1beta3.BatchDatasetDocuments.IndividualDocumentIds individual_document_ids = 1;

Returns
TypeDescription
BatchDatasetDocuments.IndividualDocumentIds

The individualDocumentIds.

getIndividualDocumentIdsOrBuilder()

public BatchDatasetDocuments.IndividualDocumentIdsOrBuilder getIndividualDocumentIdsOrBuilder()

Document identifiers.

.google.cloud.documentai.v1beta3.BatchDatasetDocuments.IndividualDocumentIds individual_document_ids = 1;

Returns
TypeDescription
BatchDatasetDocuments.IndividualDocumentIdsOrBuilder

getParserForType()

public Parser<BatchDatasetDocuments> getParserForType()
Returns
TypeDescription
Parser<BatchDatasetDocuments>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasFilter()

public boolean hasFilter()

A filter matching the documents. Follows the same format and restriction as [google.cloud.documentai.master.ListDocumentsRequest.filter].

string filter = 2;

Returns
TypeDescription
boolean

Whether the filter field is set.

hasIndividualDocumentIds()

public boolean hasIndividualDocumentIds()

Document identifiers.

.google.cloud.documentai.v1beta3.BatchDatasetDocuments.IndividualDocumentIds individual_document_ids = 1;

Returns
TypeDescription
boolean

Whether the individualDocumentIds field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BatchDatasetDocuments.Builder newBuilderForType()
Returns
TypeDescription
BatchDatasetDocuments.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchDatasetDocuments.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BatchDatasetDocuments.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BatchDatasetDocuments.Builder toBuilder()
Returns
TypeDescription
BatchDatasetDocuments.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException