Class DocumentDelete.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DocumentDelete.Builder>
com.google.firestore.v1.DocumentDelete.Builder
All Implemented Interfaces:
DocumentDeleteOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DocumentDelete

public static final class DocumentDelete.Builder extends com.google.protobuf.GeneratedMessage.Builder<DocumentDelete.Builder> implements DocumentDeleteOrBuilder
 A [Document][google.firestore.v1.Document] has been deleted.

 May be the result of multiple [writes][google.firestore.v1.Write], including
 updates, the last of which deleted the
 [Document][google.firestore.v1.Document].

 Multiple [DocumentDelete][google.firestore.v1.DocumentDelete] messages may be
 returned for the same logical delete, if multiple targets are affected.
 
Protobuf type google.firestore.v1.DocumentDelete
  • Method Summary

    Modifier and Type
    Method
    Description
    A set of target IDs for targets that previously matched this entity.
    A set of target IDs for targets that previously matched this entity.
     
     
     
    The resource name of the [Document][google.firestore.v1.Document] that was deleted.
    The read timestamp at which the delete was observed.
    A set of target IDs for targets that previously matched this entity.
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Descriptors.Descriptor
     
    The resource name of the [Document][google.firestore.v1.Document] that was deleted.
    com.google.protobuf.ByteString
    The resource name of the [Document][google.firestore.v1.Document] that was deleted.
    com.google.protobuf.Timestamp
    The read timestamp at which the delete was observed.
    com.google.protobuf.Timestamp.Builder
    The read timestamp at which the delete was observed.
    com.google.protobuf.TimestampOrBuilder
    The read timestamp at which the delete was observed.
    int
    A set of target IDs for targets that previously matched this entity.
    int
    A set of target IDs for targets that previously matched this entity.
    A set of target IDs for targets that previously matched this entity.
    boolean
    The read timestamp at which the delete was observed.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    mergeFrom(com.google.protobuf.Message other)
     
    mergeReadTime(com.google.protobuf.Timestamp value)
    The read timestamp at which the delete was observed.
    The resource name of the [Document][google.firestore.v1.Document] that was deleted.
    setDocumentBytes(com.google.protobuf.ByteString value)
    The resource name of the [Document][google.firestore.v1.Document] that was deleted.
    setReadTime(com.google.protobuf.Timestamp value)
    The read timestamp at which the delete was observed.
    setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
    The read timestamp at which the delete was observed.
    setRemovedTargetIds(int index, int value)
    A set of target IDs for targets that previously matched this entity.

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

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

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

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<DocumentDelete.Builder>
    • clear

      public DocumentDelete.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.GeneratedMessage.Builder<DocumentDelete.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.GeneratedMessage.Builder<DocumentDelete.Builder>
    • getDefaultInstanceForType

      public DocumentDelete getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public DocumentDelete build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public DocumentDelete buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public DocumentDelete.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<DocumentDelete.Builder>
    • mergeFrom

      public DocumentDelete.Builder mergeFrom(DocumentDelete other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<DocumentDelete.Builder>
    • mergeFrom

      public DocumentDelete.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<DocumentDelete.Builder>
      Throws:
      IOException
    • getDocument

      public String getDocument()
       The resource name of the [Document][google.firestore.v1.Document] that was
       deleted.
       
      string document = 1;
      Specified by:
      getDocument in interface DocumentDeleteOrBuilder
      Returns:
      The document.
    • getDocumentBytes

      public com.google.protobuf.ByteString getDocumentBytes()
       The resource name of the [Document][google.firestore.v1.Document] that was
       deleted.
       
      string document = 1;
      Specified by:
      getDocumentBytes in interface DocumentDeleteOrBuilder
      Returns:
      The bytes for document.
    • setDocument

      public DocumentDelete.Builder setDocument(String value)
       The resource name of the [Document][google.firestore.v1.Document] that was
       deleted.
       
      string document = 1;
      Parameters:
      value - The document to set.
      Returns:
      This builder for chaining.
    • clearDocument

      public DocumentDelete.Builder clearDocument()
       The resource name of the [Document][google.firestore.v1.Document] that was
       deleted.
       
      string document = 1;
      Returns:
      This builder for chaining.
    • setDocumentBytes

      public DocumentDelete.Builder setDocumentBytes(com.google.protobuf.ByteString value)
       The resource name of the [Document][google.firestore.v1.Document] that was
       deleted.
       
      string document = 1;
      Parameters:
      value - The bytes for document to set.
      Returns:
      This builder for chaining.
    • getRemovedTargetIdsList

      public List<Integer> getRemovedTargetIdsList()
       A set of target IDs for targets that previously matched this entity.
       
      repeated int32 removed_target_ids = 6;
      Specified by:
      getRemovedTargetIdsList in interface DocumentDeleteOrBuilder
      Returns:
      A list containing the removedTargetIds.
    • getRemovedTargetIdsCount

      public int getRemovedTargetIdsCount()
       A set of target IDs for targets that previously matched this entity.
       
      repeated int32 removed_target_ids = 6;
      Specified by:
      getRemovedTargetIdsCount in interface DocumentDeleteOrBuilder
      Returns:
      The count of removedTargetIds.
    • getRemovedTargetIds

      public int getRemovedTargetIds(int index)
       A set of target IDs for targets that previously matched this entity.
       
      repeated int32 removed_target_ids = 6;
      Specified by:
      getRemovedTargetIds in interface DocumentDeleteOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The removedTargetIds at the given index.
    • setRemovedTargetIds

      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;
      Parameters:
      index - The index to set the value at.
      value - The removedTargetIds to set.
      Returns:
      This builder for chaining.
    • addRemovedTargetIds

      public DocumentDelete.Builder addRemovedTargetIds(int value)
       A set of target IDs for targets that previously matched this entity.
       
      repeated int32 removed_target_ids = 6;
      Parameters:
      value - The removedTargetIds to add.
      Returns:
      This builder for chaining.
    • addAllRemovedTargetIds

      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;
      Parameters:
      values - The removedTargetIds to add.
      Returns:
      This builder for chaining.
    • clearRemovedTargetIds

      public DocumentDelete.Builder clearRemovedTargetIds()
       A set of target IDs for targets that previously matched this entity.
       
      repeated int32 removed_target_ids = 6;
      Returns:
      This builder for chaining.
    • 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;
      Specified by:
      hasReadTime in interface DocumentDeleteOrBuilder
      Returns:
      Whether the readTime field is set.
    • getReadTime

      public com.google.protobuf.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;
      Specified by:
      getReadTime in interface DocumentDeleteOrBuilder
      Returns:
      The readTime.
    • setReadTime

      public DocumentDelete.Builder setReadTime(com.google.protobuf.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;
    • setReadTime

      public DocumentDelete.Builder setReadTime(com.google.protobuf.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;
    • mergeReadTime

      public DocumentDelete.Builder mergeReadTime(com.google.protobuf.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;
    • 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;
    • getReadTimeBuilder

      public com.google.protobuf.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;
    • getReadTimeOrBuilder

      public com.google.protobuf.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;
      Specified by:
      getReadTimeOrBuilder in interface DocumentDeleteOrBuilder