Class DeleteDocumentRequest.Builder (3.22.0)

public static final class DeleteDocumentRequest.Builder extends GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder> implements DeleteDocumentRequestOrBuilder

The request for Firestore.DeleteDocument.

Protobuf type google.firestore.v1.DeleteDocumentRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeleteDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides

build()

public DeleteDocumentRequest build()
Returns
Type Description
DeleteDocumentRequest

buildPartial()

public DeleteDocumentRequest buildPartial()
Returns
Type Description
DeleteDocumentRequest

clear()

public DeleteDocumentRequest.Builder clear()
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides

clearCurrentDocument()

public DeleteDocumentRequest.Builder clearCurrentDocument()

An optional precondition on the document. The request will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 2;

Returns
Type Description
DeleteDocumentRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public DeleteDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides

clearName()

public DeleteDocumentRequest.Builder clearName()

Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

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

Returns
Type Description
DeleteDocumentRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DeleteDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides

clone()

public DeleteDocumentRequest.Builder clone()
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides

getCurrentDocument()

public Precondition getCurrentDocument()

An optional precondition on the document. The request will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 2;

Returns
Type Description
Precondition

The currentDocument.

getCurrentDocumentBuilder()

public Precondition.Builder getCurrentDocumentBuilder()

An optional precondition on the document. The request will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 2;

Returns
Type Description
Precondition.Builder

getCurrentDocumentOrBuilder()

public PreconditionOrBuilder getCurrentDocumentOrBuilder()

An optional precondition on the document. The request will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 2;

Returns
Type Description
PreconditionOrBuilder

getDefaultInstanceForType()

public DeleteDocumentRequest getDefaultInstanceForType()
Returns
Type Description
DeleteDocumentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

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

Returns
Type Description
ByteString

The bytes for name.

hasCurrentDocument()

public boolean hasCurrentDocument()

An optional precondition on the document. The request will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 2;

Returns
Type Description
boolean

Whether the currentDocument field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCurrentDocument(Precondition value)

public DeleteDocumentRequest.Builder mergeCurrentDocument(Precondition value)

An optional precondition on the document. The request will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 2;

Parameter
Name Description
value Precondition
Returns
Type Description
DeleteDocumentRequest.Builder

mergeFrom(DeleteDocumentRequest other)

public DeleteDocumentRequest.Builder mergeFrom(DeleteDocumentRequest other)
Parameter
Name Description
other DeleteDocumentRequest
Returns
Type Description
DeleteDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeleteDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DeleteDocumentRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeleteDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides

setCurrentDocument(Precondition value)

public DeleteDocumentRequest.Builder setCurrentDocument(Precondition value)

An optional precondition on the document. The request will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 2;

Parameter
Name Description
value Precondition
Returns
Type Description
DeleteDocumentRequest.Builder

setCurrentDocument(Precondition.Builder builderForValue)

public DeleteDocumentRequest.Builder setCurrentDocument(Precondition.Builder builderForValue)

An optional precondition on the document. The request will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 2;

Parameter
Name Description
builderForValue Precondition.Builder
Returns
Type Description
DeleteDocumentRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DeleteDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides

setName(String value)

public DeleteDocumentRequest.Builder setName(String value)

Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DeleteDocumentRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DeleteDocumentRequest.Builder setNameBytes(ByteString value)

Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DeleteDocumentRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeleteDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DeleteDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeleteDocumentRequest.Builder
Overrides