nebius.api.nebius.NIDFieldSettings

class documentation

class NIDFieldSettings(pb_classes.Message): (source)

Constructor: NIDFieldSettings(initial_message, resource, parent_resource)

View In Hierarchy

Undocumented

Method __dir__ Undocumented
Method __init__ Create a wrapper around a protobuf message instance.
Method parent_resource.setter Undocumented
Method resource.setter Undocumented
Constant __PB2_DESCRIPTOR__ Undocumented
Constant __PY_TO_PB2__ Undocumented
Class Variable __mask_functions__ Undocumented
Property parent_resource For metadata fields, parent_resource lists allowed parent resource types for metadata.parent_id. Leave empty to allow any type. Validation only produces warnings. Typically set on the resource message; request-level overrides are supported.
Property resource Fields annotated with this option are treated as NIDs. resource lists allowed NID resource types (prefixes). Leave empty to accept any type. Validation only produces warnings.

Inherited from Message:

Class Method get_descriptor Return the protobuf descriptor for this message class.
Class Method is_credentials Return True if the field contains credentials.
Class Method is_sensitive Return True if the field is marked as sensitive.
Method __repr__ Return a human-readable representation of the message, sanitizing sensitive fields.
Method check_presence Check explicit presence for a field in the protobuf message.
Method get_full_update_reset_mask Build a reset mask for a full update of this message.
Method get_mask Return the tracked reset mask.
Method is_default Return True if a field equals its default value.
Method set_mask Replace the tracked reset mask.
Method which_field_in_oneof Return the set field name for a given oneof.
Instance Variable __PB2_CLASS__ Protobuf message class associated with this wrapper.
Instance Variable __pb2_message__ Underlying protobuf message instance.
Method _clear_field Clear a field and record it in the reset mask.
Method _get_field Return a field value with optional wrapping and presence handling.
Method _set_field Set a field value and update the reset mask.
Class Variable __credentials_fields Undocumented
Class Variable __default Undocumented
Class Variable __sensitive_fields Undocumented
Instance Variable __recorded_reset_mask Mask tracking fields cleared or set to default.
def __dir__(self) -> abc.Iterable[builtins.str]: (source)

Undocumented

def __init__(self, initial_message: message.Message | None = None, *, resource: abc.Iterable[builtins.str] | None | unset.UnsetType = unset.Unset, parent_resource: abc.Iterable[builtins.str] | None | unset.UnsetType = unset.Unset): (source)
overrides nebius.base.protos.pb_classes.Message.__init__

Create a wrapper around a protobuf message instance.

Raises
AttributeErrorIf the wrapper is missing required class metadata.
@parent_resource.setter
def parent_resource(self, value: abc.Iterable[builtins.str] | None): (source)

Undocumented

@resource.setter
def resource(self, value: abc.Iterable[builtins.str] | None): (source)

Undocumented

__PB2_DESCRIPTOR__ = (source)
overrides nebius.base.protos.pb_classes.Message.__PB2_DESCRIPTOR__

Undocumented

Value
descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.NIDFieldSettings',
                                                   annotations_pb2.DESCRIPTOR,
                                                   descriptor_1.Descriptor)
__PY_TO_PB2__: builtins.dict[builtins.str, builtins.str] = (source)
overrides nebius.base.protos.pb_classes.Message.__PY_TO_PB2__

Undocumented

Value
{'resource': 'resource', 'parent_resource': 'parent_resource'}
__mask_functions__: dict = (source)
overrides nebius.base.protos.pb_classes.Message.__mask_functions__

Undocumented

@builtins.property
parent_resource: abc.MutableSequence[builtins.str] = (source)

For metadata fields, parent_resource lists allowed parent resource types for metadata.parent_id. Leave empty to allow any type. Validation only produces warnings. Typically set on the resource message; request-level overrides are supported.

@builtins.property
resource: abc.MutableSequence[builtins.str] = (source)

Fields annotated with this option are treated as NIDs. resource lists allowed NID resource types (prefixes). Leave empty to accept any type. Validation only produces warnings.