Package com.google.firestore.bundle

Class NamedQuery

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.bundle.NamedQuery
All Implemented Interfaces:
NamedQueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class NamedQuery extends com.google.protobuf.GeneratedMessageV3 implements NamedQueryOrBuilder
 A Query associated with a name, created as part of the bundle file, and can be read
 by client SDKs once the bundle containing them is loaded.
Protobuf type google.firestore.bundle.NamedQuery
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    NamedQuery.Builder
    A Query associated with a name, created as part of the bundle file, and can be read by client SDKs once the bundle containing them is loaded.

    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
    BUNDLED_QUERY_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    READ_TIME_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)
     
    BundledQuery
    getBundledQuery()
    The query saved in the bundle.
    BundledQueryOrBuilder
    getBundledQueryOrBuilder()
    The query saved in the bundle.
    static NamedQuery
    getDefaultInstance()
     
    NamedQuery
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    Name of the query, such that client can use the name to load this query from bundle, and resume from when the query results are materialized into this bundle.
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the query, such that client can use the name to load this query from bundle, and resume from when the query results are materialized into this bundle.
    com.google.protobuf.Parser<NamedQuery>
    getParserForType()
     
    com.google.protobuf.Timestamp
    getReadTime()
    The read time of the query, when it is used to build the bundle.
    com.google.protobuf.TimestampOrBuilder
    getReadTimeOrBuilder()
    The read time of the query, when it is used to build the bundle.
    int
    getSerializedSize()
     
    boolean
    hasBundledQuery()
    The query saved in the bundle.
    int
    hashCode()
     
    boolean
    hasReadTime()
    The read time of the query, when it is used to build the bundle.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static NamedQuery.Builder
    newBuilder()
     
    static NamedQuery.Builder
    newBuilder(NamedQuery prototype)
     
    NamedQuery.Builder
    newBuilderForType()
     
    protected NamedQuery.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static NamedQuery
    parseDelimitedFrom(InputStream input)
     
    static NamedQuery
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedQuery
    parseFrom(byte[] data)
     
    static NamedQuery
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedQuery
    parseFrom(com.google.protobuf.ByteString data)
     
    static NamedQuery
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedQuery
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static NamedQuery
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedQuery
    parseFrom(InputStream input)
     
    static NamedQuery
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedQuery
    parseFrom(ByteBuffer data)
     
    static NamedQuery
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<NamedQuery>
    parser()
     
    NamedQuery.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

  • 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

    • getName

      public String getName()
       Name of the query, such that client can use the name to load this query
 from bundle, and resume from when the query results are materialized
 into this bundle.
      string name = 1;
      Specified by:
      getName in interface NamedQueryOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name of the query, such that client can use the name to load this query
 from bundle, and resume from when the query results are materialized
 into this bundle.
      string name = 1;
      Specified by:
      getNameBytes in interface NamedQueryOrBuilder
      Returns:
      The bytes for name.

    • hasBundledQuery

      public boolean hasBundledQuery()
       The query saved in the bundle.
      .google.firestore.bundle.BundledQuery bundled_query = 2;
      Specified by:
      hasBundledQuery in interface NamedQueryOrBuilder
      Returns:
      Whether the bundledQuery field is set.

    • getBundledQuery

      public BundledQuery getBundledQuery()
       The query saved in the bundle.
      .google.firestore.bundle.BundledQuery bundled_query = 2;
      Specified by:
      getBundledQuery in interface NamedQueryOrBuilder
      Returns:
      The bundledQuery.

    • getBundledQueryOrBuilder

      public BundledQueryOrBuilder getBundledQueryOrBuilder()
       The query saved in the bundle.
      .google.firestore.bundle.BundledQuery bundled_query = 2;
      Specified by:
      getBundledQueryOrBuilder in interface NamedQueryOrBuilder

    • hasReadTime

      public boolean hasReadTime()
       The read time of the query, when it is used to build the bundle. This is useful to
 resume the query from the bundle, once it is loaded by client SDKs.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      hasReadTime in interface NamedQueryOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       The read time of the query, when it is used to build the bundle. This is useful to
 resume the query from the bundle, once it is loaded by client SDKs.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      getReadTime in interface NamedQueryOrBuilder
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       The read time of the query, when it is used to build the bundle. This is useful to
 resume the query from the bundle, once it is loaded by client SDKs.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      getReadTimeOrBuilder in interface NamedQueryOrBuilder

    • 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 NamedQuery parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static NamedQuery.Builder newBuilder()

    • newBuilder

      public static NamedQuery.Builder newBuilder(NamedQuery prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static NamedQuery getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<NamedQuery> 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 NamedQuery getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder