DeleteDocumentRequest.Builder (proto-google-cloud-firestore-v1 3.13.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
    - - com.google.firestore.v1.DeleteDocumentRequest.Builder

All Implemented Interfaces:

DeleteDocumentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

DeleteDocumentRequest
```
public static final class DeleteDocumentRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
implements DeleteDocumentRequestOrBuilder
```
```
 The request for
 [Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument].
 
```
Protobuf type google.firestore.v1.DeleteDocumentRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeleteDocumentRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`DeleteDocumentRequest`	`build()`
`DeleteDocumentRequest`	`buildPartial()`
`DeleteDocumentRequest.Builder`	`clear()`
`DeleteDocumentRequest.Builder`	`clearCurrentDocument()` An optional precondition on the document.
`DeleteDocumentRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`DeleteDocumentRequest.Builder`	`clearName()` Required.
`DeleteDocumentRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`DeleteDocumentRequest.Builder`	`clone()`
`Precondition`	`getCurrentDocument()` An optional precondition on the document.
`Precondition.Builder`	`getCurrentDocumentBuilder()` An optional precondition on the document.
`PreconditionOrBuilder`	`getCurrentDocumentOrBuilder()` An optional precondition on the document.
`DeleteDocumentRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`boolean`	`hasCurrentDocument()` An optional precondition on the document.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`DeleteDocumentRequest.Builder`	`mergeCurrentDocument(Precondition value)` An optional precondition on the document.
`DeleteDocumentRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`DeleteDocumentRequest.Builder`	`mergeFrom(DeleteDocumentRequest other)`
`DeleteDocumentRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`DeleteDocumentRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`DeleteDocumentRequest.Builder`	`setCurrentDocument(Precondition.Builder builderForValue)` An optional precondition on the document.
`DeleteDocumentRequest.Builder`	`setCurrentDocument(Precondition value)` An optional precondition on the document.
`DeleteDocumentRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`DeleteDocumentRequest.Builder`	`setName(String value)` Required.
`DeleteDocumentRequest.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Required.
`DeleteDocumentRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`DeleteDocumentRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - clear
```
public DeleteDocumentRequest.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - getDefaultInstanceForType
```
public DeleteDocumentRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public DeleteDocumentRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public DeleteDocumentRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public DeleteDocumentRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - setField
```
public DeleteDocumentRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - clearField
```
public DeleteDocumentRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - clearOneof
```
public DeleteDocumentRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - setRepeatedField
```
public DeleteDocumentRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - addRepeatedField
```
public DeleteDocumentRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - mergeFrom
```
public DeleteDocumentRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeleteDocumentRequest.Builder>
  - mergeFrom
```
public DeleteDocumentRequest.Builder mergeFrom(DeleteDocumentRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - mergeFrom
```
public DeleteDocumentRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeleteDocumentRequest.Builder>
    
    Throws:
    
    IOException
  - 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];
    Specified by:
    
    getName in interface DeleteDocumentRequestOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public 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];
    Specified by:
    
    getNameBytes in interface DeleteDocumentRequestOrBuilder
    
    Returns:
    
    The bytes for name.
  - setName
```
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];
    Parameters:
    
    value - The name to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - setNameBytes
```
public DeleteDocumentRequest.Builder setNameBytes(com.google.protobuf.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];
    Parameters:
    
    value - The bytes for name to set.
    
    Returns:
    
    This builder for chaining.
  - 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;
    Specified by:
    
    hasCurrentDocument in interface DeleteDocumentRequestOrBuilder
    
    Returns:
    
    Whether the currentDocument field is set.
  - 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;
    Specified by:
    
    getCurrentDocument in interface DeleteDocumentRequestOrBuilder
    
    Returns:
    
    The currentDocument.
  - setCurrentDocument
```
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;
  - setCurrentDocument
```
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;
  - mergeCurrentDocument
```
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;
  - 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;
  - 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;
  - 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;
    Specified by:
    
    getCurrentDocumentOrBuilder in interface DeleteDocumentRequestOrBuilder
  - setUnknownFields
```
public final DeleteDocumentRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>
  - mergeUnknownFields
```
public final DeleteDocumentRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DeleteDocumentRequest.Builder>

Class DeleteDocumentRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

hasCurrentDocument

getCurrentDocument

setCurrentDocument

setCurrentDocument

mergeCurrentDocument

clearCurrentDocument

getCurrentDocumentBuilder

getCurrentDocumentOrBuilder

setUnknownFields

mergeUnknownFields