Package com.google.firestore.bundle

Class BundleElement

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.bundle.BundleElement
All Implemented Interfaces:
BundleElementOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class BundleElement extends com.google.protobuf.GeneratedMessageV3 implements BundleElementOrBuilder
 A Firestore bundle is a length-prefixed stream of JSON representations of
 `BundleElement`.
 Only one `BundleMetadata` is expected, and it should be the first element.
 The named queries follow after `metadata`. Every `document_metadata` is
 immediately followed by a `document`.
Protobuf type google.firestore.bundle.BundleElement
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BundleElement.Builder
    A Firestore bundle is a length-prefixed stream of JSON representations of `BundleElement`.
    static enum 
    BundleElement.ElementTypeCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DOCUMENT_FIELD_NUMBER
     
    static final int
    DOCUMENT_METADATA_FIELD_NUMBER
     
    static final int
    METADATA_FIELD_NUMBER
     
    static final int
    NAMED_QUERY_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static BundleElement
    getDefaultInstance()
     
    BundleElement
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Document
    getDocument()
    .google.firestore.v1.Document document = 4;
    BundledDocumentMetadata
    getDocumentMetadata()
    .google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
    BundledDocumentMetadataOrBuilder
    getDocumentMetadataOrBuilder()
    .google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
    DocumentOrBuilder
    getDocumentOrBuilder()
    .google.firestore.v1.Document document = 4;
    BundleElement.ElementTypeCase
    getElementTypeCase()
     
    BundleMetadata
    getMetadata()
    .google.firestore.bundle.BundleMetadata metadata = 1;
    BundleMetadataOrBuilder
    getMetadataOrBuilder()
    .google.firestore.bundle.BundleMetadata metadata = 1;
    NamedQuery
    getNamedQuery()
    .google.firestore.bundle.NamedQuery named_query = 2;
    NamedQueryOrBuilder
    getNamedQueryOrBuilder()
    .google.firestore.bundle.NamedQuery named_query = 2;
    com.google.protobuf.Parser<BundleElement>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasDocument()
    .google.firestore.v1.Document document = 4;
    boolean
    hasDocumentMetadata()
    .google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
    int
    hashCode()
     
    boolean
    hasMetadata()
    .google.firestore.bundle.BundleMetadata metadata = 1;
    boolean
    hasNamedQuery()
    .google.firestore.bundle.NamedQuery named_query = 2;
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BundleElement.Builder
    newBuilder()
     
    static BundleElement.Builder
    newBuilder(BundleElement prototype)
     
    BundleElement.Builder
    newBuilderForType()
     
    protected BundleElement.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static BundleElement
    parseDelimitedFrom(InputStream input)
     
    static BundleElement
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BundleElement
    parseFrom(byte[] data)
     
    static BundleElement
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BundleElement
    parseFrom(com.google.protobuf.ByteString data)
     
    static BundleElement
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BundleElement
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BundleElement
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BundleElement
    parseFrom(InputStream input)
     
    static BundleElement
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BundleElement
    parseFrom(ByteBuffer data)
     
    static BundleElement
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BundleElement>
    parser()
     
    BundleElement.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • NAMED_QUERY_FIELD_NUMBER

      public static final int NAMED_QUERY_FIELD_NUMBER
      See Also:

    • DOCUMENT_METADATA_FIELD_NUMBER

      public static final int DOCUMENT_METADATA_FIELD_NUMBER
      See Also:

    • DOCUMENT_FIELD_NUMBER

      public static final int DOCUMENT_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • getElementTypeCase

      public BundleElement.ElementTypeCase getElementTypeCase()
      Specified by:
      getElementTypeCase in interface BundleElementOrBuilder

    • hasMetadata

      public boolean hasMetadata()
      .google.firestore.bundle.BundleMetadata metadata = 1;
      Specified by:
      hasMetadata in interface BundleElementOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public BundleMetadata getMetadata()
      .google.firestore.bundle.BundleMetadata metadata = 1;
      Specified by:
      getMetadata in interface BundleElementOrBuilder
      Returns:
      The metadata.

    • getMetadataOrBuilder

      public BundleMetadataOrBuilder getMetadataOrBuilder()
      .google.firestore.bundle.BundleMetadata metadata = 1;
      Specified by:
      getMetadataOrBuilder in interface BundleElementOrBuilder

    • hasNamedQuery

      public boolean hasNamedQuery()
      .google.firestore.bundle.NamedQuery named_query = 2;
      Specified by:
      hasNamedQuery in interface BundleElementOrBuilder
      Returns:
      Whether the namedQuery field is set.

    • getNamedQuery

      public NamedQuery getNamedQuery()
      .google.firestore.bundle.NamedQuery named_query = 2;
      Specified by:
      getNamedQuery in interface BundleElementOrBuilder
      Returns:
      The namedQuery.

    • getNamedQueryOrBuilder

      public NamedQueryOrBuilder getNamedQueryOrBuilder()
      .google.firestore.bundle.NamedQuery named_query = 2;
      Specified by:
      getNamedQueryOrBuilder in interface BundleElementOrBuilder

    • hasDocumentMetadata

      public boolean hasDocumentMetadata()
      .google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
      Specified by:
      hasDocumentMetadata in interface BundleElementOrBuilder
      Returns:
      Whether the documentMetadata field is set.

    • getDocumentMetadata

      public BundledDocumentMetadata getDocumentMetadata()
      .google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
      Specified by:
      getDocumentMetadata in interface BundleElementOrBuilder
      Returns:
      The documentMetadata.

    • getDocumentMetadataOrBuilder

      public BundledDocumentMetadataOrBuilder getDocumentMetadataOrBuilder()
      .google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
      Specified by:
      getDocumentMetadataOrBuilder in interface BundleElementOrBuilder

    • hasDocument

      public boolean hasDocument()
      .google.firestore.v1.Document document = 4;
      Specified by:
      hasDocument in interface BundleElementOrBuilder
      Returns:
      Whether the document field is set.

    • getDocument

      public Document getDocument()
      .google.firestore.v1.Document document = 4;
      Specified by:
      getDocument in interface BundleElementOrBuilder
      Returns:
      The document.

    • getDocumentOrBuilder

      public DocumentOrBuilder getDocumentOrBuilder()
      .google.firestore.v1.Document document = 4;
      Specified by:
      getDocumentOrBuilder in interface BundleElementOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static BundleElement parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BundleElement parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BundleElement parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BundleElement parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BundleElement parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BundleElement parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BundleElement parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BundleElement parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BundleElement parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BundleElement parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BundleElement parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BundleElement parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public BundleElement.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static BundleElement.Builder newBuilder()

    • newBuilder

      public static BundleElement.Builder newBuilder(BundleElement prototype)

    • toBuilder

      public BundleElement.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected BundleElement.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static BundleElement getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BundleElement> parser()

    • getParserForType

      public com.google.protobuf.Parser<BundleElement> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public BundleElement getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder