Class: Google::Cloud::Dlp::V2::Key

Inherits:

Object

Object
Google::Cloud::Dlp::V2::Key

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/privacy/dlp/v2/storage.rb

Overview

A unique identifier for a Datastore entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Defined Under Namespace

Classes: PathElement

Instance Attribute Summary collapse

#partition_id ⇒ ::Google::Cloud::Dlp::V2::PartitionId
Entities are partitioned into subsets, currently identified by a project ID and namespace ID.
#path ⇒ ::Array<::Google::Cloud::Dlp::V2::Key::PathElement>
The entity path.

Instance Attribute Details

#partition_id ⇒ `::Google::Cloud::Dlp::V2::PartitionId`

Returns Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

Returns:

(::Google::Cloud::Dlp::V2::PartitionId) —
Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 768

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  # @!attribute [rw] kind
  #   @return [::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 `""`.
  # @!attribute [rw] id
  #   @return [::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.
  # @!attribute [rw] name
  #   @return [::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 `""`.
  class PathElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#path ⇒ `::Array<::Google::Cloud::Dlp::V2::Key::PathElement>`

Returns The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.

A path can never be empty, and a path can have at most 100 elements.