Class NamedQuery.Builder (3.16.3)

public static final class NamedQuery.Builder extends GeneratedMessageV3.Builder<NamedQuery.Builder> 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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public NamedQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
NamedQuery.Builder
Overrides

build()

public NamedQuery build()
Returns
TypeDescription
NamedQuery

buildPartial()

public NamedQuery buildPartial()
Returns
TypeDescription
NamedQuery

clear()

public NamedQuery.Builder clear()
Returns
TypeDescription
NamedQuery.Builder
Overrides

clearBundledQuery()

public NamedQuery.Builder clearBundledQuery()

The query saved in the bundle.

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

Returns
TypeDescription
NamedQuery.Builder

clearField(Descriptors.FieldDescriptor field)

public NamedQuery.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
NamedQuery.Builder
Overrides

clearName()

public NamedQuery.Builder clearName()

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
NamedQuery.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NamedQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
NamedQuery.Builder
Overrides

clearReadTime()

public NamedQuery.Builder clearReadTime()

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
NamedQuery.Builder

clone()

public NamedQuery.Builder clone()
Returns
TypeDescription
NamedQuery.Builder
Overrides

getBundledQuery()

public BundledQuery getBundledQuery()

The query saved in the bundle.

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

Returns
TypeDescription
BundledQuery

The bundledQuery.

getBundledQueryBuilder()

public BundledQuery.Builder getBundledQueryBuilder()

The query saved in the bundle.

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

Returns
TypeDescription
BundledQuery.Builder

getBundledQueryOrBuilder()

public BundledQueryOrBuilder getBundledQueryOrBuilder()

The query saved in the bundle.

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

Returns
TypeDescription
BundledQueryOrBuilder

getDefaultInstanceForType()

public NamedQuery getDefaultInstanceForType()
Returns
TypeDescription
NamedQuery

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

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
Builder

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBundledQuery(BundledQuery value)

public NamedQuery.Builder mergeBundledQuery(BundledQuery value)

The query saved in the bundle.

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

Parameter
NameDescription
valueBundledQuery
Returns
TypeDescription
NamedQuery.Builder

mergeFrom(NamedQuery other)

public NamedQuery.Builder mergeFrom(NamedQuery other)
Parameter
NameDescription
otherNamedQuery
Returns
TypeDescription
NamedQuery.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NamedQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NamedQuery.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public NamedQuery.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
NamedQuery.Builder
Overrides

mergeReadTime(Timestamp value)

public NamedQuery.Builder mergeReadTime(Timestamp value)

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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
NamedQuery.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NamedQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
NamedQuery.Builder
Overrides

setBundledQuery(BundledQuery value)

public NamedQuery.Builder setBundledQuery(BundledQuery value)

The query saved in the bundle.

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

Parameter
NameDescription
valueBundledQuery
Returns
TypeDescription
NamedQuery.Builder

setBundledQuery(BundledQuery.Builder builderForValue)

public NamedQuery.Builder setBundledQuery(BundledQuery.Builder builderForValue)

The query saved in the bundle.

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

Parameter
NameDescription
builderForValueBundledQuery.Builder
Returns
TypeDescription
NamedQuery.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public NamedQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
NamedQuery.Builder
Overrides

setName(String value)

public NamedQuery.Builder setName(String value)

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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
NamedQuery.Builder

This builder for chaining.

setNameBytes(ByteString value)

public NamedQuery.Builder setNameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
NamedQuery.Builder

This builder for chaining.

setReadTime(Timestamp value)

public NamedQuery.Builder setReadTime(Timestamp value)

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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
NamedQuery.Builder

setReadTime(Timestamp.Builder builderForValue)

public NamedQuery.Builder setReadTime(Timestamp.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
NamedQuery.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public NamedQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
NamedQuery.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final NamedQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
NamedQuery.Builder
Overrides