Class DeleteDocumentRequest.Builder (3.30.2)

public static final class DeleteDocumentRequest.Builder extends GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder> implements DeleteDocumentRequestOrBuilder

The request for Firestore.DeleteDocument.

Protobuf type google.firestore.v1.DeleteDocumentRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DeleteDocumentRequest.Builder

Implements

DeleteDocumentRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeleteDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DeleteDocumentRequest build()

Returns
Type	Description
`DeleteDocumentRequest`

buildPartial()

public DeleteDocumentRequest buildPartial()

Returns
Type	Description
`DeleteDocumentRequest`

clear()

public DeleteDocumentRequest.Builder clear()

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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;

Returns
Type	Description
`DeleteDocumentRequest.Builder`

clearField(Descriptors.FieldDescriptor field)

public DeleteDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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];

Returns
Type	Description
`DeleteDocumentRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DeleteDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public DeleteDocumentRequest.Builder clone()

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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.

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;

Returns
Type	Description
`Precondition.Builder`

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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;

Parameter
Name	Description
`value`	`Precondition`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

mergeFrom(DeleteDocumentRequest other)

public DeleteDocumentRequest.Builder mergeFrom(DeleteDocumentRequest other)

Parameter
Name	Description
`other`	`DeleteDocumentRequest`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeleteDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DeleteDocumentRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeleteDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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;

Parameter
Name	Description
`value`	`Precondition`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

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;

Parameter
Name	Description
`builderForValue`	`Precondition.Builder`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public DeleteDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
`value`	`String` The name to set.

Returns
Type	Description
`DeleteDocumentRequest.Builder`	This builder for chaining.

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
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`DeleteDocumentRequest.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeleteDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final DeleteDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DeleteDocumentRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)