nebius.api.google.protobuf.FieldDescriptorProto

class documentation

class FieldDescriptorProto(Message): (source)

Constructor: FieldDescriptorProto(initial_message, name, number, label, ...)

View In Hierarchy

Describes a field within a message.

Class Label No class docstring; 2/3 constants documented
Class Type No class docstring; 8/18 constants documented
Method __init__ Create a message from a source message and field values.
Method default_value.setter Set or clear the generated default_value field.
Method extendee.setter Set or clear the generated extendee field.
Method json_name.setter Set or clear the generated json_name field.
Method label.setter Set or clear the generated label field.
Method name.setter Set or clear the generated name field.
Method number.setter Set or clear the generated number field.
Method oneof_index.setter Set or clear the generated oneof_index field.
Method options.setter Set or clear the generated options field.
Method proto3_optional.setter Set or clear the generated proto3_optional field.
Method type.setter Set or clear the generated type field.
Method type_name.setter Set or clear the generated type_name field.
Property default_value For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value...
Property extendee For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
Property json_name JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
Property label Undocumented
Property name Undocumented
Property number Undocumented
Property oneof_index If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
Property options Undocumented
Property proto3_optional If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.
Property type If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
Property type_name For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

Inherited from Message:

Class Method from_json Create a message from protobuf JSON mapping.
Class Method FromString Create a message by parsing protobuf wire-format bytes.
Class Method get_descriptor Return the message descriptor from the registry.
Class Method is_credentials Return True if a Python field contains credentials.
Class Method is_sensitive Return True if a Python field has the sensitive annotation.
Method __dir__ List generated fields, oneofs, and nested declarations.
Method __repr__ Render non-default fields without disclosing annotated secrets.
Method ByteSize Return the serialized protobuf wire size in bytes.
Method check_presence Check presence using a generated Python field name.
Method Clear Clear all fields, extensions, unknown fields, and the reset mask.
Method clear_extension Clear an extension value.
Method ClearField Clear a protobuf field or oneof and record it in the reset mask.
Method CopyFrom Replace this message with an independent copy of another message.
Method FindInitializationErrors Return paths of missing required fields.
Method get_extension Return an extension value.
Method get_full_update_reset_mask Create a reset mask from the current protobuf state.
Method get_mask Return the reset mask for field changes.
Method has_extension Return True if an extension has explicit presence.
Method HasField Return True if a protobuf field or oneof has explicit presence.
Method is_default Return True if a generated field has its default value.
Method IsInitialized Return True if every required field is initialized.
Method MergeFrom Merge fields from another message of the same generated type.
Method MergeFromString Merge protobuf wire-format bytes into this message.
Method ParseFromString Parse protobuf wire-format bytes and replace this message.
Method SerializeToString Serialize the message using protobuf wire format.
Method set_extension Set an extension value.
Method set_mask Set the reset mask for this message.
Method to_json Serialize this message using protobuf JSON mapping.
Method which_field_in_oneof Return the selected Python field name for a protobuf oneof.
Method WhichOneof Return the selected protobuf field name for a oneof.
Constant __DEPRECATION_DETAILS__ Undocumented
Constant __EXTENSION_REGISTRY__ Registry that decodes protobuf extensions.
Constant __FIELDS__ Runtime field data that the generator creates.
Constant __MAX_NESTING_DEPTH__ Maximum protobuf nesting depth for serialization, parsing, and initialization checks.
Constant __PB2_DESCRIPTOR__ Alias for code that expects a protobuf descriptor.
Constant __PROTO_DESCRIPTOR__ Message descriptor from the registry.
Constant __PY_TO_PB2__ Mapping from Python names to protobuf names.
Constant __REGISTRY__ Registry for the message and its descriptor.
Class Variable __PROTO_FULL_NAME__ Fully qualified protobuf message name.
Property Extensions Provide protobuf-compatible mapping access to extension values.
Class Method _fields_by_number Undocumented
Class Method _fields_by_proto_name Undocumented
Class Method _fields_by_python_name Undocumented
Class Method _from_string Deserialize internally without invoking generated user warnings.
Class Method _oneof_python_name Undocumented
Class Method _public_fields_by_proto_name Undocumented
Class Method _public_fields_by_python_name Undocumented
Static Method _format_map_key Undocumented
Static Method _repr_field Undocumented
Method _bind_child Undocumented
Method _bind_mutation Undocumented
Method _check_same_type Undocumented
Method _child_changed Undocumented
Method _clear_state Undocumented
Method _closed_enum_unknown Undocumented
Method _converted_view Undocumented
Method _decode_map_entry Undocumented
Method _detach_child Undocumented
Method _field_has_value Undocumented
Method _field_is_default Undocumented
Method _find_initialization_errors Undocumented
Method _get_field Undocumented
Method _initialize Initialize message state, optionally suppressing generated warnings.
Method _map Undocumented
Method _merge_from_string Undocumented
Method _nesting_limit Undocumented
Method _notify Undocumented
Method _record_reset Undocumented
Method _repeated Undocumented
Method _select Undocumented
Method _serialize_to_string Undocumented
Method _set_field Undocumented
Method _suspend_mutation Undocumented
Method _suspend_reset_mask Undocumented
Method _try_decode_field Undocumented
Method _write_field Undocumented
Instance Variable _extensions Undocumented
Instance Variable _mutation_suspended Undocumented
Instance Variable _on_mutation Undocumented
Instance Variable _oneofs Undocumented
Instance Variable _present Undocumented
Instance Variable _reset_mask Undocumented
Instance Variable _reset_mask_suspended Undocumented
Instance Variable _unknown_fields Undocumented
Instance Variable _values Undocumented
Instance Variable _views Undocumented
def __init__(self, initial_message: SerializableMessage | None = None, *, name: str | None | UnsetType = ..., number: int | None | UnsetType = ..., label: Label | None | UnsetType = ..., type: nebius.api.google.protobuf.FieldDescriptorProto.Type | None | UnsetType = ..., type_name: str | None | UnsetType = ..., extendee: str | None | UnsetType = ..., default_value: str | None | UnsetType = ..., oneof_index: int | None | UnsetType = ..., json_name: str | None | UnsetType = ..., options: FieldOptions | None | UnsetType = ..., proto3_optional: bool | None | UnsetType = ...): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

