Data Loss Prevention V2 Client - Class Key (1.15.1)

Reference documentation and code samples for the Data Loss Prevention V2 Client class Key.

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.

Generated from protobuf message google.privacy.dlp.v2.Key

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ partition_id 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.

↳ path 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.

getPartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID.

Queries are scoped to a single partition.

Returns
Type Description
Google\Cloud\Dlp\V2\PartitionId|null

hasPartitionId

clearPartitionId

setPartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID.

Queries are scoped to a single partition.

Parameter
Name Description
var Google\Cloud\Dlp\V2\PartitionId
Returns
Type Description
$this

getPath

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
Type Description
Google\Protobuf\Internal\RepeatedField

setPath

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.

Parameter
Name Description
var array<Google\Cloud\Dlp\V2\Key\PathElement>
Returns
Type Description
$this