Send feedback
Class DeleteDocumentRequest.Builder (3.12.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.12.1 keyboard_arrow_down
public static final class DeleteDocumentRequest . Builder extends GeneratedMessageV3 . Builder<DeleteDocumentRequest . Builder > implements DeleteDocumentRequestOrBuilder
The request for
Firestore.DeleteDocument .
Protobuf type google.firestore.v1.DeleteDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DeleteDocumentRequest . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public DeleteDocumentRequest build ()
buildPartial()
public DeleteDocumentRequest buildPartial ()
clear()
public DeleteDocumentRequest . Builder clear ()
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;
clearField(Descriptors.FieldDescriptor field)
public DeleteDocumentRequest . Builder clearField ( Descriptors . FieldDescriptor field )
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public DeleteDocumentRequest . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clone()
public DeleteDocumentRequest . Builder clone ()
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;
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;
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;
getDefaultInstanceForType()
public DeleteDocumentRequest getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
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 ()
Overrides
isInitialized()
public final boolean isInitialized ()
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;
mergeFrom(DeleteDocumentRequest other)
public DeleteDocumentRequest . Builder mergeFrom ( DeleteDocumentRequest other )
public DeleteDocumentRequest . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public DeleteDocumentRequest . Builder mergeFrom ( Message other )
Parameter Name Description otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DeleteDocumentRequest . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
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;
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;
setField(Descriptors.FieldDescriptor field, Object value)
public DeleteDocumentRequest . Builder setField ( Descriptors . FieldDescriptor field , Object value )
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 valueString The name to set.
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 valueByteString The bytes for name to set.
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DeleteDocumentRequest . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final DeleteDocumentRequest . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
