nebius.base.fieldmask.FieldKey

class documentation

class FieldKey(str): (source)

Constructor: FieldKey.unmarshal(marshaled_key)

View In Hierarchy

Field key component used in paths and mask trees.

Class Method unmarshal Parse a single key from its marshaled representation.
Method marshal Serialize the key, quoting if it contains special characters.
@classmethod
def unmarshal(cls, marshaled_key: str) -> FieldKey: (source)

Parse a single key from its marshaled representation.

Parameters
marshaled_key:strKey string that may be quoted.
Returns
FieldKeyA FieldKey instance.
Raises
MarshalErrorIf the string is malformed.
def marshal(self) -> str: (source)

Serialize the key, quoting if it contains special characters.

Returns
strMarshaled key string.