Package com.google.firestore.v1

Class Value

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.Value
All Implemented Interfaces:
ValueOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Value extends com.google.protobuf.GeneratedMessageV3 implements ValueOrBuilder
 A message that can hold any of the supported value types.
Protobuf type google.firestore.v1.Value
See Also:

  • Field Details

    • NULL_VALUE_FIELD_NUMBER

      public static final int NULL_VALUE_FIELD_NUMBER
      See Also:

    • BOOLEAN_VALUE_FIELD_NUMBER

      public static final int BOOLEAN_VALUE_FIELD_NUMBER
      See Also:

    • INTEGER_VALUE_FIELD_NUMBER

      public static final int INTEGER_VALUE_FIELD_NUMBER
      See Also:

    • DOUBLE_VALUE_FIELD_NUMBER

      public static final int DOUBLE_VALUE_FIELD_NUMBER
      See Also:

    • TIMESTAMP_VALUE_FIELD_NUMBER

      public static final int TIMESTAMP_VALUE_FIELD_NUMBER
      See Also:

    • STRING_VALUE_FIELD_NUMBER

      public static final int STRING_VALUE_FIELD_NUMBER
      See Also:

    • BYTES_VALUE_FIELD_NUMBER

      public static final int BYTES_VALUE_FIELD_NUMBER
      See Also:

    • REFERENCE_VALUE_FIELD_NUMBER

      public static final int REFERENCE_VALUE_FIELD_NUMBER
      See Also:

    • GEO_POINT_VALUE_FIELD_NUMBER

      public static final int GEO_POINT_VALUE_FIELD_NUMBER
      See Also:

    • ARRAY_VALUE_FIELD_NUMBER

      public static final int ARRAY_VALUE_FIELD_NUMBER
      See Also:

    • MAP_VALUE_FIELD_NUMBER

      public static final int MAP_VALUE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getValueTypeCase

      public Value.ValueTypeCase getValueTypeCase()
      Specified by:
      getValueTypeCase in interface ValueOrBuilder

    • hasNullValue

      public boolean hasNullValue()
       A null value.
      .google.protobuf.NullValue null_value = 11;
      Specified by:
      hasNullValue in interface ValueOrBuilder
      Returns:
      Whether the nullValue field is set.

    • getNullValueValue

      public int getNullValueValue()
       A null value.
      .google.protobuf.NullValue null_value = 11;
      Specified by:
      getNullValueValue in interface ValueOrBuilder
      Returns:
      The enum numeric value on the wire for nullValue.

    • getNullValue

      public com.google.protobuf.NullValue getNullValue()
       A null value.
      .google.protobuf.NullValue null_value = 11;
      Specified by:
      getNullValue in interface ValueOrBuilder
      Returns:
      The nullValue.

    • hasBooleanValue

      public boolean hasBooleanValue()
       A boolean value.
      bool boolean_value = 1;
      Specified by:
      hasBooleanValue in interface ValueOrBuilder
      Returns:
      Whether the booleanValue field is set.

    • getBooleanValue

      public boolean getBooleanValue()
       A boolean value.
      bool boolean_value = 1;
      Specified by:
      getBooleanValue in interface ValueOrBuilder
      Returns:
      The booleanValue.

    • hasIntegerValue

      public boolean hasIntegerValue()
       An integer value.
      int64 integer_value = 2;
      Specified by:
      hasIntegerValue in interface ValueOrBuilder
      Returns:
      Whether the integerValue field is set.

    • getIntegerValue

      public long getIntegerValue()
       An integer value.
      int64 integer_value = 2;
      Specified by:
      getIntegerValue in interface ValueOrBuilder
      Returns:
      The integerValue.

    • hasDoubleValue

      public boolean hasDoubleValue()
       A double value.
      double double_value = 3;
      Specified by:
      hasDoubleValue in interface ValueOrBuilder
      Returns:
      Whether the doubleValue field is set.

    • getDoubleValue

      public double getDoubleValue()
       A double value.
      double double_value = 3;
      Specified by:
      getDoubleValue in interface ValueOrBuilder
      Returns:
      The doubleValue.

    • 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;
      Specified by:
      hasTimestampValue in interface ValueOrBuilder
      Returns:
      Whether the timestampValue field is set.

    • getTimestampValue

      public com.google.protobuf.Timestamp getTimestampValue()
       A timestamp value.

 Precise only to microseconds. When stored, any additional precision is
 rounded down.
      .google.protobuf.Timestamp timestamp_value = 10;
      Specified by:
      getTimestampValue in interface ValueOrBuilder
      Returns:
      The timestampValue.

    • getTimestampValueOrBuilder

      public com.google.protobuf.TimestampOrBuilder getTimestampValueOrBuilder()
       A timestamp value.

 Precise only to microseconds. When stored, any additional precision is
 rounded down.
      .google.protobuf.Timestamp timestamp_value = 10;
      Specified by:
      getTimestampValueOrBuilder in interface ValueOrBuilder

    • 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;
      Specified by:
      hasStringValue in interface ValueOrBuilder
      Returns:
      Whether the stringValue field is set.

    • 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;
      Specified by:
      getStringValue in interface ValueOrBuilder
      Returns:
      The stringValue.

    • getStringValueBytes

      public com.google.protobuf.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;
      Specified by:
      getStringValueBytes in interface ValueOrBuilder
      Returns:
      The bytes for stringValue.

    • 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;
      Specified by:
      hasBytesValue in interface ValueOrBuilder
      Returns:
      Whether the bytesValue field is set.

    • getBytesValue

      public com.google.protobuf.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;
      Specified by:
      getBytesValue in interface ValueOrBuilder
      Returns:
      The bytesValue.

    • hasReferenceValue

      public boolean hasReferenceValue()
       A reference to a document. For example:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string reference_value = 5;
      Specified by:
      hasReferenceValue in interface ValueOrBuilder
      Returns:
      Whether the referenceValue field is set.

    • getReferenceValue

      public String getReferenceValue()
       A reference to a document. For example:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string reference_value = 5;
      Specified by:
      getReferenceValue in interface ValueOrBuilder
      Returns:
      The referenceValue.

    • getReferenceValueBytes

      public com.google.protobuf.ByteString getReferenceValueBytes()
       A reference to a document. For example:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string reference_value = 5;
      Specified by:
      getReferenceValueBytes in interface ValueOrBuilder
      Returns:
      The bytes for referenceValue.

    • hasGeoPointValue

      public boolean hasGeoPointValue()
       A geo point value representing a point on the surface of Earth.
      .google.type.LatLng geo_point_value = 8;
      Specified by:
      hasGeoPointValue in interface ValueOrBuilder
      Returns:
      Whether the geoPointValue field is set.

    • getGeoPointValue

      public com.google.type.LatLng getGeoPointValue()
       A geo point value representing a point on the surface of Earth.
      .google.type.LatLng geo_point_value = 8;
      Specified by:
      getGeoPointValue in interface ValueOrBuilder
      Returns:
      The geoPointValue.

    • getGeoPointValueOrBuilder

      public com.google.type.LatLngOrBuilder getGeoPointValueOrBuilder()
       A geo point value representing a point on the surface of Earth.
      .google.type.LatLng geo_point_value = 8;
      Specified by:
      getGeoPointValueOrBuilder in interface ValueOrBuilder

    • hasArrayValue

      public boolean hasArrayValue()
       An array value.

 Cannot directly contain another array value, though can contain a
 map which contains another array.
      .google.firestore.v1.ArrayValue array_value = 9;
      Specified by:
      hasArrayValue in interface ValueOrBuilder
      Returns:
      Whether the arrayValue field is set.

    • getArrayValue

      public ArrayValue getArrayValue()
       An array value.

 Cannot directly contain another array value, though can contain a
 map which contains another array.
      .google.firestore.v1.ArrayValue array_value = 9;
      Specified by:
      getArrayValue in interface ValueOrBuilder
      Returns:
      The arrayValue.

    • getArrayValueOrBuilder

      public ArrayValueOrBuilder getArrayValueOrBuilder()
       An array value.

 Cannot directly contain another array value, though can contain a
 map which contains another array.
      .google.firestore.v1.ArrayValue array_value = 9;
      Specified by:
      getArrayValueOrBuilder in interface ValueOrBuilder

    • hasMapValue

      public boolean hasMapValue()
       A map value.
      .google.firestore.v1.MapValue map_value = 6;
      Specified by:
      hasMapValue in interface ValueOrBuilder
      Returns:
      Whether the mapValue field is set.

    • getMapValue

      public MapValue getMapValue()
       A map value.
      .google.firestore.v1.MapValue map_value = 6;
      Specified by:
      getMapValue in interface ValueOrBuilder
      Returns:
      The mapValue.

    • getMapValueOrBuilder

      public MapValueOrBuilder getMapValueOrBuilder()
       A map value.
      .google.firestore.v1.MapValue map_value = 6;
      Specified by:
      getMapValueOrBuilder in interface ValueOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Value parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Value parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Value parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Value parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Value parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Value parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Value parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Value parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Value parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Value parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Value parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Value parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Value.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Value.Builder newBuilder()

    • newBuilder

      public static Value.Builder newBuilder(Value prototype)

    • toBuilder

      public Value.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Value.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Value getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Value> parser()

    • getParserForType

      public com.google.protobuf.Parser<Value> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Value getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder