Package com.google.firestore.v1

Interface ValueOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Value, Value.Builder
public interface ValueOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasNullValue

      boolean hasNullValue()
       A null value.
      .google.protobuf.NullValue null_value = 11;
      Returns:
      Whether the nullValue field is set.

    • getNullValueValue

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

    • getNullValue

      com.google.protobuf.NullValue getNullValue()
       A null value.
      .google.protobuf.NullValue null_value = 11;
      Returns:
      The nullValue.

    • hasBooleanValue

      boolean hasBooleanValue()
       A boolean value.
      bool boolean_value = 1;
      Returns:
      Whether the booleanValue field is set.

    • getBooleanValue

      boolean getBooleanValue()
       A boolean value.
      bool boolean_value = 1;
      Returns:
      The booleanValue.

    • hasIntegerValue

      boolean hasIntegerValue()
       An integer value.
      int64 integer_value = 2;
      Returns:
      Whether the integerValue field is set.

    • getIntegerValue

      long getIntegerValue()
       An integer value.
      int64 integer_value = 2;
      Returns:
      The integerValue.

    • hasDoubleValue

      boolean hasDoubleValue()
       A double value.
      double double_value = 3;
      Returns:
      Whether the doubleValue field is set.

    • getDoubleValue

      double getDoubleValue()
       A double value.
      double double_value = 3;
      Returns:
      The doubleValue.

    • hasTimestampValue

      boolean hasTimestampValue()
       A timestamp value.

 Precise only to microseconds. When stored, any additional precision is
 rounded down.
      .google.protobuf.Timestamp timestamp_value = 10;
      Returns:
      Whether the timestampValue field is set.

    • getTimestampValue

      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;
      Returns:
      The timestampValue.

    • getTimestampValueOrBuilder

      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;

    • hasStringValue

      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:
      Whether the stringValue field is set.

    • getStringValue

      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:
      The stringValue.

    • getStringValueBytes

      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;
      Returns:
      The bytes for stringValue.

    • hasBytesValue

      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:
      Whether the bytesValue field is set.

    • getBytesValue

      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;
      Returns:
      The bytesValue.

    • hasReferenceValue

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

    • getReferenceValue

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

    • getReferenceValueBytes

      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;
      Returns:
      The bytes for referenceValue.

    • hasGeoPointValue

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

    • getGeoPointValue

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

    • getGeoPointValueOrBuilder

      com.google.type.LatLngOrBuilder getGeoPointValueOrBuilder()
       A geo point value representing a point on the surface of Earth.
      .google.type.LatLng geo_point_value = 8;

    • hasArrayValue

      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;
      Returns:
      Whether the arrayValue field is set.

    • getArrayValue

      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;
      Returns:
      The arrayValue.

    • getArrayValueOrBuilder

      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;

    • hasMapValue

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

    • getMapValue

      MapValue getMapValue()
       A map value.
      .google.firestore.v1.MapValue map_value = 6;
      Returns:
      The mapValue.

    • getMapValueOrBuilder

      MapValueOrBuilder getMapValueOrBuilder()
       A map value.
      .google.firestore.v1.MapValue map_value = 6;

    • hasFieldReferenceValue

      boolean hasFieldReferenceValue()
       Value which references a field.

 This is considered relative (vs absolute) since it only refers to a field
 and not a field within a particular document.

 **Requires:**

 * Must follow [field reference][FieldReference.field_path] limitations.

 * Not allowed to be used when writing documents.
      string field_reference_value = 19;
      Returns:
      Whether the fieldReferenceValue field is set.

    • getFieldReferenceValue

      String getFieldReferenceValue()
       Value which references a field.

 This is considered relative (vs absolute) since it only refers to a field
 and not a field within a particular document.

 **Requires:**

 * Must follow [field reference][FieldReference.field_path] limitations.

 * Not allowed to be used when writing documents.
      string field_reference_value = 19;
      Returns:
      The fieldReferenceValue.

    • getFieldReferenceValueBytes

      com.google.protobuf.ByteString getFieldReferenceValueBytes()
       Value which references a field.

 This is considered relative (vs absolute) since it only refers to a field
 and not a field within a particular document.

 **Requires:**

 * Must follow [field reference][FieldReference.field_path] limitations.

 * Not allowed to be used when writing documents.
      string field_reference_value = 19;
      Returns:
      The bytes for fieldReferenceValue.

    • hasFunctionValue

      boolean hasFunctionValue()
       A value that represents an unevaluated expression.

 **Requires:**

 * Not allowed to be used when writing documents.
      .google.firestore.v1.Function function_value = 20;
      Returns:
      Whether the functionValue field is set.

    • getFunctionValue

      Function getFunctionValue()
       A value that represents an unevaluated expression.

 **Requires:**

 * Not allowed to be used when writing documents.
      .google.firestore.v1.Function function_value = 20;
      Returns:
      The functionValue.

    • getFunctionValueOrBuilder

      FunctionOrBuilder getFunctionValueOrBuilder()
       A value that represents an unevaluated expression.

 **Requires:**

 * Not allowed to be used when writing documents.
      .google.firestore.v1.Function function_value = 20;

    • hasPipelineValue

      boolean hasPipelineValue()
       A value that represents an unevaluated pipeline.

 **Requires:**

 * Not allowed to be used when writing documents.
      .google.firestore.v1.Pipeline pipeline_value = 21;
      Returns:
      Whether the pipelineValue field is set.

    • getPipelineValue

      Pipeline getPipelineValue()
       A value that represents an unevaluated pipeline.

 **Requires:**

 * Not allowed to be used when writing documents.
      .google.firestore.v1.Pipeline pipeline_value = 21;
      Returns:
      The pipelineValue.

    • getPipelineValueOrBuilder

      PipelineOrBuilder getPipelineValueOrBuilder()
       A value that represents an unevaluated pipeline.

 **Requires:**

 * Not allowed to be used when writing documents.
      .google.firestore.v1.Pipeline pipeline_value = 21;

    • getValueTypeCase

      Value.ValueTypeCase getValueTypeCase()