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

Inherits:
Object
  • Object
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

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:



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 792

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.
  #
  #     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.
  # @!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 `""`.
  #
  #     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.
  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.

Returns:

  • (::Array<::Google::Cloud::Dlp::V2::Key::PathElement>) —

    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.



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 792

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.
  #
  #     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.
  # @!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 `""`.
  #
  #     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.
  class PathElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end