DocumentRemove.Builder (proto-google-cloud-firestore-v1 0.50.0 API)

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

All Implemented Interfaces:: DocumentRemoveOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: DocumentRemove

public static final class DocumentRemove.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DocumentRemove.Builder>
implements DocumentRemoveOrBuilder

 A [Document][google.firestore.v1.Document] has been removed from the view of the targets.
 Sent if the document is no longer relevant to a target and is out of view.
 Can be sent instead of a DocumentDelete or a DocumentChange if the server
 can not send the new value of the document.
 Multiple [DocumentRemove][google.firestore.v1.DocumentRemove] messages may be returned for the same logical
 write or delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentRemove

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentRemove.Builder`	`addAllRemovedTargetIds(Iterable<? extends Integer> values)` A set of target IDs for targets that previously matched this document.
`DocumentRemove.Builder`	`addRemovedTargetIds(int value)` A set of target IDs for targets that previously matched this document.
`DocumentRemove.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`DocumentRemove`	`build()`
`DocumentRemove`	`buildPartial()`
`DocumentRemove.Builder`	`clear()`
`DocumentRemove.Builder`	`clearDocument()` The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.
`DocumentRemove.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`DocumentRemove.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`DocumentRemove.Builder`	`clearReadTime()` The read timestamp at which the remove was observed.
`DocumentRemove.Builder`	`clearRemovedTargetIds()` A set of target IDs for targets that previously matched this document.
`DocumentRemove.Builder`	`clone()`
`DocumentRemove`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getDocument()` The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.
`com.google.protobuf.ByteString`	`getDocumentBytes()` The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.
`com.google.protobuf.Timestamp`	`getReadTime()` The read timestamp at which the remove was observed.
`com.google.protobuf.Timestamp.Builder`	`getReadTimeBuilder()` The read timestamp at which the remove was observed.
`com.google.protobuf.TimestampOrBuilder`	`getReadTimeOrBuilder()` The read timestamp at which the remove was observed.
`int`	`getRemovedTargetIds(int index)` A set of target IDs for targets that previously matched this document.
`int`	`getRemovedTargetIdsCount()` A set of target IDs for targets that previously matched this document.
`List<Integer>`	`getRemovedTargetIdsList()` A set of target IDs for targets that previously matched this document.
`boolean`	`hasReadTime()` The read timestamp at which the remove was observed.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`DocumentRemove.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`DocumentRemove.Builder`	`mergeFrom(DocumentRemove other)`
`DocumentRemove.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`DocumentRemove.Builder`	`mergeReadTime(com.google.protobuf.Timestamp value)` The read timestamp at which the remove was observed.
`DocumentRemove.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`DocumentRemove.Builder`	`setDocument(String value)` The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.
`DocumentRemove.Builder`	`setDocumentBytes(com.google.protobuf.ByteString value)` The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.
`DocumentRemove.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`DocumentRemove.Builder`	`setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)` The read timestamp at which the remove was observed.
`DocumentRemove.Builder`	`setReadTime(com.google.protobuf.Timestamp value)` The read timestamp at which the remove was observed.
`DocumentRemove.Builder`	`setRemovedTargetIds(int index, int value)` A set of target IDs for targets that previously matched this document.
`DocumentRemove.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`DocumentRemove.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, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, 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.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<DocumentRemove.Builder>

clear
```
public DocumentRemove.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<DocumentRemove.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<DocumentRemove.Builder>

getDefaultInstanceForType
```
public DocumentRemove getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public DocumentRemove build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public DocumentRemove buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public DocumentRemove.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<DocumentRemove.Builder>

setField

public DocumentRemove.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<DocumentRemove.Builder>

clearField
```
public DocumentRemove.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<DocumentRemove.Builder>

clearOneof
```
public DocumentRemove.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<DocumentRemove.Builder>

setRepeatedField

public DocumentRemove.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<DocumentRemove.Builder>

addRepeatedField

public DocumentRemove.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<DocumentRemove.Builder>

mergeFrom
```
public DocumentRemove.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<DocumentRemove.Builder>

mergeFrom

public DocumentRemove.Builder mergeFrom(DocumentRemove other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentRemove.Builder>

mergeFrom
```
public DocumentRemove.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<DocumentRemove.Builder>

Throws:

IOException

getDocument

public String getDocument()

 The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.

string document = 1;

Specified by:: getDocument in interface DocumentRemoveOrBuilder

getDocumentBytes

public com.google.protobuf.ByteString getDocumentBytes()

 The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.

string document = 1;

Specified by:: getDocumentBytes in interface DocumentRemoveOrBuilder

setDocument

public DocumentRemove.Builder setDocument(String value)

 The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.

string document = 1;

clearDocument

public DocumentRemove.Builder clearDocument()

 The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.

string document = 1;

setDocumentBytes

public DocumentRemove.Builder setDocumentBytes(com.google.protobuf.ByteString value)

 The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.

string document = 1;

getRemovedTargetIdsList
```
public List<Integer> getRemovedTargetIdsList()
```
```
 A set of target IDs for targets that previously matched this document.
 
```
repeated int32 removed_target_ids = 2;
Specified by:

getRemovedTargetIdsList in interface DocumentRemoveOrBuilder

getRemovedTargetIdsCount
```
public int getRemovedTargetIdsCount()
```
```
 A set of target IDs for targets that previously matched this document.
 
```
repeated int32 removed_target_ids = 2;
Specified by:

getRemovedTargetIdsCount in interface DocumentRemoveOrBuilder

getRemovedTargetIds
```
public int getRemovedTargetIds(int index)
```
```
 A set of target IDs for targets that previously matched this document.
 
```
repeated int32 removed_target_ids = 2;
Specified by:

getRemovedTargetIds in interface DocumentRemoveOrBuilder

setRemovedTargetIds

public DocumentRemove.Builder setRemovedTargetIds(int index,
                                                  int value)

 A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;

addRemovedTargetIds

public DocumentRemove.Builder addRemovedTargetIds(int value)

 A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;

addAllRemovedTargetIds

public DocumentRemove.Builder addAllRemovedTargetIds(Iterable<? extends Integer> values)

 A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;

clearRemovedTargetIds

public DocumentRemove.Builder clearRemovedTargetIds()

 A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;