Class BatchDeleteDocumentsRequest (2.31.0)

public final class BatchDeleteDocumentsRequest extends GeneratedMessageV3 implements BatchDeleteDocumentsRequestOrBuilder

Protobuf type google.cloud.documentai.v1beta3.BatchDeleteDocumentsRequest

Static Fields

DATASET_DOCUMENTS_FIELD_NUMBER

public static final int DATASET_DOCUMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

DATASET_FIELD_NUMBER

public static final int DATASET_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchDeleteDocumentsRequest getDefaultInstance()
Returns
TypeDescription
BatchDeleteDocumentsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(BatchDeleteDocumentsRequest prototype)

public static BatchDeleteDocumentsRequest.Builder newBuilder(BatchDeleteDocumentsRequest prototype)
Parameter
NameDescription
prototypeBatchDeleteDocumentsRequest
Returns
TypeDescription
BatchDeleteDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDataset()

public String getDataset()

Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string dataset = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The dataset.

getDatasetBytes()

public ByteString getDatasetBytes()

Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string dataset = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for dataset.

getDatasetDocuments()

public BatchDatasetDocuments getDatasetDocuments()

Required. Dataset documents input. If given filter, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch. The request will be rejected if more than 50 document_ids are provided.

.google.cloud.documentai.v1beta3.BatchDatasetDocuments dataset_documents = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
BatchDatasetDocuments

The datasetDocuments.

getDatasetDocumentsOrBuilder()

public BatchDatasetDocumentsOrBuilder getDatasetDocumentsOrBuilder()

Required. Dataset documents input. If given filter, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch. The request will be rejected if more than 50 document_ids are provided.

.google.cloud.documentai.v1beta3.BatchDatasetDocuments dataset_documents = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
BatchDatasetDocumentsOrBuilder

getDefaultInstanceForType()

public BatchDeleteDocumentsRequest getDefaultInstanceForType()
Returns
TypeDescription
BatchDeleteDocumentsRequest

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDatasetDocuments()

public boolean hasDatasetDocuments()

Required. Dataset documents input. If given filter, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch. The request will be rejected if more than 50 document_ids are provided.

.google.cloud.documentai.v1beta3.BatchDatasetDocuments dataset_documents = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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