Class NamedQuery.Builder (3.1.0)

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > NamedQuery.Builder

Implements

NamedQueryOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public NamedQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
NamedQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public NamedQuery build()

Returns

Type	Description
NamedQuery

buildPartial()

public NamedQuery buildPartial()

Returns

Type	Description
NamedQuery

clear()

public NamedQuery.Builder clear()

Returns

Type	Description
NamedQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBundledQuery()

public NamedQuery.Builder clearBundledQuery()

The query saved in the bundle.

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

Returns

Type	Description
NamedQuery.Builder

clearField(Descriptors.FieldDescriptor field)

public NamedQuery.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
NamedQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Type	Description
NamedQuery.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NamedQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
NamedQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Type	Description
NamedQuery.Builder

clone()

public NamedQuery.Builder clone()

Returns

Type	Description
NamedQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBundledQuery()

public BundledQuery getBundledQuery()

The query saved in the bundle.

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

Returns

Type	Description
BundledQuery	The bundledQuery.

getBundledQueryBuilder()

public BundledQuery.Builder getBundledQueryBuilder()

The query saved in the bundle.

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

Returns

Type	Description
BundledQuery.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

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

Type	Description
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

Type	Description
TimestampOrBuilder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBundledQuery(BundledQuery value)

public NamedQuery.Builder mergeBundledQuery(BundledQuery value)

The query saved in the bundle.

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

Parameter

Name	Description
value	`BundledQuery`

Returns

Type	Description
NamedQuery.Builder

mergeFrom(NamedQuery other)

public NamedQuery.Builder mergeFrom(NamedQuery other)

Parameter

Name	Description
other	`NamedQuery`

Returns

Type	Description
NamedQuery.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NamedQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
NamedQuery.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public NamedQuery.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
NamedQuery.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Name	Description
value	`Timestamp`

Returns

Type	Description
NamedQuery.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NamedQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
NamedQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setBundledQuery(BundledQuery value)

public NamedQuery.Builder setBundledQuery(BundledQuery value)

The query saved in the bundle.

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

Parameter

Name	Description
value	`BundledQuery`

Returns

Type	Description
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

Name	Description
builderForValue	`BundledQuery.Builder`

Returns

Type	Description
NamedQuery.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public NamedQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
NamedQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
value	`String` The name to set.

Returns

Type	Description
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

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
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

Name	Description
value	`Timestamp`

Returns

Type	Description
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

Name	Description
builderForValue	`Builder`

Returns

Type	Description
NamedQuery.Builder

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
NamedQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final NamedQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
NamedQuery.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)