@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface FieldPathElement

    FieldPathElement provides enough information to nest through a single protobuf field.

    If the selected field is a map or repeated field, the subscript value selects a specific element from it. A path that refers to a value nested under a map key or repeated field index will have a subscript value. The field_type field allows unambiguous resolution of a field even if descriptors are not available.

    interface FieldPathElement {
        "[customJson]"?: () => unknown;
        "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>;
        $type: "buf.validate.FieldPathElement";
        fieldName?: string;
        fieldNumber?: number;
        fieldType?: FieldDescriptorProto_Type;
        keyType?: FieldDescriptorProto_Type;
        subscript?:
            | { $case: "index"; index: Long }
            | { $case: "boolKey"; boolKey: boolean }
            | { $case: "intKey"; intKey: Long }
            | { $case: "uintKey"; uintKey: Long }
            | { $case: "stringKey"; stringKey: string };
        valueType?: FieldDescriptorProto_Type;
        [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined;
    }

    Indexable

    • [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined

      FieldPathElement provides enough information to nest through a single protobuf field.

      If the selected field is a map or repeated field, the subscript value selects a specific element from it. A path that refers to a value nested under a map key or repeated field index will have a subscript value. The field_type field allows unambiguous resolution of a field even if descriptors are not available.

      • Uint8Array<ArrayBufferLike>
      • () => unknown
          • (): unknown
          • FieldPathElement provides enough information to nest through a single protobuf field.

            If the selected field is a map or repeated field, the subscript value selects a specific element from it. A path that refers to a value nested under a map key or repeated field index will have a subscript value. The field_type field allows unambiguous resolution of a field even if descriptors are not available.

            Returns unknown

      • undefined
    Index
    "[customJson]"?: () => unknown

    Returns a safe value for JSON logs.

    Type Declaration

      • (): unknown
      • Returns a safe value for JSON logs.

        Returns unknown

    "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>

    Preserves protobuf fields that this SDK version does not recognize.

    $type: "buf.validate.FieldPathElement"

    Contains the fully qualified protobuf type name.

    fieldName?: string

    field_name contains the field name this path element refers to. This can be used to display a human-readable path even if the field number is unknown.

    fieldNumber?: number

    field_number is the field number this path element refers to.

    field_type specifies the type of this field. When using reflection, this value is not needed.

    This value is provided to make it possible to traverse unknown fields through wire data. When traversing wire data, be mindful of both packed1 and delimited2 encoding schemes.

    N.B.: Although groups are deprecated, the corresponding delimited encoding scheme is not, and can be explicitly used in Protocol Buffers 2023 Edition.

    key_type specifies the map key type of this field. This value is useful when traversing unknown fields through wire data: specifically, it allows handling the differences between different integer encodings.

    subscript?:
        | { $case: "index"; index: Long }
        | { $case: "boolKey"; boolKey: boolean }
        | { $case: "intKey"; intKey: Long }
        | { $case: "uintKey"; uintKey: Long }
        | { $case: "stringKey"; stringKey: string }

    subscript contains a repeated index or map key, if this path element nests into a repeated or map field.

    Type Declaration

    • { $case: "index"; index: Long }
      • $case: "index"

        Contains the case.

      • index: Long

        Contains the index.

    • { $case: "boolKey"; boolKey: boolean }
      • $case: "boolKey"

        Contains the case.

      • boolKey: boolean

        Contains the bool key.

    • { $case: "intKey"; intKey: Long }
      • $case: "intKey"

        Contains the case.

      • intKey: Long

        Contains the int key.

    • { $case: "uintKey"; uintKey: Long }
      • $case: "uintKey"

        Contains the case.

      • uintKey: Long

        Contains the uint key.

    • { $case: "stringKey"; stringKey: string }
      • $case: "stringKey"

        Contains the case.

      • stringKey: string

        Contains the string key.

    value_type specifies map value type of this field. This is useful if you want to display a value inside unknown fields through wire data.