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



399
400
401
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 399

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

Instance Attribute Details

#namespace_id ⇒ String

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

Returns:

  • (String) 


397
398
399
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 397

def namespace_id
  @namespace_id
end

#project_id ⇒ String

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

Returns:

  • (String) 


392
393
394
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 392

def project_id
  @project_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



404
405
406
407
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 404

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