Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::Key::PathElement.
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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#id
defid()->::Integer
Returns
(::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.
#id=
defid=(value)->::Integer
Parameter
value (::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.
Returns
(::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.
#kind
defkind()->::String
Returns
(::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 "".
#kind=
defkind=(value)->::String
Parameter
value (::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 "".
Returns
(::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 "".
#name
defname()->::String
Returns
(::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.
#name=
defname=(value)->::String
Parameter
value (::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.
Returns
(::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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::Key::PathElement (v1.12.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.12.1 (latest)](/ruby/docs/reference/google-cloud-dlp-v2/latest/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.12.0](/ruby/docs/reference/google-cloud-dlp-v2/1.12.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.11.0](/ruby/docs/reference/google-cloud-dlp-v2/1.11.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.10.0](/ruby/docs/reference/google-cloud-dlp-v2/1.10.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.9.1](/ruby/docs/reference/google-cloud-dlp-v2/1.9.1/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.8.0](/ruby/docs/reference/google-cloud-dlp-v2/1.8.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.7.0](/ruby/docs/reference/google-cloud-dlp-v2/1.7.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.6.0](/ruby/docs/reference/google-cloud-dlp-v2/1.6.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.5.0](/ruby/docs/reference/google-cloud-dlp-v2/1.5.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.4.0](/ruby/docs/reference/google-cloud-dlp-v2/1.4.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.3.1](/ruby/docs/reference/google-cloud-dlp-v2/1.3.1/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.2.0](/ruby/docs/reference/google-cloud-dlp-v2/1.2.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.1.0](/ruby/docs/reference/google-cloud-dlp-v2/1.1.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [1.0.0](/ruby/docs/reference/google-cloud-dlp-v2/1.0.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.24.0](/ruby/docs/reference/google-cloud-dlp-v2/0.24.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.23.0](/ruby/docs/reference/google-cloud-dlp-v2/0.23.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.22.0](/ruby/docs/reference/google-cloud-dlp-v2/0.22.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.21.0](/ruby/docs/reference/google-cloud-dlp-v2/0.21.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.20.2](/ruby/docs/reference/google-cloud-dlp-v2/0.20.2/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.19.0](/ruby/docs/reference/google-cloud-dlp-v2/0.19.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.18.0](/ruby/docs/reference/google-cloud-dlp-v2/0.18.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.17.0](/ruby/docs/reference/google-cloud-dlp-v2/0.17.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.16.0](/ruby/docs/reference/google-cloud-dlp-v2/0.16.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.15.0](/ruby/docs/reference/google-cloud-dlp-v2/0.15.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.14.0](/ruby/docs/reference/google-cloud-dlp-v2/0.14.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.13.1](/ruby/docs/reference/google-cloud-dlp-v2/0.13.1/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.12.0](/ruby/docs/reference/google-cloud-dlp-v2/0.12.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.11.0](/ruby/docs/reference/google-cloud-dlp-v2/0.11.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.10.0](/ruby/docs/reference/google-cloud-dlp-v2/0.10.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.9.0](/ruby/docs/reference/google-cloud-dlp-v2/0.9.0/Google-Cloud-Dlp-V2-Key-PathElement)\n- [0.8.1](/ruby/docs/reference/google-cloud-dlp-v2/0.8.1/Google-Cloud-Dlp-V2-Key-PathElement) \nReference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::Key::PathElement.\n\nA (kind, ID/name) pair used to construct a key path.\n\n\n\u003cbr /\u003e\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #id\n\n def id() -\u003e ::Integer\n\n**Returns**\n\n- (::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.\n\n 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.\n\n### #id=\n\n def id=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::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.\n\n\nNote: 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. \n**Returns**\n\n- (::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.\n\n 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.\n\n### #kind\n\n def kind() -\u003e ::String\n\n**Returns**\n\n- (::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 `\"\"`.\n\n### #kind=\n\n def kind=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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 `\"\"`. \n**Returns**\n\n- (::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 `\"\"`.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::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 `\"\"`.\n\n\n 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.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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 `\"\"`.\n\n\nNote: 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. \n**Returns**\n\n- (::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 `\"\"`.\n\n\n 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."]]
