Class NamedQuery

public final class NamedQuery extends 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

Implements

NamedQueryOrBuilder

Fields

BUNDLED_QUERY_FIELD_NUMBER

public static final int BUNDLED_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBundledQuery()

public BundledQuery getBundledQuery()

The query saved in the bundle.

.google.firestore.bundle.BundledQuery bundled_query = 2;

Returns
TypeDescription
BundledQuery

The bundledQuery.

getBundledQueryOrBuilder()

public BundledQueryOrBuilder getBundledQueryOrBuilder()

The query saved in the bundle.

.google.firestore.bundle.BundledQuery bundled_query = 2;

Returns
TypeDescription
BundledQueryOrBuilder

getDefaultInstance()

public static NamedQuery getDefaultInstance()
Returns
TypeDescription
NamedQuery

getDefaultInstanceForType()

public NamedQuery getDefaultInstanceForType()
Returns
TypeDescription
NamedQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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;

Returns
TypeDescription
String

The name.

getNameBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<NamedQuery> getParserForType()
Returns
TypeDescription
Parser<NamedQuery>
Overrides

getReadTime()

public 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;

Returns
TypeDescription
Timestamp

The readTime.

getReadTimeOrBuilder()

public 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;

Returns
TypeDescription
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasBundledQuery()

public boolean hasBundledQuery()

The query saved in the bundle.

.google.firestore.bundle.BundledQuery bundled_query = 2;

Returns
TypeDescription
boolean

Whether the bundledQuery field is set.

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;

Returns
TypeDescription
boolean

Whether the readTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static NamedQuery.Builder newBuilder()
Returns
TypeDescription
NamedQuery.Builder

newBuilder(NamedQuery prototype)

public static NamedQuery.Builder newBuilder(NamedQuery prototype)
Parameter
NameDescription
prototypeNamedQuery
Returns
TypeDescription
NamedQuery.Builder

newBuilderForType()

public NamedQuery.Builder newBuilderForType()
Returns
TypeDescription
NamedQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NamedQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
NamedQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static NamedQuery parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NamedQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static NamedQuery parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NamedQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NamedQuery parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NamedQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NamedQuery parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NamedQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static NamedQuery parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NamedQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static NamedQuery parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NamedQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NamedQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<NamedQuery> parser()
Returns
TypeDescription
Parser<NamedQuery>

toBuilder()

public NamedQuery.Builder toBuilder()
Returns
TypeDescription
NamedQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException