public static final class DocumentDelete.Builder extends GeneratedMessageV3.Builder<DocumentDelete.Builder> implements DocumentDeleteOrBuilder
A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.
Protobuf type google.firestore.v1.DocumentDelete
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DocumentDelete.BuilderImplements
DocumentDeleteOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addAllRemovedTargetIds(Iterable<? extends Integer> values)
public DocumentDelete.Builder addAllRemovedTargetIds(Iterable<? extends Integer> values)
A set of target IDs for targets that previously matched this entity.
repeated int32 removed_target_ids = 6;
Name | Description |
values | Iterable<? extends java.lang.Integer> The removedTargetIds to add. |
Type | Description |
DocumentDelete.Builder | This builder for chaining. |
addRemovedTargetIds(int value)
public DocumentDelete.Builder addRemovedTargetIds(int value)
A set of target IDs for targets that previously matched this entity.
repeated int32 removed_target_ids = 6;
Name | Description |
value | int The removedTargetIds to add. |
Type | Description |
DocumentDelete.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DocumentDelete.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
DocumentDelete.Builder |
build()
public DocumentDelete build()
Type | Description |
DocumentDelete |
buildPartial()
public DocumentDelete buildPartial()
Type | Description |
DocumentDelete |
clear()
public DocumentDelete.Builder clear()
Type | Description |
DocumentDelete.Builder |
clearDocument()
public DocumentDelete.Builder clearDocument()
The resource name of the Document that was deleted.
string document = 1;
Type | Description |
DocumentDelete.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public DocumentDelete.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
DocumentDelete.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public DocumentDelete.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
DocumentDelete.Builder |
clearReadTime()
public DocumentDelete.Builder clearReadTime()
The read timestamp at which the delete was observed.
Greater or equal to the commit_time
of the delete.
.google.protobuf.Timestamp read_time = 4;
Type | Description |
DocumentDelete.Builder |
clearRemovedTargetIds()
public DocumentDelete.Builder clearRemovedTargetIds()
A set of target IDs for targets that previously matched this entity.
repeated int32 removed_target_ids = 6;
Type | Description |
DocumentDelete.Builder | This builder for chaining. |
clone()
public DocumentDelete.Builder clone()
Type | Description |
DocumentDelete.Builder |
getDefaultInstanceForType()
public DocumentDelete getDefaultInstanceForType()
Type | Description |
DocumentDelete |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getDocument()
public String getDocument()
The resource name of the Document that was deleted.
string document = 1;
Type | Description |
String | The document. |
getDocumentBytes()
public ByteString getDocumentBytes()
The resource name of the Document that was deleted.
string document = 1;
Type | Description |
ByteString | The bytes for document. |
getReadTime()
public Timestamp getReadTime()
The read timestamp at which the delete was observed.
Greater or equal to the commit_time
of the delete.
.google.protobuf.Timestamp read_time = 4;
Type | Description |
Timestamp | The readTime. |
getReadTimeBuilder()
public Timestamp.Builder getReadTimeBuilder()
The read timestamp at which the delete was observed.
Greater or equal to the commit_time
of the delete.
.google.protobuf.Timestamp read_time = 4;
Type | Description |
Builder |
getReadTimeOrBuilder()
public TimestampOrBuilder getReadTimeOrBuilder()
The read timestamp at which the delete was observed.
Greater or equal to the commit_time
of the delete.
.google.protobuf.Timestamp read_time = 4;
Type | Description |
TimestampOrBuilder |
getRemovedTargetIds(int index)
public int getRemovedTargetIds(int index)
A set of target IDs for targets that previously matched this entity.
repeated int32 removed_target_ids = 6;
Name | Description |
index | int The index of the element to return. |
Type | Description |
int | The removedTargetIds at the given index. |
getRemovedTargetIdsCount()
public int getRemovedTargetIdsCount()
A set of target IDs for targets that previously matched this entity.
repeated int32 removed_target_ids = 6;
Type | Description |
int | The count of removedTargetIds. |
getRemovedTargetIdsList()
public List<Integer> getRemovedTargetIdsList()
A set of target IDs for targets that previously matched this entity.
repeated int32 removed_target_ids = 6;
Type | Description |
List<Integer> | A list containing the removedTargetIds. |
hasReadTime()
public boolean hasReadTime()
The read timestamp at which the delete was observed.
Greater or equal to the commit_time
of the delete.
.google.protobuf.Timestamp read_time = 4;
Type | Description |
boolean | Whether the readTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(DocumentDelete other)
public DocumentDelete.Builder mergeFrom(DocumentDelete other)
Name | Description |
other | DocumentDelete |
Type | Description |
DocumentDelete.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DocumentDelete.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
DocumentDelete.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public DocumentDelete.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
DocumentDelete.Builder |
mergeReadTime(Timestamp value)
public DocumentDelete.Builder mergeReadTime(Timestamp value)
The read timestamp at which the delete was observed.
Greater or equal to the commit_time
of the delete.
.google.protobuf.Timestamp read_time = 4;
Name | Description |
value | Timestamp |
Type | Description |
DocumentDelete.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DocumentDelete.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
DocumentDelete.Builder |
setDocument(String value)
public DocumentDelete.Builder setDocument(String value)
The resource name of the Document that was deleted.
string document = 1;
Name | Description |
value | String The document to set. |
Type | Description |
DocumentDelete.Builder | This builder for chaining. |
setDocumentBytes(ByteString value)
public DocumentDelete.Builder setDocumentBytes(ByteString value)
The resource name of the Document that was deleted.
string document = 1;
Name | Description |
value | ByteString The bytes for document to set. |
Type | Description |
DocumentDelete.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public DocumentDelete.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
DocumentDelete.Builder |
setReadTime(Timestamp value)
public DocumentDelete.Builder setReadTime(Timestamp value)
The read timestamp at which the delete was observed.
Greater or equal to the commit_time
of the delete.
.google.protobuf.Timestamp read_time = 4;
Name | Description |
value | Timestamp |
Type | Description |
DocumentDelete.Builder |
setReadTime(Timestamp.Builder builderForValue)
public DocumentDelete.Builder setReadTime(Timestamp.Builder builderForValue)
The read timestamp at which the delete was observed.
Greater or equal to the commit_time
of the delete.
.google.protobuf.Timestamp read_time = 4;
Name | Description |
builderForValue | Builder |
Type | Description |
DocumentDelete.Builder |
setRemovedTargetIds(int index, int value)
public DocumentDelete.Builder setRemovedTargetIds(int index, int value)
A set of target IDs for targets that previously matched this entity.
repeated int32 removed_target_ids = 6;
Name | Description |
index | int The index to set the value at. |
value | int The removedTargetIds to set. |
Type | Description |
DocumentDelete.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DocumentDelete.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
DocumentDelete.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentDelete.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
DocumentDelete.Builder |