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

    Interface FieldOptions

    Represents the google.protobuf.FieldOptions protobuf message.

    interface FieldOptions {
        "[customJson]"?: () => unknown;
        "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>;
        $type: "google.protobuf.FieldOptions";
        credentials?: any;
        ctype?: FieldOptions_CType;
        debugRedact?: boolean;
        deprecated?: boolean;
        editionDefaults: FieldOptions_EditionDefault[];
        features?: FeatureSet;
        featureSupport?: FieldOptions_FeatureSupport;
        field?: FieldRules;
        fieldBehavior?: FieldBehavior[];
        fieldDeprecationDetails?: DeprecationDetails;
        fieldPySdk?: FieldPySDKSettings;
        jstype?: FieldOptions_JSType;
        lazy?: boolean;
        nid?: NIDFieldSettings;
        packed?: boolean;
        predefined?: PredefinedRules;
        retention?: FieldOptions_OptionRetention;
        sensitive?: any;
        subfieldSettings?: SubfieldSettings[];
        targets: FieldOptions_OptionTargetType[];
        uninterpretedOption: UninterpretedOption[];
        unverifiedLazy?: boolean;
        weak?: boolean;
        [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined;
    }

    Indexable

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

      Represents the google.protobuf.FieldOptions protobuf message.

      • Uint8Array<ArrayBufferLike>
      • () => unknown
          • (): unknown

          • Represents the google.protobuf.FieldOptions protobuf message.

            Returns unknown

      • undefined
    Index
    [customJson]? [unknownFieldsSymbol]? $type credentials? ctype? debugRedact? deprecated? editionDefaults features? featureSupport? field? fieldBehavior? fieldDeprecationDetails? fieldPySdk? jstype? lazy? nid? packed? predefined? retention? sensitive? subfieldSettings? targets uninterpretedOption unverifiedLazy? weak?
    "[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: "google.protobuf.FieldOptions"

    Contains the fully qualified protobuf type name.

    credentials?: any

    Contains the credentials.

    ctype?: FieldOptions_CType

    NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead. The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.

    debugRedact?: boolean

    Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.

    deprecated?: boolean

    Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.

    editionDefaults: FieldOptions_EditionDefault[]

    Contains the edition_defaults protobuf field.

    features?: FeatureSet

    Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

    featureSupport?: FieldOptions_FeatureSupport

    Contains the feature_support protobuf field.

    field?: FieldRules

    Contains the field.

    fieldBehavior?: FieldBehavior[]

    Contains the field behavior.

    fieldDeprecationDetails?: DeprecationDetails

    Contains the field deprecation details.

    fieldPySdk?: FieldPySDKSettings

    Contains the field py SDK.

    jstype?: FieldOptions_JSType

    The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent.

    This option is an enum to permit additional types to be added, e.g. goog.math.Integer.

    lazy?: boolean

    Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed.

    This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it.

    This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access.

    Note that lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).

    nid?: NIDFieldSettings

    Contains the nid.

    packed?: boolean

    The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob. In proto3, only explicit setting it to false will avoid using packed encoding. This option is prohibited in Editions, but the repeated_field_encoding feature can be used to control the behavior.

    predefined?: PredefinedRules

    Contains the predefined.

    retention?: FieldOptions_OptionRetention

    Contains the retention protobuf field.

    sensitive?: any

    Contains the sensitive.

    subfieldSettings?: SubfieldSettings[]

    Contains the subfield settings.

    targets: FieldOptions_OptionTargetType[]

    Contains the targets protobuf field.

    uninterpretedOption: UninterpretedOption[]

    The parser stores options it doesn't recognize here. See above.

    unverifiedLazy?: boolean

    unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.

    weak?: boolean

    DEPRECATED. DO NOT USE! For Google-internal migration only. Do not use.

    Deprecated.

    Settings
    Member Visibility

    On This Page
    Properties