Interface BatchDeleteDocumentsMetadataOrBuilder (2.28.0)

public interface BatchDeleteDocumentsMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCommonMetadata()

public abstract CommonOperationMetadata getCommonMetadata()

The basic metadata of the long running operation.

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

Returns
TypeDescription
CommonOperationMetadata

The commonMetadata.

getCommonMetadataOrBuilder()

public abstract CommonOperationMetadataOrBuilder getCommonMetadataOrBuilder()

The basic metadata of the long running operation.

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

Returns
TypeDescription
CommonOperationMetadataOrBuilder

getErrorDocumentCount()

public abstract int getErrorDocumentCount()

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

int32 error_document_count = 4;

Returns
TypeDescription
int

The errorDocumentCount.

getIndividualBatchDeleteStatuses(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatus

getIndividualBatchDeleteStatusesCount()

public abstract int getIndividualBatchDeleteStatusesCount()

The list of response details of each document.

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

Returns
TypeDescription
int

getIndividualBatchDeleteStatusesList()

public abstract 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
TypeDescription
List<IndividualBatchDeleteStatus>

getIndividualBatchDeleteStatusesOrBuilder(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatusOrBuilder

getIndividualBatchDeleteStatusesOrBuilderList()

public abstract 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
TypeDescription
List<? extends com.google.cloud.documentai.v1beta3.BatchDeleteDocumentsMetadata.IndividualBatchDeleteStatusOrBuilder>

getTotalDocumentCount()

public abstract int getTotalDocumentCount()

Total number of documents deleting from dataset.

int32 total_document_count = 3;

Returns
TypeDescription
int

The totalDocumentCount.

hasCommonMetadata()

public abstract boolean hasCommonMetadata()

The basic metadata of the long running operation.

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

Returns
TypeDescription
boolean

Whether the commonMetadata field is set.