Class: Google::Firestore::V1::Value

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb

Overview

A message that can hold any of the supported value types.

Instance Attribute Summary collapse

Instance Attribute Details

#array_value ⇒ Google::Firestore::V1::ArrayValue

Returns An array value.

Cannot directly contain another array value, though can contain an map which contains another array.

Returns:



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#boolean_value ⇒ true, false

Returns A boolean value.

Returns:

  • (true, false) —

    A boolean value.



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#bytes_value ⇒ String

Returns A bytes value.

Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

Returns:

  • (String) —

    A bytes value.

    Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#double_value ⇒ Float

Returns A double value.

Returns:

  • (Float) —

    A double value.



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#geo_point_value ⇒ Google::Type::LatLng

Returns A geo point value representing a point on the surface of Earth.

Returns:

  • (Google::Type::LatLng) —

    A geo point value representing a point on the surface of Earth.



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#integer_value ⇒ Integer

Returns An integer value.

Returns:

  • (Integer) —

    An integer value.



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#map_value ⇒ Google::Firestore::V1::MapValue

Returns A map value.

Returns:



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#null_value ⇒ Google::Protobuf::NullValue

Returns A null value.

Returns:

  • (Google::Protobuf::NullValue) —

    A null value.



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#reference_value ⇒ String

Returns A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Returns:

  • (String) —

    A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#string_value ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end

#timestamp_value ⇒ Google::Protobuf::Timestamp

Returns A timestamp value.

Precise only to microseconds. When stored, any additional precision is rounded down.

Returns:

  • (Google::Protobuf::Timestamp) —

    A timestamp value.

    Precise only to microseconds. When stored, any additional precision is rounded down.



116
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb', line 116

class Value; end