package documentation

Python SDK types generated from Nebius API descriptors.

Package compiler Python SDK types generated from Nebius API descriptors.

From __init__.py:

Class Any Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Class Api Api is a light-weight descriptor for an API Interface.
Class BoolValue Wrapper message for bool.
Class BytesValue Wrapper message for bytes.
Class DescriptorProto Describes a message type.
Class DoubleValue Wrapper message for double.
Class Duration A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month"...
Class Edition The full set of known editions.
Class Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
Class Enum Enum type definition.
Class EnumDescriptorProto Describes an enum type.
Class EnumOptions No class docstring; 5/5 properties, 6/6 methods documented
Class EnumValue Enum value definition.
Class EnumValueDescriptorProto Describes a value within an enum.
Class EnumValueOptions No class docstring; 5/5 properties, 6/6 methods documented
Class ExtensionRangeOptions No class docstring; 4/4 properties, 5/5 methods, 1/2 class documented
Class FeatureSet not well scoped. This means that each of the feature enums below can clash with each other. The short names we've chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.
Class FeatureSetDefaults A compiled specification for the defaults of a set of features. These messages are generated from FeatureSet extensions and can be used to seed feature resolution. The resolution with this object becomes a simple search for the closest matching edition, followed by proto merges.
Class Field A single field of a message type.
Class FieldDescriptorProto Describes a field within a message.
Class FieldMask FieldMask represents a set of symbolic field paths, for example:
Class FieldOptions No class docstring; 10/14 properties, 15/15 methods, 3/6 classes documented
Class FileDescriptorProto Describes a complete .proto file.
Class FileDescriptorSet The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.
Class FileOptions Each of the definitions above may have "options" attached. These are just annotations which may cause code to be generated slightly differently or may contain hints for code that manipulates protocol messages.
Class FloatValue Wrapper message for float.
Class GeneratedCodeInfo Describes the relationship between generated code and its original source file. A GeneratedCodeInfo message is associated with only one generated source file, but may contain references to different source...
Class Int32Value Wrapper message for int32.
Class Int64Value Wrapper message for int64.
Class ListValue ListValue is a wrapper around a repeated field of values.
Class MessageOptions No class docstring; 7/7 properties, 8/8 methods documented
Class Method Method represents a method of an API interface.
Class MethodDescriptorProto Describes a method of a service.
Class MethodOptions No class docstring; 3/4 properties, 5/5 methods, 1/1 class documented
Class Mixin Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:
Class NullValue NullValue is a singleton enumeration to represent the null value for the Value type union.
Class OneofDescriptorProto Describes a oneof.
Class OneofOptions No class docstring; 2/2 properties, 3/3 methods documented
Class Option A protocol buffer option, which can be attached to a message, field, enumeration, etc.
Class ServiceDescriptorProto Describes a service.
Class ServiceOptions No class docstring; 3/3 properties, 4/4 methods documented
Class SourceCodeInfo Encapsulates information about the original source file from which a FileDescriptorProto was generated.
Class SourceContext SourceContext represents information about the source of a protobuf element, like the file in which it is defined.
Class StringValue Wrapper message for string.
Class Struct Struct represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object...
Class SymbolVisibility Describes the 'visibility' of a symbol with respect to the proto import system. Symbols can only be imported when the visibility rules do not prevent it (ex: local symbols cannot be imported). Visibility modifiers can only set on ...
Class Syntax The syntax in which a protocol buffer element is defined.
Class Timestamp A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
Class Type A protocol buffer message type.
Class UInt32Value Wrapper message for uint32.
Class UInt64Value Wrapper message for uint64.
Class UninterpretedOption A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class. DescriptorPool resolves these when building Descriptor objects. ...
Class Value Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants...
Variable DescriptorProto__ExtensionRange Undocumented
Variable DescriptorProto__ReservedRange Range of reserved tag numbers. Reserved tag numbers may not be used by fields or extension ranges in the same message. Reserved ranges may not overlap.
Variable EnumDescriptorProto__EnumReservedRange Range of reserved numeric values. Reserved values may not be used by entries in the same enum. Reserved ranges may not overlap.
Variable ExtensionRangeOptions__Declaration Undocumented
Variable ExtensionRangeOptions__VerificationState The verification state of the extension range.
Variable FeatureSet__EnforceNamingStyle Undocumented
Variable FeatureSet__EnumType Undocumented
Variable FeatureSet__FieldPresence Undocumented
Variable FeatureSet__JsonFormat Undocumented
Variable FeatureSet__MessageEncoding Undocumented
Variable FeatureSet__RepeatedFieldEncoding Undocumented
Variable FeatureSet__Utf8Validation Undocumented
Variable FeatureSet__VisibilityFeature Undocumented
Variable FeatureSet__VisibilityFeature__DefaultSymbolVisibility Undocumented
Variable FeatureSetDefaults__FeatureSetEditionDefault A map from every known edition with a unique set of defaults to its defaults. Not all editions may be contained here. For a given edition, the defaults at the closest matching edition ordered at or before it should be used...
Variable Field__Cardinality Whether a field is optional, required, or repeated.
Variable Field__Kind Basic field types.
Variable FieldDescriptorProto__Label Undocumented
Variable FieldDescriptorProto__Type Undocumented
Variable FieldOptions__CType Undocumented
Variable FieldOptions__EditionDefault Undocumented
Variable FieldOptions__FeatureSupport Information about the support window of a feature.
Variable FieldOptions__JSType Undocumented
Variable FieldOptions__OptionRetention If set to RETENTION_SOURCE, the option will be omitted from the binary.
Variable FieldOptions__OptionTargetType This indicates the types of entities that the field may apply to when used as an option. If it is unset, then the field may be freely used as an option on any kind of entity.
Variable FileOptions__OptimizeMode Generated classes can be optimized for speed or code size.
Variable GeneratedCodeInfo__Annotation Undocumented
Variable GeneratedCodeInfo__Annotation__Semantic Represents the identified object's effect on the element in the original .proto file.
Variable MethodOptions__IdempotencyLevel Is this method side-effect-free (or safe in HTTP parlance), or idempotent, or neither? HTTP based RPC implementation may choose GET verb for safe methods, and PUT verb for idempotent methods instead of the default POST.
Variable SourceCodeInfo__Location Undocumented
Variable UninterpretedOption__NamePart The name of the uninterpreted option. Each string represents a segment in a dot-separated name. is_extension is true iff a segment represents an extension (denoted with parentheses in options specs in...
DescriptorProto__ExtensionRange = (source)

Undocumented

DescriptorProto__ReservedRange = (source)

Range of reserved tag numbers. Reserved tag numbers may not be used by fields or extension ranges in the same message. Reserved ranges may not overlap.

EnumDescriptorProto__EnumReservedRange = (source)

Range of reserved numeric values. Reserved values may not be used by entries in the same enum. Reserved ranges may not overlap.

Note that this is distinct from DescriptorProto.ReservedRange in that it is inclusive such that it can appropriately represent the entire int32 domain.

ExtensionRangeOptions__Declaration = (source)

Undocumented

ExtensionRangeOptions__VerificationState = (source)

The verification state of the extension range.

FeatureSet__EnforceNamingStyle = (source)

Undocumented

FeatureSet__EnumType = (source)

Undocumented

FeatureSet__FieldPresence = (source)

Undocumented

FeatureSet__JsonFormat = (source)

Undocumented

FeatureSet__MessageEncoding = (source)

Undocumented

FeatureSet__RepeatedFieldEncoding = (source)

Undocumented

FeatureSet__Utf8Validation = (source)

Undocumented

FeatureSet__VisibilityFeature = (source)

Undocumented

FeatureSet__VisibilityFeature__DefaultSymbolVisibility = (source)

Undocumented

FeatureSetDefaults__FeatureSetEditionDefault = (source)

A map from every known edition with a unique set of defaults to its defaults. Not all editions may be contained here. For a given edition, the defaults at the closest matching edition ordered at or before it should be used. This field must be in strict ascending order by edition.

Field__Cardinality = (source)

Whether a field is optional, required, or repeated.

Field__Kind = (source)

Basic field types.

FieldDescriptorProto__Label = (source)

Undocumented

FieldDescriptorProto__Type = (source)

Undocumented

FieldOptions__CType = (source)

Undocumented

FieldOptions__EditionDefault = (source)

Undocumented

FieldOptions__FeatureSupport = (source)

Information about the support window of a feature.

FieldOptions__JSType = (source)

Undocumented

FieldOptions__OptionRetention = (source)

If set to RETENTION_SOURCE, the option will be omitted from the binary.

FieldOptions__OptionTargetType = (source)

This indicates the types of entities that the field may apply to when used as an option. If it is unset, then the field may be freely used as an option on any kind of entity.

FileOptions__OptimizeMode = (source)

Generated classes can be optimized for speed or code size.

GeneratedCodeInfo__Annotation = (source)

Undocumented

GeneratedCodeInfo__Annotation__Semantic = (source)

Represents the identified object's effect on the element in the original .proto file.

MethodOptions__IdempotencyLevel = (source)

Is this method side-effect-free (or safe in HTTP parlance), or idempotent, or neither? HTTP based RPC implementation may choose GET verb for safe methods, and PUT verb for idempotent methods instead of the default POST.

SourceCodeInfo__Location = (source)

Undocumented

UninterpretedOption__NamePart = (source)

The name of the uninterpreted option. Each string represents a segment in a dot-separated name. is_extension is true iff a segment represents an extension (denoted with parentheses in options specs in .proto files). E.g.,{ ["foo", false], ["bar.baz", true], ["moo", false] } represents "foo.(bar.baz).moo".