public static final class BundledDocumentMetadata.Builder extends GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder> implements BundledDocumentMetadataOrBuilderMetadata 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.BuilderImplements
BundledDocumentMetadataOrBuilderStatic 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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
getDefaultInstanceForType()
public BundledDocumentMetadata getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BundledDocumentMetadata |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
intThe 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 |
intThe 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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public BundledDocumentMetadata.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
BundledDocumentMetadata.Builder |
|
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 |
|
setExists(boolean value)
public BundledDocumentMetadata.Builder setExists(boolean value)Whether the document exists.
bool exists = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe 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 |
|
setName(String value)
public BundledDocumentMetadata.Builder setName(String value)The document key of a bundled document.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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 |
ByteStringThe 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 |
intThe index to set the value at. |
value |
StringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final BundledDocumentMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
BundledDocumentMetadata.Builder |
|