public static final class Value.Builder extends GeneratedMessageV3.Builder<Value.Builder> implements ValueOrBuilderA message that can hold any of the supported value types.
Protobuf type google.firestore.v1.Value
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Value.BuilderImplements
ValueOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Value.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
build()
public Value build()| Returns | |
|---|---|
| Type | Description |
Value | |
buildPartial()
public Value buildPartial()| Returns | |
|---|---|
| Type | Description |
Value | |
clear()
public Value.Builder clear()| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
clearArrayValue()
public Value.Builder clearArrayValue()An array value. Cannot directly contain another array value, though can contain an map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
clearBooleanValue()
public Value.Builder clearBooleanValue()A boolean value.
bool boolean_value = 1;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
clearBytesValue()
public Value.Builder clearBytesValue()A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
bytes bytes_value = 18;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
clearDoubleValue()
public Value.Builder clearDoubleValue()A double value.
double double_value = 3;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Value.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
clearGeoPointValue()
public Value.Builder clearGeoPointValue()A geo point value representing a point on the surface of Earth.
.google.type.LatLng geo_point_value = 8;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
clearIntegerValue()
public Value.Builder clearIntegerValue()An integer value.
int64 integer_value = 2;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
clearMapValue()
public Value.Builder clearMapValue()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
clearNullValue()
public Value.Builder clearNullValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Value.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
clearReferenceValue()
public Value.Builder clearReferenceValue() A reference to a document. For example:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string reference_value = 5;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
clearStringValue()
public Value.Builder clearStringValue()A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
string string_value = 17;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
clearTimestampValue()
public Value.Builder clearTimestampValue()A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
.google.protobuf.Timestamp timestamp_value = 10;
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
clearValueType()
public Value.Builder clearValueType()| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
clone()
public Value.Builder clone()| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
getArrayValue()
public ArrayValue getArrayValue()An array value. Cannot directly contain another array value, though can contain an map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Returns | |
|---|---|
| Type | Description |
ArrayValue | The arrayValue. |
getArrayValueBuilder()
public ArrayValue.Builder getArrayValueBuilder()An array value. Cannot directly contain another array value, though can contain an map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Returns | |
|---|---|
| Type | Description |
ArrayValue.Builder | |
getArrayValueOrBuilder()
public ArrayValueOrBuilder getArrayValueOrBuilder()An array value. Cannot directly contain another array value, though can contain an map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Returns | |
|---|---|
| Type | Description |
ArrayValueOrBuilder | |
getBooleanValue()
public boolean getBooleanValue()A boolean value.
bool boolean_value = 1;
| Returns | |
|---|---|
| Type | Description |
boolean | The booleanValue. |
getBytesValue()
public ByteString getBytesValue()A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
bytes bytes_value = 18;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytesValue. |
getDefaultInstanceForType()
public Value getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Value | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDoubleValue()
public double getDoubleValue()A double value.
double double_value = 3;
| Returns | |
|---|---|
| Type | Description |
double | The doubleValue. |
getGeoPointValue()
public LatLng getGeoPointValue()A geo point value representing a point on the surface of Earth.
.google.type.LatLng geo_point_value = 8;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLng | The geoPointValue. |
getGeoPointValueBuilder()
public LatLng.Builder getGeoPointValueBuilder()A geo point value representing a point on the surface of Earth.
.google.type.LatLng geo_point_value = 8;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLng.Builder | |
getGeoPointValueOrBuilder()
public LatLngOrBuilder getGeoPointValueOrBuilder()A geo point value representing a point on the surface of Earth.
.google.type.LatLng geo_point_value = 8;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLngOrBuilder | |
getIntegerValue()
public long getIntegerValue()An integer value.
int64 integer_value = 2;
| Returns | |
|---|---|
| Type | Description |
long | The integerValue. |
getMapValue()
public MapValue getMapValue()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
MapValue | The mapValue. |
getMapValueBuilder()
public MapValue.Builder getMapValueBuilder()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
MapValue.Builder | |
getMapValueOrBuilder()
public MapValueOrBuilder getMapValueOrBuilder()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
MapValueOrBuilder | |
getNullValue()
public NullValue getNullValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
NullValue | The nullValue. |
getNullValueValue()
public int getNullValueValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for nullValue. |
getReferenceValue()
public String getReferenceValue() A reference to a document. For example:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string reference_value = 5;
| Returns | |
|---|---|
| Type | Description |
String | The referenceValue. |
getReferenceValueBytes()
public ByteString getReferenceValueBytes() A reference to a document. For example:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string reference_value = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for referenceValue. |
getStringValue()
public String getStringValue()A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
string string_value = 17;
| Returns | |
|---|---|
| Type | Description |
String | The stringValue. |
getStringValueBytes()
public ByteString getStringValueBytes()A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
string string_value = 17;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for stringValue. |
getTimestampValue()
public Timestamp getTimestampValue()A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
.google.protobuf.Timestamp timestamp_value = 10;
| Returns | |
|---|---|
| Type | Description |
Timestamp | The timestampValue. |
getTimestampValueBuilder()
public Timestamp.Builder getTimestampValueBuilder()A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
.google.protobuf.Timestamp timestamp_value = 10;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getTimestampValueOrBuilder()
public TimestampOrBuilder getTimestampValueOrBuilder()A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
.google.protobuf.Timestamp timestamp_value = 10;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getValueTypeCase()
public Value.ValueTypeCase getValueTypeCase()| Returns | |
|---|---|
| Type | Description |
Value.ValueTypeCase | |
hasArrayValue()
public boolean hasArrayValue()An array value. Cannot directly contain another array value, though can contain an map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the arrayValue field is set. |
hasBooleanValue()
public boolean hasBooleanValue()A boolean value.
bool boolean_value = 1;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the booleanValue field is set. |
hasBytesValue()
public boolean hasBytesValue()A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
bytes bytes_value = 18;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the bytesValue field is set. |
hasDoubleValue()
public boolean hasDoubleValue()A double value.
double double_value = 3;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the doubleValue field is set. |
hasGeoPointValue()
public boolean hasGeoPointValue()A geo point value representing a point on the surface of Earth.
.google.type.LatLng geo_point_value = 8;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the geoPointValue field is set. |
hasIntegerValue()
public boolean hasIntegerValue()An integer value.
int64 integer_value = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the integerValue field is set. |
hasMapValue()
public boolean hasMapValue()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the mapValue field is set. |
hasNullValue()
public boolean hasNullValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the nullValue field is set. |
hasReferenceValue()
public boolean hasReferenceValue() A reference to a document. For example:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string reference_value = 5;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the referenceValue field is set. |
hasStringValue()
public boolean hasStringValue()A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
string string_value = 17;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the stringValue field is set. |
hasTimestampValue()
public boolean hasTimestampValue()A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
.google.protobuf.Timestamp timestamp_value = 10;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the timestampValue field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeArrayValue(ArrayValue value)
public Value.Builder mergeArrayValue(ArrayValue value)An array value. Cannot directly contain another array value, though can contain an map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Parameter | |
|---|---|
| Name | Description |
value | ArrayValue |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
mergeFrom(Value other)
public Value.Builder mergeFrom(Value other)| Parameter | |
|---|---|
| Name | Description |
other | Value |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Value.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Value.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
mergeGeoPointValue(LatLng value)
public Value.Builder mergeGeoPointValue(LatLng value)A geo point value representing a point on the surface of Earth.
.google.type.LatLng geo_point_value = 8;
| Parameter | |
|---|---|
| Name | Description |
value | com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
mergeMapValue(MapValue value)
public Value.Builder mergeMapValue(MapValue value)A map value.
.google.firestore.v1.MapValue map_value = 6;
| Parameter | |
|---|---|
| Name | Description |
value | MapValue |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
mergeTimestampValue(Timestamp value)
public Value.Builder mergeTimestampValue(Timestamp value)A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
.google.protobuf.Timestamp timestamp_value = 10;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Value.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setArrayValue(ArrayValue value)
public Value.Builder setArrayValue(ArrayValue value)An array value. Cannot directly contain another array value, though can contain an map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Parameter | |
|---|---|
| Name | Description |
value | ArrayValue |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setArrayValue(ArrayValue.Builder builderForValue)
public Value.Builder setArrayValue(ArrayValue.Builder builderForValue)An array value. Cannot directly contain another array value, though can contain an map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ArrayValue.Builder |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setBooleanValue(boolean value)
public Value.Builder setBooleanValue(boolean value)A boolean value.
bool boolean_value = 1;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe booleanValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setBytesValue(ByteString value)
public Value.Builder setBytesValue(ByteString value)A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
bytes bytes_value = 18;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytesValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setDoubleValue(double value)
public Value.Builder setDoubleValue(double value)A double value.
double double_value = 3;
| Parameter | |
|---|---|
| Name | Description |
value | doubleThe doubleValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Value.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setGeoPointValue(LatLng value)
public Value.Builder setGeoPointValue(LatLng value)A geo point value representing a point on the surface of Earth.
.google.type.LatLng geo_point_value = 8;
| Parameter | |
|---|---|
| Name | Description |
value | com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setGeoPointValue(LatLng.Builder builderForValue)
public Value.Builder setGeoPointValue(LatLng.Builder builderForValue)A geo point value representing a point on the surface of Earth.
.google.type.LatLng geo_point_value = 8;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | com.google.type.LatLng.Builder |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setIntegerValue(long value)
public Value.Builder setIntegerValue(long value)An integer value.
int64 integer_value = 2;
| Parameter | |
|---|---|
| Name | Description |
value | longThe integerValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setMapValue(MapValue value)
public Value.Builder setMapValue(MapValue value)A map value.
.google.firestore.v1.MapValue map_value = 6;
| Parameter | |
|---|---|
| Name | Description |
value | MapValue |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setMapValue(MapValue.Builder builderForValue)
public Value.Builder setMapValue(MapValue.Builder builderForValue)A map value.
.google.firestore.v1.MapValue map_value = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | MapValue.Builder |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setNullValue(NullValue value)
public Value.Builder setNullValue(NullValue value)A null value.
.google.protobuf.NullValue null_value = 11;
| Parameter | |
|---|---|
| Name | Description |
value | NullValueThe nullValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setNullValueValue(int value)
public Value.Builder setNullValueValue(int value)A null value.
.google.protobuf.NullValue null_value = 11;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for nullValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setReferenceValue(String value)
public Value.Builder setReferenceValue(String value) A reference to a document. For example:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string reference_value = 5;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe referenceValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setReferenceValueBytes(ByteString value)
public Value.Builder setReferenceValueBytes(ByteString value) A reference to a document. For example:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
string reference_value = 5;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for referenceValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Value.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setStringValue(String value)
public Value.Builder setStringValue(String value)A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
string string_value = 17;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe stringValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setStringValueBytes(ByteString value)
public Value.Builder setStringValueBytes(ByteString value)A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
string string_value = 17;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for stringValue to set. |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | This builder for chaining. |
setTimestampValue(Timestamp value)
public Value.Builder setTimestampValue(Timestamp value)A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
.google.protobuf.Timestamp timestamp_value = 10;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setTimestampValue(Timestamp.Builder builderForValue)
public Value.Builder setTimestampValue(Timestamp.Builder builderForValue)A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
.google.protobuf.Timestamp timestamp_value = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Value.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Value.Builder | |