com.google.firestore.v1

Interface DeleteDocumentRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DeleteDocumentRequest, DeleteDocumentRequest.Builder

public interface DeleteDocumentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Precondition	getCurrentDocument() An optional precondition on the document.
PreconditionOrBuilder	getCurrentDocumentOrBuilder() An optional precondition on the document.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
boolean	hasCurrentDocument() An optional precondition on the document.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

hasCurrentDocument

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:

Whether the currentDocument field is set.

getCurrentDocument

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:

The currentDocument.

getCurrentDocumentOrBuilder

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;