Send feedback
Class DeleteDocumentRequest (3.21.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.21.1 keyboard_arrow_down
public final class DeleteDocumentRequest extends GeneratedMessageV3 implements DeleteDocumentRequestOrBuilder
The request for
Firestore.DeleteDocument .
Protobuf type google.firestore.v1.DeleteDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CURRENT_DOCUMENT_FIELD_NUMBER
public static final int CURRENT_DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static DeleteDocumentRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static DeleteDocumentRequest . Builder newBuilder ()
newBuilder(DeleteDocumentRequest prototype)
public static DeleteDocumentRequest . Builder newBuilder ( DeleteDocumentRequest prototype )
public static DeleteDocumentRequest parseDelimitedFrom ( InputStream input )
public static DeleteDocumentRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static DeleteDocumentRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DeleteDocumentRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static DeleteDocumentRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DeleteDocumentRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static DeleteDocumentRequest parseFrom ( CodedInputStream input )
public static DeleteDocumentRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static DeleteDocumentRequest parseFrom ( InputStream input )
public static DeleteDocumentRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static DeleteDocumentRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DeleteDocumentRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<DeleteDocumentRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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;
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 ()
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.
getParserForType()
public Parser<DeleteDocumentRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public DeleteDocumentRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DeleteDocumentRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public DeleteDocumentRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
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-27 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-27 UTC."],[],[]]
