nebius.api.nebius

package documentation
(source)

Python SDK types generated from Nebius API descriptors.

Package ai No package docstring; 1/1 package documented
Package applications No package docstring; 1/1 package documented
Package audit No package docstring; 1/1 package documented
Package billing No package docstring; 2/2 packages documented
Package capacity No package docstring; 1/1 package documented
Package common No package docstring; 2/3 packages documented
Package compute No package docstring; 1/1 package documented
Package dns No package docstring; 1/1 package documented
Package iam No package docstring; 2/2 packages documented
Package kms No package docstring; 1/1 package documented
Package logging No package docstring; 1/2 package documented
Package maintenance No package docstring; 1/1 package documented
Package mk8s No package docstring; 2/2 packages documented
Package msp No package docstring; 1/4 package documented
Package mysterybox No package docstring; 1/1 package documented
Package quotas No package docstring; 1/1 package documented
Package registry No package docstring; 1/1 package documented
Package storage No package docstring; 2/2 packages documented
Package tunnel No package docstring; 1/1 package documented
Package vpc No package docstring; 2/2 packages documented

From __init__.py:

Class DeprecationDetails No class docstring; 3/3 properties, 4/4 methods documented
Class EnumPySDKSettings No class docstring; 0/1 property, 2/2 methods documented
Class EnumValuePySDKSettings No class docstring; 0/1 property, 2/2 methods documented
Class FieldBehavior No class docstring; 7/8 constants documented
Class FieldPySDKSettings No class docstring; 0/1 property, 2/2 methods documented
Class MessagePySDKSettings No class docstring; 0/1 property, 2/2 methods documented
Class MethodBehavior MethodBehavior describes special behaviors of a method that affect code generation and tooling.
Class MethodPySDKSettings No class docstring; 0/1 property, 2/2 methods documented
Class NIDFieldSettings No class docstring; 2/2 properties, 3/3 methods documented
Class OneofPySDKSettings No class docstring; 0/1 property, 2/2 methods documented
Class ResourceBehavior No class docstring; 4/4 constants documented
Class ServicePySDKSettings No class docstring; 0/1 property, 2/2 methods documented
Class SubfieldSettings 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.
Variable api_service_name Specifies the domain prefix for the service endpoint. For example, option (api_service_name) = "compute"; makes the service accessible at compute.api.nebius.cloud:443.
Variable credentials Credentials field is masked access tokens/jwt/session from the message while logging, storing in DB and on all others persistent layers
Variable enum_deprecation_details Contains additional information about the planned deprecation of an enum. Used along with option deprecated = true.
Variable enum_py_sdk Undocumented
Variable enum_value_deprecation_details Contains additional information about the planned deprecation of enum value. Used along with [deprecated = true].
Variable enum_value_py_sdk Undocumented
Variable field_behavior Field behavior describes how the field behaves on input or output.
Variable field_deprecation_details Contains additional information about the planned deprecation of a field. Used along with [deprecated = true].
Variable field_py_sdk Undocumented
Variable file_deprecation_details Contains additional information about the planned deprecation of a file. Used along with option deprecated = true.
Variable message_deprecation_details Contains additional information about the planned deprecation of a message. Used along with option deprecated = true.
Variable message_py_sdk Undocumented
Variable method_behavior method_behavior describes how the method behaves, if its behavior differs from the default one.
Variable method_deprecation_details Contains additional information about the planned deprecation of a method. Used along with option deprecated = true.
Variable method_py_sdk Undocumented
Variable nid Field NID settings for fields annotated with this option. When present on string fields (including lists and maps), values are treated as NIDs and warnings are emitted when they are not valid. These warnings are separate from server-side validation.
Variable oneof_behavior Field behavior describes how oneof behaves on input or output.
Variable oneof_py_sdk Undocumented
Variable request_fields Overrides for some settings for fields of this method's input.
Variable resource_behavior Undocumented
Variable sensitive Sensitive field is masked/removed from the message while logging, storing in DB and on all others persistent layers (except specialized storage like PDS).
Variable service_deprecation_details Contains additional information about the planned deprecation of a service. Used along with option deprecated = true.
Variable service_py_sdk Undocumented
Variable subfield_settings Overrides for some settings for subfields of this field.
api_service_name: Extension[str] = (source)

