Class BatchDocumentsInputConfig (2.28.0)

public final class BatchDocumentsInputConfig extends GeneratedMessageV3 implements BatchDocumentsInputConfigOrBuilder

The common config to specify a set of documents used as input.

Protobuf type google.cloud.documentai.v1.BatchDocumentsInputConfig

Static Fields

GCS_DOCUMENTS_FIELD_NUMBER

public static final int GCS_DOCUMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_PREFIX_FIELD_NUMBER

public static final int GCS_PREFIX_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchDocumentsInputConfig getDefaultInstance()
Returns
TypeDescription
BatchDocumentsInputConfig

getDescriptor()

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

newBuilder()

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

newBuilder(BatchDocumentsInputConfig prototype)

public static BatchDocumentsInputConfig.Builder newBuilder(BatchDocumentsInputConfig prototype)
Parameter
NameDescription
prototypeBatchDocumentsInputConfig
Returns
TypeDescription
BatchDocumentsInputConfig.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchDocumentsInputConfig getDefaultInstanceForType()
Returns
TypeDescription
BatchDocumentsInputConfig

getGcsDocuments()

public GcsDocuments getGcsDocuments()

The set of documents individually specified on Cloud Storage.

.google.cloud.documentai.v1.GcsDocuments gcs_documents = 2;

Returns
TypeDescription
GcsDocuments

The gcsDocuments.

getGcsDocumentsOrBuilder()

public GcsDocumentsOrBuilder getGcsDocumentsOrBuilder()

The set of documents individually specified on Cloud Storage.

.google.cloud.documentai.v1.GcsDocuments gcs_documents = 2;

Returns
TypeDescription
GcsDocumentsOrBuilder

getGcsPrefix()

public GcsPrefix getGcsPrefix()

The set of documents that match the specified Cloud Storage gcs_prefix.

.google.cloud.documentai.v1.GcsPrefix gcs_prefix = 1;

Returns
TypeDescription
GcsPrefix

The gcsPrefix.

getGcsPrefixOrBuilder()

public GcsPrefixOrBuilder getGcsPrefixOrBuilder()

The set of documents that match the specified Cloud Storage gcs_prefix.

.google.cloud.documentai.v1.GcsPrefix gcs_prefix = 1;

Returns
TypeDescription
GcsPrefixOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public BatchDocumentsInputConfig.SourceCase getSourceCase()
Returns
TypeDescription
BatchDocumentsInputConfig.SourceCase

hasGcsDocuments()

public boolean hasGcsDocuments()

The set of documents individually specified on Cloud Storage.

.google.cloud.documentai.v1.GcsDocuments gcs_documents = 2;

Returns
TypeDescription
boolean

Whether the gcsDocuments field is set.

hasGcsPrefix()

public boolean hasGcsPrefix()

The set of documents that match the specified Cloud Storage gcs_prefix.

.google.cloud.documentai.v1.GcsPrefix gcs_prefix = 1;

Returns
TypeDescription
boolean

Whether the gcsPrefix 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 BatchDocumentsInputConfig.Builder newBuilderForType()
Returns
TypeDescription
BatchDocumentsInputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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