@default_value.setter
def default_value(self, value: str | None): (source)

Set or clear the generated default_value field.

@extendee.setter
def extendee(self, value: str | None): (source)

Set or clear the generated extendee field.

@json_name.setter
def json_name(self, value: str | None): (source)

Set or clear the generated json_name field.

@label.setter
def label(self, value: Label | None): (source)

Set or clear the generated label field.

@name.setter
def name(self, value: str | None): (source)

Set or clear the generated name field.

@number.setter
def number(self, value: int | None): (source)

Set or clear the generated number field.

@oneof_index.setter
def oneof_index(self, value: int | None): (source)

Set or clear the generated oneof_index field.

@options.setter
def options(self, value: FieldOptions | None): (source)

Set or clear the generated options field.

@proto3_optional.setter
def proto3_optional(self, value: bool | None): (source)

Set or clear the generated proto3_optional field.

@type.setter
def type(self, value: nebius.api.google.protobuf.FieldDescriptorProto.Type | None): (source)

Set or clear the generated type field.

@type_name.setter
def type_name(self, value: str | None): (source)

Set or clear the generated type_name field.

@property
default_value: str = (source)

For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.

@property
extendee: str = (source)

For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

@property
json_name: str = (source)

JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.

@property
label: Label = (source)

Undocumented

@property
name: str = (source)

Undocumented

@property
number: int = (source)

Undocumented

@property
oneof_index: int = (source)

If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

@property
options: FieldOptions = (source)

Undocumented

@property
proto3_optional: bool = (source)

If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.

When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs.

For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof.

Proto2 optional fields do not set this flag, because they already indicate optional with LABEL_OPTIONAL.

@property
type: nebius.api.google.protobuf.FieldDescriptorProto.Type = (source)

If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

@property
type_name: str = (source)

For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).