Class BundledDocumentMetadata.Builder (3.12.1)

Version 3.12.1

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class BundledDocumentMetadata.Builder extends GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder> implements BundledDocumentMetadataOrBuilder

Metadata describing a Firestore document saved in the bundle.

Protobuf type google.firestore.bundle.BundledDocumentMetadata

Inheritance

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

Implements

BundledDocumentMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

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)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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

addAllQueries(Iterable<String> values)

public BundledDocumentMetadata.Builder addAllQueries(Iterable<String> values)

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Parameter
Name	Description
values	Iterable<String> The queries to add.

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

addQueries(String value)

public BundledDocumentMetadata.Builder addQueries(String value)

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Parameter
Name	Description
value	String The queries to add.

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

addQueriesBytes(ByteString value)

public BundledDocumentMetadata.Builder addQueriesBytes(ByteString value)

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Parameter
Name	Description
value	ByteString The bytes of the queries to add.

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

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

build()

public BundledDocumentMetadata build()

Returns
Type	Description
BundledDocumentMetadata

buildPartial()

public BundledDocumentMetadata buildPartial()

Returns
Type	Description
BundledDocumentMetadata

clear()

public BundledDocumentMetadata.Builder clear()

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearExists()

public BundledDocumentMetadata.Builder clearExists()

Whether the document exists.

bool exists = 3;

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BundledDocumentMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

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

clearName()

public BundledDocumentMetadata.Builder clearName()

The document key of a bundled document.

string name = 1;

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BundledDocumentMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

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

clearQueries()

public BundledDocumentMetadata.Builder clearQueries()

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

clearReadTime()

public BundledDocumentMetadata.Builder clearReadTime()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
Type	Description
BundledDocumentMetadata.Builder

clone()

public BundledDocumentMetadata.Builder clone()

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public BundledDocumentMetadata getDefaultInstanceForType()

Returns
Type	Description
BundledDocumentMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getExists()

public boolean getExists()

Whether the document exists.

bool exists = 3;

Returns
Type	Description
boolean	The exists.

getName()

public String getName()

The document key of a bundled document.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The document key of a bundled document.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getQueries(int index)

public String getQueries(int index)

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The queries at the given index.

getQueriesBytes(int index)

public ByteString getQueriesBytes(int index)

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the queries at the given index.

getQueriesCount()

public int getQueriesCount()

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Returns
Type	Description
int	The count of queries.

getQueriesList()

public ProtocolStringList getQueriesList()

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Returns
Type	Description
ProtocolStringList	A list containing the queries.

getReadTime()

public Timestamp getReadTime()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
Type	Description
Timestamp	The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
Type	Description
Builder

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
Type	Description
TimestampOrBuilder

hasReadTime()

public boolean hasReadTime()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

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()

mergeFrom(BundledDocumentMetadata other)

public BundledDocumentMetadata.Builder mergeFrom(BundledDocumentMetadata other)

Parameter
Name	Description
other	BundledDocumentMetadata

Returns
Type	Description
BundledDocumentMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BundledDocumentMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

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

mergeReadTime(Timestamp value)

public BundledDocumentMetadata.Builder mergeReadTime(Timestamp value)

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
BundledDocumentMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BundledDocumentMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

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

setExists(boolean value)

public BundledDocumentMetadata.Builder setExists(boolean value)

Whether the document exists.

bool exists = 3;

Parameter
Name	Description
value	boolean The exists to set.

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

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

setName(String value)

public BundledDocumentMetadata.Builder setName(String value)

The document key of a bundled document.

string name = 1;

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

setNameBytes(ByteString value)

public BundledDocumentMetadata.Builder setNameBytes(ByteString value)

The document key of a bundled document.

string name = 1;

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

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

setQueries(int index, String value)

public BundledDocumentMetadata.Builder setQueries(int index, String value)

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Parameters
Name	Description
index	int The index to set the value at.
value	String The queries to set.

Returns
Type	Description
BundledDocumentMetadata.Builder	This builder for chaining.

setReadTime(Timestamp value)

public BundledDocumentMetadata.Builder setReadTime(Timestamp value)

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
BundledDocumentMetadata.Builder

setReadTime(Timestamp.Builder builderForValue)

public BundledDocumentMetadata.Builder setReadTime(Timestamp.Builder builderForValue)

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
BundledDocumentMetadata.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final BundledDocumentMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BundledDocumentMetadata.Builder

Overrides

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