Interface DeleteDocumentRequestOrBuilder (3.12.1)

public interface DeleteDocumentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCurrentDocument()

public abstract 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
TypeDescription
Precondition

The currentDocument.

getCurrentDocumentOrBuilder()

public abstract 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
TypeDescription
PreconditionOrBuilder

getName()

public abstract 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
TypeDescription
String

The name.

getNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for name.

hasCurrentDocument()

public abstract 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
TypeDescription
boolean

Whether the currentDocument field is set.