Specifies the domain prefix for the service endpoint. For example, option (api_service_name) = "compute"; makes the service accessible at compute.api.nebius.cloud:443.

credentials: Extension[bool] = (source)

Credentials field is masked access tokens/jwt/session from the message while logging, storing in DB and on all others persistent layers

enum_deprecation_details: Extension[DeprecationDetails] = (source)

Contains additional information about the planned deprecation of an enum. Used along with option deprecated = true.

enum_py_sdk: Extension[EnumPySDKSettings] = (source)

Undocumented

enum_value_deprecation_details: Extension[DeprecationDetails] = (source)

Contains additional information about the planned deprecation of enum value. Used along with [deprecated = true].

enum_value_py_sdk: Extension[EnumValuePySDKSettings] = (source)

Undocumented

field_behavior: Extension[MutableSequence[FieldBehavior]] = (source)

Field behavior describes how the field behaves on input or output.

field_deprecation_details: Extension[DeprecationDetails] = (source)

Contains additional information about the planned deprecation of a field. Used along with [deprecated = true].

field_py_sdk: Extension[FieldPySDKSettings] = (source)

Undocumented

file_deprecation_details: Extension[DeprecationDetails] = (source)

Contains additional information about the planned deprecation of a file. Used along with option deprecated = true.

message_deprecation_details: Extension[DeprecationDetails] = (source)

Contains additional information about the planned deprecation of a message. Used along with option deprecated = true.

message_py_sdk: Extension[MessagePySDKSettings] = (source)

Undocumented

method_behavior: Extension[MutableSequence[MethodBehavior]] = (source)

method_behavior describes how the method behaves, if its behavior differs from the default one.

For example, it can be used to specify that the method is an update method, so the reset mask will be sent by default, or that the method is a delete method, so the CLI will not get the resource after the operation is done.

Set the value to METHOD_BEHAVIOR_UNSPECIFIED to clear any special behavior that might be inferred from the method name or other annotations.

Read MethodBehavior enum for more details and examples.

method_deprecation_details: Extension[DeprecationDetails] = (source)

Contains additional information about the planned deprecation of a method. Used along with option deprecated = true.

method_py_sdk: Extension[MethodPySDKSettings] = (source)

Undocumented

nid: Extension[NIDFieldSettings] = (source)

Field NID settings for fields annotated with this option. When present on string fields (including lists and maps), values are treated as NIDs and warnings are emitted when they are not valid. These warnings are separate from server-side validation.

For metadata fields, this describes which parent resource types are allowed in metadata.parent_id. For string fields, this describes which resource types are allowed in the NID itself. See NIDFieldSettings for more details.

oneof_behavior: Extension[MutableSequence[FieldBehavior]] = (source)

Field behavior describes how oneof behaves on input or output.

oneof_py_sdk: Extension[OneofPySDKSettings] = (source)

Undocumented

request_fields: Extension[MutableSequence[SubfieldSettings]] = (source)

Overrides for some settings for fields of this method's input.

resource_behavior: Extension[MutableSequence[ResourceBehavior]] = (source)

Undocumented

sensitive: Extension[bool] = (source)

Sensitive field is masked/removed from the message while logging, storing in DB and on all others persistent layers (except specialized storage like PDS).

service_deprecation_details: Extension[DeprecationDetails] = (source)

Contains additional information about the planned deprecation of a service. Used along with option deprecated = true.

service_py_sdk: Extension[ServicePySDKSettings] = (source)

Undocumented

subfield_settings: Extension[MutableSequence[SubfieldSettings]] = (source)

Overrides for some settings for subfields of this field.