public final class NamedQuery extends GeneratedMessageV3 implements NamedQueryOrBuilderA 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NamedQueryImplements
NamedQueryOrBuilderStatic Fields
BUNDLED_QUERY_FIELD_NUMBER
public static final int BUNDLED_QUERY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static NamedQuery getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static NamedQuery.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
NamedQuery.Builder |
|
newBuilder(NamedQuery prototype)
public static NamedQuery.Builder newBuilder(NamedQuery prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
NamedQuery |
| Returns | |
|---|---|
| Type | Description |
NamedQuery.Builder |
|
parseDelimitedFrom(InputStream input)
public static NamedQuery parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NamedQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static NamedQuery parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NamedQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static NamedQuery parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NamedQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static NamedQuery parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NamedQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static NamedQuery parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NamedQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static NamedQuery parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NamedQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<NamedQuery> parser()| Returns | |
|---|---|
| Type | Description |
Parser<NamedQuery> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBundledQuery()
public BundledQuery getBundledQuery()The query saved in the bundle.
.google.firestore.bundle.BundledQuery bundled_query = 2;
| Returns | |
|---|---|
| Type | Description |
BundledQuery |
The bundledQuery. |
getBundledQueryOrBuilder()
public BundledQueryOrBuilder getBundledQueryOrBuilder()The query saved in the bundle.
.google.firestore.bundle.BundledQuery bundled_query = 2;
| Returns | |
|---|---|
| Type | Description |
BundledQueryOrBuilder |
|
getDefaultInstanceForType()
public NamedQuery getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
NamedQuery |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<NamedQuery> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<NamedQuery> |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hasBundledQuery()
public boolean hasBundledQuery()The query saved in the bundle.
.google.firestore.bundle.BundledQuery bundled_query = 2;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the readTime field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public NamedQuery.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
NamedQuery.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NamedQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
NamedQuery.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public NamedQuery.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
NamedQuery.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|