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

    Interface MessageFieldDescriptor

    Describes one generated message field for runtime reflection.

    This is a small SDK descriptor, not a complete protobuf descriptor. It contains only the data needed by runtime features such as reset masks.

    interface MessageFieldDescriptor {
        elementDefault?: () => unknown;
        enumNames?: readonly string[];
        immutable?: boolean;
        immutableOneof?: boolean;
        jsonName?: string;
        map?: boolean;
        mapKeyType?: MessageFieldScalarType;
        mapValue?: () => MessageDescriptor | undefined;
        mapValueType?: MessageFieldScalarType | 11;
        message?: () => MessageDescriptor | undefined;
        nid?: { parentResource?: string[]; resource?: string[] };
        oneof?: boolean;
        outputOnly?: boolean;
        pbName: string;
        presence?: boolean;
        repeated?: boolean;
        scalarType?: MessageFieldScalarType;
        subfieldSettings?: {
            fieldPath: string;
            nid?: { parentResource?: string[]; resource?: string[] };
        }[];
    }
    Index
    elementDefault? enumNames? immutable? immutableOneof? jsonName? map? mapKeyType? mapValue? mapValueType? message? nid? oneof? outputOnly? pbName presence? repeated? scalarType? subfieldSettings?
    elementDefault?: () => unknown

    Creates the default collection element.

    Type Declaration

      • (): unknown

      • Creates the default collection element.

        Returns unknown

    enumNames?: readonly string[]

    Contains declared enum names for canonical JSON parsing, including map values.

    immutable?: boolean

    Specifies whether the field has field_behavior = IMMUTABLE.

    immutableOneof?: boolean

    Specifies whether the field represents an immutable oneof.

    jsonName?: string

    Contains the protobuf JSON field name.

    map?: boolean

    Specifies whether the field is a map.

    mapKeyType?: MessageFieldScalarType

    Contains the protobuf scalar type of map keys.

    mapValue?: () => MessageDescriptor | undefined

    Returns the nested descriptor when this is a map with message values.

    Type Declaration

    mapValueType?: MessageFieldScalarType | 11

    Contains the protobuf type of map values; 11 identifies message values.

    message?: () => MessageDescriptor | undefined

    Returns the nested descriptor when this field contains a message.

    Type Declaration

    nid?: { parentResource?: string[]; resource?: string[] }

    Contains allowed Nebius ID and metadata parent types.

    Type Declaration

    • OptionalparentResource?: string[]

      Contains the parent resource.

    • Optionalresource?: string[]

      Contains the resource.

    oneof?: boolean

    Specifies whether the field belongs to a oneof.

    outputOnly?: boolean

    Specifies that the server owns this field.

    pbName: string

    Contains the original snake_case protobuf field name.

    presence?: boolean

    Tracks explicit presence for optional fields.

    repeated?: boolean

    Specifies whether the field is repeated.

    scalarType?: MessageFieldScalarType

    Contains the protobuf descriptor code when this is a scalar or enum.

    subfieldSettings?: {
        fieldPath: string;
        nid?: { parentResource?: string[]; resource?: string[] };
    }[]

    Contains field-level annotation overrides.

    Type Declaration

    • fieldPath: string

      Contains the field path.

    • Optionalnid?: { parentResource?: string[]; resource?: string[] }

      Contains the nid.

      • OptionalparentResource?: string[]

        Contains the parent resource.

      • Optionalresource?: string[]

        Contains the resource.

    Settings
    Member Visibility

    On This Page
    Properties