Class BatchDeleteDocumentsRequest (2.48.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
Type Description
int

DATASET_FIELD_NUMBER

public static final int DATASET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchDeleteDocumentsRequest getDefaultInstance()
Returns
Type Description
BatchDeleteDocumentsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(BatchDeleteDocumentsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
BatchDatasetDocumentsOrBuilder

getDefaultInstanceForType()

public BatchDeleteDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
BatchDeleteDocumentsRequest

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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