Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::Key::PathElement (v1.4.1)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::Key::PathElement.

A (kind, ID/name) pair used to construct a key path.

If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#id

def id() -> ::Integer
Returns
  • (::Integer) — The auto-allocated ID of the entity.

    Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

    Note: The following fields are mutually exclusive: id, name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — The auto-allocated ID of the entity.

    Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

    Note: The following fields are mutually exclusive: id, name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Integer) — The auto-allocated ID of the entity.

    Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

    Note: The following fields are mutually exclusive: id, name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#kind

def kind() -> ::String
Returns
  • (::String) — The kind of the entity.

    A kind matching regex __.*__ is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be "".

    Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as __bytes<X>__ where <X> is the base-64 encoding of the bytes.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — The kind of the entity.

    A kind matching regex __.*__ is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be "".

    Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as __bytes<X>__ where <X> is the base-64 encoding of the bytes.

Returns
  • (::String) — The kind of the entity.

    A kind matching regex __.*__ is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be "".

    Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as __bytes<X>__ where <X> is the base-64 encoding of the bytes.

#name

def name() -> ::String
Returns
  • (::String) — The name of the entity.

    A name matching regex __.*__ is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be "".

    Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as __bytes<X>__ where <X> is the base-64 encoding of the bytes.

    Note: The following fields are mutually exclusive: name, id. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The name of the entity.

    A name matching regex __.*__ is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be "".

    Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as __bytes<X>__ where <X> is the base-64 encoding of the bytes.

    Note: The following fields are mutually exclusive: name, id. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The name of the entity.

    A name matching regex __.*__ is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be "".

    Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as __bytes<X>__ where <X> is the base-64 encoding of the bytes.

    Note: The following fields are mutually exclusive: name, id. If a field in that set is populated, all other fields in the set will automatically be cleared.