Class: Google::Apis::DatastoreV1::PartitionId

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datastore_v1/classes.rb,
generated/google/apis/datastore_v1/representations.rb,
generated/google/apis/datastore_v1/representations.rb

Overview

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions:

  • May be "".
  • Must be valid UTF-8 bytes.
  • Must have values that match regex [A-Za-z\d\.\-_]1,100` If the value of any dimension matches regex.*`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PartitionId

Returns a new instance of PartitionId.


525
526
527
# File 'generated/google/apis/datastore_v1/classes.rb', line 525

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#namespace_idString

If not empty, the ID of the namespace to which the entities belong. Corresponds to the JSON property namespaceId

Returns:

  • (String)

518
519
520
# File 'generated/google/apis/datastore_v1/classes.rb', line 518

def namespace_id
  @namespace_id
end

#project_idString

The ID of the project to which the entities belong. Corresponds to the JSON property projectId

Returns:

  • (String)

523
524
525
# File 'generated/google/apis/datastore_v1/classes.rb', line 523

def project_id
  @project_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


530
531
532
533
# File 'generated/google/apis/datastore_v1/classes.rb', line 530

def update!(**args)
  @namespace_id = args[:namespace_id] if args.key?(:namespace_id)
  @project_id = args[:project_id] if args.key?(:project_id)
end