nebius.api.nebius.ai.v1.EndpointSpec

class documentation

class EndpointSpec(pb_classes.Message): (source)

Constructor: EndpointSpec(initial_message, image, environment_variables, ports, ...)

EndpointSpec defines a endpoint that will be run.

Class	`DiskSpec`	No class docstring; 2/2 properties, 0/1 class variable, 0/2 constant, 0/4 method documented
Class	`EnvironmentVariable`	EnvironmentVariable defines an environment variable for the endpoint's container.
Class	`Port`	No class docstring; 3/3 properties, 0/1 class variable, 0/2 constant, 0/5 method, 1/1 class documented
Class	`RegistryCredentials`	No class docstring; 3/3 properties, 0/1 class variable, 0/2 constant, 0/5 method documented
Class	`VolumeMount`	VolumeMount represents a volume mount for the endpoint's container.
Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`args.setter`	Undocumented
Method	`auth_token.setter`	Undocumented
Method	`container_command.setter`	Undocumented
Method	`disk.setter`	Undocumented
Method	`environment_variables.setter`	Undocumented
Method	`image.setter`	Undocumented
Method	`platform.setter`	Undocumented
Method	`ports.setter`	Undocumented
Method	`preset.setter`	Undocumented
Method	`public_ip.setter`	Undocumented
Method	`registry_credentials.setter`	Undocumented
Method	`shm_size_bytes.setter`	Undocumented
Method	`ssh_authorized_keys.setter`	Undocumented
Method	`subnet_id.setter`	Undocumented
Method	`volumes.setter`	Undocumented
Method	`working_dir.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
Property	`args`	The arguments to pass to the entrypoint command.
Property	`auth_token`	Authentication token needed to access the endpoint.
Property	`container_command`	The entrypoint command for the endpoint's container.
Property	`disk`	Disk spec for the main disk of the endpoint.
Property	`environment_variables`	Specifies the environment variables for the endpoint's container.
Property	`image`	The Docker image to use for the endpoint's container.
Property	`platform`	Compute platform that the endpoint will be run on.
Property	`ports`	Specifies the ports that the endpoint exposes.
Property	`preset`	Compute preset that the endpoint will be run on.
Property	`public_ip`	Whether to assign a public IP to the endpoint.
Property	`registry_credentials`	Registry credentials for private Docker registry.
Property	`shm_size_bytes`	Shared memory size in bytes for the endpoint's container.
Property	`ssh_authorized_keys`	Public keys to be authorized for SSH access to the job.
Property	`subnet_id`	Subnet ID where the endpoint will be deployed.
Property	`volumes`	Volumes to be mounted into the endpoint's container.
Property	`working_dir`	The working directory for the endpoint's container.

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

overrides nebius.base.protos.pb_classes.Message.__init__

Create a wrapper around a protobuf message instance.

Raises
`AttributeError`	If the wrapper is missing required class metadata.

@args.setter
def args(self, value: builtins.str | None): (source) ¶

Undocumented

@auth_token.setter
def auth_token(self, value: builtins.str | None): (source) ¶

Undocumented

@container_command.setter
def container_command(self, value: builtins.str | None): (source) ¶

Undocumented

@disk.setter
def disk(self, value: EndpointSpec.DiskSpec | endpoint_pb2.EndpointSpec.DiskSpec | None): (source) ¶

Undocumented

@environment_variables.setter
def environment_variables(self, value: abc.Iterable[EndpointSpec.EnvironmentVariable] | None): (source) ¶

Undocumented

@image.setter
def image(self, value: builtins.str | None): (source) ¶

Undocumented

@platform.setter
def platform(self, value: builtins.str | None): (source) ¶

Undocumented

@ports.setter
def ports(self, value: abc.Iterable[EndpointSpec.Port] | None): (source) ¶

Undocumented

@preset.setter
def preset(self, value: builtins.str | None): (source) ¶

Undocumented

@public_ip.setter
def public_ip(self, value: builtins.bool | None): (source) ¶

Undocumented

@registry_credentials.setter
def registry_credentials(self, value: EndpointSpec.RegistryCredentials | endpoint_pb2.EndpointSpec.RegistryCredentials | None): (source) ¶

Undocumented

@shm_size_bytes.setter
def shm_size_bytes(self, value: builtins.int | None): (source) ¶

Undocumented

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

Undocumented

@subnet_id.setter
def subnet_id(self, value: builtins.str | None): (source) ¶

Undocumented

@volumes.setter
def volumes(self, value: abc.Iterable[EndpointSpec.VolumeMount] | None): (source) ¶

Undocumented

@working_dir.setter
def working_dir(self, value: 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.ai.v1.EndpointSpec',
                                                   endpoint_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

{'image': 'image',
 'environment_variables': 'environment_variables',
 'ports': 'ports',
 'container_command': 'container_command',
 'args': 'args',
 'working_dir': 'working_dir',
 'volumes': 'volumes',
...

__mask_functions__: dict = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__mask_functions__

Undocumented

@builtins.property
args: builtins.str = (source) ¶

The arguments to pass to the entrypoint command.

@builtins.property
auth_token: builtins.str = (source) ¶

Authentication token needed to access the endpoint.

Authentication can only be enabled if the endpoint exposes one and only one HTTP port.

If not provided, a authentication will be disabled.

@builtins.property
container_command: builtins.str = (source) ¶

The entrypoint command for the endpoint's container.

@builtins.property
disk: EndpointSpec.DiskSpec = (source) ¶

Disk spec for the main disk of the endpoint.

@builtins.property
environment_variables: abc.MutableSequence[EndpointSpec.EnvironmentVariable] = (source) ¶

Specifies the environment variables for the endpoint's container.

@builtins.property
image: builtins.str = (source) ¶

The Docker image to use for the endpoint's container.

@builtins.property
platform: builtins.str = (source) ¶

Compute platform that the endpoint will be run on.

@builtins.property
ports: abc.MutableSequence[EndpointSpec.Port] = (source) ¶

Specifies the ports that the endpoint exposes.

@builtins.property
preset: builtins.str = (source) ¶

Compute preset that the endpoint will be run on.

@builtins.property
public_ip: builtins.bool = (source) ¶

Whether to assign a public IP to the endpoint.

@builtins.property
registry_credentials: EndpointSpec.RegistryCredentials = (source) ¶

Registry credentials for private Docker registry.

@builtins.property
shm_size_bytes: builtins.int = (source) ¶

Shared memory size in bytes for the endpoint's container.

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

Public keys to be authorized for SSH access to the job.

@builtins.property
subnet_id: builtins.str = (source) ¶

Subnet ID where the endpoint will be deployed.

@builtins.property
volumes: abc.MutableSequence[EndpointSpec.VolumeMount] = (source) ¶

Volumes to be mounted into the endpoint's container.

@builtins.property
working_dir: builtins.str = (source) ¶

The working directory for the endpoint's container.