public final class DeleteDocumentRequest extends GeneratedMessage implements DeleteDocumentRequestOrBuilderThe request for Firestore.DeleteDocument.
Protobuf type google.firestore.v1.DeleteDocumentRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DeleteDocumentRequestImplements
DeleteDocumentRequestOrBuilderStatic 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()| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static DeleteDocumentRequest.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest.Builder |
|
newBuilder(DeleteDocumentRequest prototype)
public static DeleteDocumentRequest.Builder newBuilder(DeleteDocumentRequest prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
DeleteDocumentRequest |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest.Builder |
|
parseDelimitedFrom(InputStream input)
public static DeleteDocumentRequest parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DeleteDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static DeleteDocumentRequest parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DeleteDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static DeleteDocumentRequest parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DeleteDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static DeleteDocumentRequest parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DeleteDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static DeleteDocumentRequest parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DeleteDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static DeleteDocumentRequest parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DeleteDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<DeleteDocumentRequest> parser()| Returns | |
|---|---|
| Type | Description |
Parser<DeleteDocumentRequest> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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. |
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 |
|
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. |
getParserForType()
public Parser<DeleteDocumentRequest> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<DeleteDocumentRequest> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public DeleteDocumentRequest.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected DeleteDocumentRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest.Builder |
|
toBuilder()
public DeleteDocumentRequest.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
DeleteDocumentRequest.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|