nebius.api.nebius.SubfieldSettings

class documentation

class SubfieldSettings(Message): (source)

Constructor: SubfieldSettings(initial_message, field_path, nid, is_required)

View In Hierarchy

SubfieldSettings describes overrides for some settings for subfields of a field. Overrides are applied to fields in order of appearance, so the first matching override is applied, and the rest are ignored.

Example:

message MyMessage {
  string field1 = 1;
}
message MyMessage2 {
  MyMessage field2 = 1 [(subfield_settings) = { field_path: "field1", is_required: true }];
}

In this example, field1 in MyMessage2 is required, even if it is not required in MyMessage. The following example will override the setting again:

service MyService {
  rpc MyMethod(MyMessage2) returns (MyMessage2) {
    option (method_behavior) = METHOD_UPDATER;
    option (request_fields) = { field_path: "field2.field1", is_required: false };
  }
}

In this example, field1 in MyMessage2 is not required for the MyMethod, even if it is required in MyMessage2.

Class __OneOfClass__is_required__ Undocumented
Class __OneOfClass__is_required_is_required__ Undocumented
Method __init__ Create a message from a source message and field values.
Method field_path.setter Set or clear the generated field_path field.
Method is_required.setter Set or clear the generated is_required field.
Method nid.setter Set or clear the generated nid field.
Constant __PROTO_DESCRIPTOR__ Protobuf message descriptor from the registry.
Constant __PROTO_FULL_NAME__ Fully qualified protobuf message name.
Constant __PY_TO_PB2__ Mapping from Python member names to protobuf names.
Property field_path Subfield path in the message, for example metadata.parent_id or metadata.name. Must be a valid SelectMask. May match several fields, if necessary. For example, some.*.subfield or some.(subfield,another_field)...
Property is_required Mark a field as required, even if it is not required in the message it contains. Unlike cel expressions, this setting can be reflected in tools documentation and help messages.
Property nid For fields annotated with this option, values are treated as NIDs and warnings are emitted when they are not valid. These warnings are separate from server-side validation.
Property _is_required Undocumented

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 __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 __REGISTRY__ Registry for the message and its descriptor.
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 _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, *, field_path: str | None | UnsetType = _NEBIUS_UNSET, nid: NIDFieldSettings | None | UnsetType = _NEBIUS_UNSET, is_required: bool | None | UnsetType = _NEBIUS_UNSET): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

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

Set or clear the generated field_path field.

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

Set or clear the generated is_required field.

@nid.setter
def nid(self, value: NIDFieldSettings | None): (source)

Set or clear the generated nid field.

__PROTO_DESCRIPTOR__ = (source)
overrides nebius.base.protos.direct.Message.__PROTO_DESCRIPTOR__

Protobuf message descriptor from the registry.

Value
REGISTRY.message_descriptor('nebius.SubfieldSettings')
__PROTO_FULL_NAME__: str = (source)
overrides nebius.base.protos.direct.Message.__PROTO_FULL_NAME__

Fully qualified protobuf message name.

Value
'nebius.SubfieldSettings'
__PY_TO_PB2__: dict[str, str] = (source)
overrides nebius.base.protos.direct.Message.__PY_TO_PB2__

Mapping from Python member names to protobuf names.

Value
{'field_path': 'field_path',
 'nid': 'nid',
 'is_required': 'is_required',
 '_is_required': '_is_required'}
@_NebiusProperty
field_path: str = (source)

Subfield path in the message, for example metadata.parent_id or metadata.name. Must be a valid SelectMask. May match several fields, if necessary. For example, some.*.subfield or some.(subfield,another_field).

@_NebiusProperty
is_required: bool | None = (source)

Mark a field as required, even if it is not required in the message it contains. Unlike cel expressions, this setting can be reflected in tools documentation and help messages.

@_NebiusProperty
nid: NIDFieldSettings = (source)

For fields annotated with this option, values are treated as NIDs and warnings are emitted when they are not valid. These warnings are separate from server-side validation.

@_NebiusProperty
_is_required: __OneOfClass__is_required_is_required__ | None = (source)

Undocumented