Class FieldKey

constructor

• new FieldKey(value: string): FieldKey

  Creates a key from an unquoted field name.

  Parameters

  • value: string

  Returns FieldKey

Readonlyvalue

[customJson]

• "[customJson]"(): string

  Returns a JSON-safe value for logs.

  Returns string

marshal

• marshal(): string

  Returns the key in field-mask syntax.

  The method adds JSON quotes only when the key needs them.

  Returns string

  Example

  import { FieldKey } from '@nebius/js-sdk/runtime/fieldmask';
  
  new FieldKey('spec').marshal(); // "spec"
  new FieldKey('display-name').marshal(); // "\"display-name\""
  Copy

toString

• toString(): string

  Returns the unquoted field name.

  Returns string

Staticunmarshal

• unmarshal(marshaled: string): FieldKey

  Reads one key from field-mask text.

  Parameters

  • marshaled: string

  Returns FieldKey

  Throws

  MarshalError if the input is neither a simple key nor a valid JSON string.