Class BundledDocumentMetadata.Builder (3.5.0)

Stay organized with collections Save and categorize content based on your preferences.
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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The queries to add.

Returns
TypeDescription
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
NameDescription
valueString

The queries to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the queries to add.

Returns
TypeDescription
BundledDocumentMetadata.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public BundledDocumentMetadata build()
Returns
TypeDescription
BundledDocumentMetadata

buildPartial()

public BundledDocumentMetadata buildPartial()
Returns
TypeDescription
BundledDocumentMetadata

clear()

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

clearExists()

public BundledDocumentMetadata.Builder clearExists()

Whether the document exists.

bool exists = 3;

Returns
TypeDescription
BundledDocumentMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public BundledDocumentMetadata.Builder clearName()

The document key of a bundled document.

string name = 1;

Returns
TypeDescription
BundledDocumentMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQueries()

public BundledDocumentMetadata.Builder clearQueries()

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

repeated string queries = 4;

Returns
TypeDescription
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
TypeDescription
BundledDocumentMetadata.Builder

clone()

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

getDefaultInstanceForType()

public BundledDocumentMetadata getDefaultInstanceForType()
Returns
TypeDescription
BundledDocumentMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getExists()

public boolean getExists()

Whether the document exists.

bool exists = 3;

Returns
TypeDescription
boolean

The exists.

getName()

public String getName()

The document key of a bundled document.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The document key of a bundled document.

string name = 1;

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
Timestamp

The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
TypeDescription
Builder

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
TypeDescription
TimestampOrBuilder

hasReadTime()

public boolean hasReadTime()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

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

mergeFrom(BundledDocumentMetadata other)

public BundledDocumentMetadata.Builder mergeFrom(BundledDocumentMetadata other)
Parameter
NameDescription
otherBundledDocumentMetadata
Returns
TypeDescription
BundledDocumentMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeReadTime(Timestamp value)

public BundledDocumentMetadata.Builder mergeReadTime(Timestamp value)

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BundledDocumentMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setExists(boolean value)

public BundledDocumentMetadata.Builder setExists(boolean value)

Whether the document exists.

bool exists = 3;

Parameter
NameDescription
valueboolean

The exists to set.

Returns
TypeDescription
BundledDocumentMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public BundledDocumentMetadata.Builder setName(String value)

The document key of a bundled document.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The queries to set.

Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
BundledDocumentMetadata.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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