Class BatchDeleteDocumentsMetadata (2.57.0)

public final class BatchDeleteDocumentsMetadata extends GeneratedMessageV3 implements BatchDeleteDocumentsMetadataOrBuilder

Protobuf type google.cloud.documentai.v1beta3.BatchDeleteDocumentsMetadata

Static Fields

COMMON_METADATA_FIELD_NUMBER

public static final int COMMON_METADATA_FIELD_NUMBER
Field Value
Type Description
int

ERROR_DOCUMENT_COUNT_FIELD_NUMBER

public static final int ERROR_DOCUMENT_COUNT_FIELD_NUMBER
Field Value
Type Description
int

INDIVIDUAL_BATCH_DELETE_STATUSES_FIELD_NUMBER

public static final int INDIVIDUAL_BATCH_DELETE_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 BatchDeleteDocumentsMetadata getDefaultInstance()
Returns
Type Description
BatchDeleteDocumentsMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(BatchDeleteDocumentsMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 BatchDeleteDocumentsMetadata getDefaultInstanceForType()
Returns
Type Description
BatchDeleteDocumentsMetadata

getErrorDocumentCount()

public int getErrorDocumentCount()

Total number of documents that failed to be deleted in storage.

int32 error_document_count = 4;

Returns
Type Description
int

The errorDocumentCount.

getIndividualBatchDeleteStatuses(int index)

public BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatus getIndividualBatchDeleteStatuses(int index)

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatus individual_batch_delete_statuses = 2;

Parameter
Name Description
index int
Returns
Type Description
BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatus

getIndividualBatchDeleteStatusesCount()

public int getIndividualBatchDeleteStatusesCount()

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatus individual_batch_delete_statuses = 2;

Returns
Type Description
int

getIndividualBatchDeleteStatusesList()

public List<BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatus> getIndividualBatchDeleteStatusesList()

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatus individual_batch_delete_statuses = 2;

Returns
Type Description
List<IndividualBatchDeleteStatus>

getIndividualBatchDeleteStatusesOrBuilder(int index)

public BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatusOrBuilder getIndividualBatchDeleteStatusesOrBuilder(int index)

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatus individual_batch_delete_statuses = 2;

Parameter
Name Description
index int
Returns
Type Description
BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatusOrBuilder

getIndividualBatchDeleteStatusesOrBuilderList()

public List<? extends BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatusOrBuilder> getIndividualBatchDeleteStatusesOrBuilderList()

The list of response details of each document.

repeated .google.cloud.documentai.v1beta3.BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatus individual_batch_delete_statuses = 2;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1beta3.BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatusOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalDocumentCount()

public int getTotalDocumentCount()

Total number of documents deleting from dataset.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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