Class ImportDocumentsMetadata (2.51.0)

public final class ImportDocumentsMetadata extends GeneratedMessageV3 implements ImportDocumentsMetadataOrBuilder

Metadata of the import document operation.

Protobuf type google.cloud.documentai.v1beta3.ImportDocumentsMetadata

Static Fields

COMMON_METADATA_FIELD_NUMBER

public static final int COMMON_METADATA_FIELD_NUMBER
Field Value
Type Description
int

IMPORT_CONFIG_VALIDATION_RESULTS_FIELD_NUMBER

public static final int IMPORT_CONFIG_VALIDATION_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

INDIVIDUAL_IMPORT_STATUSES_FIELD_NUMBER

public static final int INDIVIDUAL_IMPORT_STATUSES_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_DOCUMENT_COUNT_FIELD_NUMBER

public static final int TOTAL_DOCUMENT_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImportDocumentsMetadata getDefaultInstance()
Returns
Type Description
ImportDocumentsMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(ImportDocumentsMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCommonMetadata()

public CommonOperationMetadata getCommonMetadata()

The basic metadata of the long-running operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata common_metadata = 1;

Returns
Type Description
CommonOperationMetadata

The commonMetadata.

getCommonMetadataOrBuilder()

public CommonOperationMetadataOrBuilder getCommonMetadataOrBuilder()

The basic metadata of the long-running operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata common_metadata = 1;

Returns
Type Description
CommonOperationMetadataOrBuilder

getDefaultInstanceForType()

public ImportDocumentsMetadata getDefaultInstanceForType()
Returns
Type Description
ImportDocumentsMetadata

getImportConfigValidationResults(int index)

public ImportDocumentsMetadata.ImportConfigValidationResult getImportConfigValidationResults(int index)

Validation statuses of the batch documents import config.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.ImportConfigValidationResult import_config_validation_results = 4;

Parameter
Name Description
index int
Returns
Type Description
ImportDocumentsMetadata.ImportConfigValidationResult

getImportConfigValidationResultsCount()

public int getImportConfigValidationResultsCount()

Validation statuses of the batch documents import config.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.ImportConfigValidationResult import_config_validation_results = 4;

Returns
Type Description
int

getImportConfigValidationResultsList()

public List<ImportDocumentsMetadata.ImportConfigValidationResult> getImportConfigValidationResultsList()

Validation statuses of the batch documents import config.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.ImportConfigValidationResult import_config_validation_results = 4;

Returns
Type Description
List<ImportConfigValidationResult>

getImportConfigValidationResultsOrBuilder(int index)

public ImportDocumentsMetadata.ImportConfigValidationResultOrBuilder getImportConfigValidationResultsOrBuilder(int index)

Validation statuses of the batch documents import config.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.ImportConfigValidationResult import_config_validation_results = 4;

Parameter
Name Description
index int
Returns
Type Description
ImportDocumentsMetadata.ImportConfigValidationResultOrBuilder

getImportConfigValidationResultsOrBuilderList()

public List<? extends ImportDocumentsMetadata.ImportConfigValidationResultOrBuilder> getImportConfigValidationResultsOrBuilderList()

Validation statuses of the batch documents import config.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.ImportConfigValidationResult import_config_validation_results = 4;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1beta3.ImportDocumentsMetadata.ImportConfigValidationResultOrBuilder>

getIndividualImportStatuses(int index)

public ImportDocumentsMetadata.IndividualImportStatus getIndividualImportStatuses(int index)

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IndividualImportStatus individual_import_statuses = 2;

Parameter
Name Description
index int
Returns
Type Description
ImportDocumentsMetadata.IndividualImportStatus

getIndividualImportStatusesCount()

public int getIndividualImportStatusesCount()

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IndividualImportStatus individual_import_statuses = 2;

Returns
Type Description
int

getIndividualImportStatusesList()

public List<ImportDocumentsMetadata.IndividualImportStatus> getIndividualImportStatusesList()

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IndividualImportStatus individual_import_statuses = 2;

Returns
Type Description
List<IndividualImportStatus>

getIndividualImportStatusesOrBuilder(int index)

public ImportDocumentsMetadata.IndividualImportStatusOrBuilder getIndividualImportStatusesOrBuilder(int index)

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IndividualImportStatus individual_import_statuses = 2;

Parameter
Name Description
index int
Returns
Type Description
ImportDocumentsMetadata.IndividualImportStatusOrBuilder

getIndividualImportStatusesOrBuilderList()

public List<? extends ImportDocumentsMetadata.IndividualImportStatusOrBuilder> getIndividualImportStatusesOrBuilderList()

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IndividualImportStatus individual_import_statuses = 2;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IndividualImportStatusOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalDocumentCount()

public int getTotalDocumentCount()

Total number of the documents that are qualified for importing.

int32 total_document_count = 3;

Returns
Type Description
int

The totalDocumentCount.

hasCommonMetadata()

public boolean hasCommonMetadata()

The basic metadata of the long-running operation.

.google.cloud.documentai.v1beta3.CommonOperationMetadata common_metadata = 1;

Returns
Type Description
boolean

Whether the commonMetadata field is set.

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 ImportDocumentsMetadata.Builder newBuilderForType()
Returns
Type Description
ImportDocumentsMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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