nebius.api.nebius.ai.v1.EndpointSpec

class documentation

class EndpointSpec(Message): (source)

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

View In Hierarchy

EndpointSpec defines a endpoint that will be run.

Method __init__ Create a message from a source message and field values.
Method args.setter Set or clear the generated args field.
Method auth_token.setter Set or clear the generated auth_token field.
Method auth_token_mysterybox_secret.setter Set or clear the generated auth_token_mysterybox_secret field.
Method container_command.setter Set or clear the generated container_command field.
Method disk.setter Set or clear the generated disk field.
Method environment_variables.setter Set or clear the generated environment_variables field.
Method image.setter Set or clear the generated image field.
Method injected_files.setter Set or clear the generated injected_files field.
Method platform.setter Set or clear the generated platform field.
Method ports.setter Set or clear the generated ports field.
Method preemptible.setter Set or clear the generated preemptible field.
Method preset.setter Set or clear the generated preset field.
Method public_ip.setter Set or clear the generated public_ip field.
Method registry_credentials.setter Set or clear the generated registry_credentials field.
Method shm_size_bytes.setter Set or clear the generated shm_size_bytes field.
Method ssh_authorized_keys.setter Set or clear the generated ssh_authorized_keys field.
Method subnet_id.setter Set or clear the generated subnet_id field.
Method volumes.setter Set or clear the generated volumes field.
Method working_dir.setter Set or clear the generated working_dir 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 args The arguments to pass to the entrypoint command.
Property auth_token Authentication token needed to access the endpoint.
Property auth_token_mysterybox_secret Secret storing the authentication token. Mutually exclusive with auth_token. Must reference a secret payload containing AUTH_TOKEN.
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 injected_files Small config files injected into the container before the user process starts. Intended for configs, not datasets. Read methods return target paths. File content is returned only by Get with view SECRET.
Property platform Compute platform that the endpoint will be run on.
Property ports Specifies the ports that the endpoint exposes.
Property preemptible Whether to use a preemptible VM for the endpoint. Preemptible VMs are cheaper but can be stopped by the platform at any time.
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 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, *, image: str | None | UnsetType = _NEBIUS_UNSET, environment_variables: Iterable[EndpointSpec__EnvironmentVariable] | None | UnsetType = _NEBIUS_UNSET, ports: Iterable[EndpointSpec__Port] | None | UnsetType = _NEBIUS_UNSET, container_command: str | None | UnsetType = _NEBIUS_UNSET, args: str | None | UnsetType = _NEBIUS_UNSET, working_dir: str | None | UnsetType = _NEBIUS_UNSET, volumes: Iterable[EndpointSpec__VolumeMount] | None | UnsetType = _NEBIUS_UNSET, registry_credentials: EndpointSpec__RegistryCredentials | None | UnsetType = _NEBIUS_UNSET, platform: str | None | UnsetType = _NEBIUS_UNSET, preset: str | None | UnsetType = _NEBIUS_UNSET, shm_size_bytes: int | None | UnsetType = _NEBIUS_UNSET, disk: EndpointSpec__DiskSpec | None | UnsetType = _NEBIUS_UNSET, subnet_id: str | None | UnsetType = _NEBIUS_UNSET, public_ip: bool | None | UnsetType = _NEBIUS_UNSET, ssh_authorized_keys: Iterable[str] | None | UnsetType = _NEBIUS_UNSET, preemptible: bool | None | UnsetType = _NEBIUS_UNSET, auth_token: str | None | UnsetType = _NEBIUS_UNSET, auth_token_mysterybox_secret: EndpointSpec__MysteryBoxSecretRef | None | UnsetType = _NEBIUS_UNSET, injected_files: Iterable[EndpointSpec__FileInjection] | None | UnsetType = _NEBIUS_UNSET): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

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

Set or clear the generated args field.

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

Set or clear the generated auth_token field.

@auth_token_mysterybox_secret.setter
def auth_token_mysterybox_secret(self, value: EndpointSpec__MysteryBoxSecretRef | None): (source)

Set or clear the generated auth_token_mysterybox_secret field.

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

Set or clear the generated container_command field.

@disk.setter
def disk(self, value: EndpointSpec__DiskSpec | None): (source)

Set or clear the generated disk field.

@environment_variables.setter
def environment_variables(self, value: Iterable[EndpointSpec__EnvironmentVariable] | None): (source)

Set or clear the generated environment_variables field.

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

Set or clear the generated image field.

@injected_files.setter
def injected_files(self, value: Iterable[EndpointSpec__FileInjection] | None): (source)

Set or clear the generated injected_files field.

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

Set or clear the generated platform field.

@ports.setter
def ports(self, value: Iterable[EndpointSpec__Port] | None): (source)

Set or clear the generated ports field.

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

Set or clear the generated preemptible field.

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

Set or clear the generated preset field.

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

Set or clear the generated public_ip field.

@registry_credentials.setter
def registry_credentials(self, value: EndpointSpec__RegistryCredentials | None): (source)

Set or clear the generated registry_credentials field.

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

Set or clear the generated shm_size_bytes field.

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

Set or clear the generated ssh_authorized_keys field.

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

Set or clear the generated subnet_id field.

@volumes.setter
def volumes(self, value: Iterable[EndpointSpec__VolumeMount] | None): (source)

Set or clear the generated volumes field.

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

Set or clear the generated working_dir field.

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

Protobuf message descriptor from the registry.

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

Fully qualified protobuf message name.

Value
'nebius.ai.v1.EndpointSpec'
__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
{'image': 'image',
 'environment_variables': 'environment_variables',
 'ports': 'ports',
 'container_command': 'container_command',
 'args': 'args',
 'working_dir': 'working_dir',
 'volumes': 'volumes',
...
@_NebiusProperty
args: str = (source)

The arguments to pass to the entrypoint command.

@_NebiusProperty
auth_token: str = (source)

Authentication token needed to access the endpoint.

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

Mutually exclusive with auth_token_mysterybox_secret. If not provided, authentication will be disabled.

@_NebiusProperty
auth_token_mysterybox_secret: EndpointSpec__MysteryBoxSecretRef = (source)

Secret storing the authentication token. Mutually exclusive with auth_token. Must reference a secret payload containing AUTH_TOKEN.

@_NebiusProperty
container_command: str = (source)

The entrypoint command for the endpoint's container.

@_NebiusProperty
disk: EndpointSpec__DiskSpec = (source)

Disk spec for the main disk of the endpoint.

@_NebiusProperty
environment_variables: MutableSequence[EndpointSpec__EnvironmentVariable] = (source)

Specifies the environment variables for the endpoint's container.

@_NebiusProperty
image: str = (source)

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

@_NebiusProperty
injected_files: MutableSequence[EndpointSpec__FileInjection] = (source)

Small config files injected into the container before the user process starts. Intended for configs, not datasets. Read methods return target paths. File content is returned only by Get with view SECRET.

@_NebiusProperty
platform: str = (source)

Compute platform that the endpoint will be run on.

@_NebiusProperty
ports: MutableSequence[EndpointSpec__Port] = (source)

Specifies the ports that the endpoint exposes.

@_NebiusProperty
preemptible: bool = (source)

Whether to use a preemptible VM for the endpoint. Preemptible VMs are cheaper but can be stopped by the platform at any time.

@_NebiusProperty
preset: str = (source)

Compute preset that the endpoint will be run on.

@_NebiusProperty
public_ip: bool = (source)

Whether to assign a public IP to the endpoint.

@_NebiusProperty
registry_credentials: EndpointSpec__RegistryCredentials = (source)

Registry credentials for private Docker registry.

@_NebiusProperty
shm_size_bytes: int = (source)

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

@_NebiusProperty
ssh_authorized_keys: MutableSequence[str] = (source)

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

@_NebiusProperty
subnet_id: str = (source)

Subnet ID where the endpoint will be deployed.

@_NebiusProperty
volumes: MutableSequence[EndpointSpec__VolumeMount] = (source)

Volumes to be mounted into the endpoint's container.

@_NebiusProperty
working_dir: str = (source)

The working directory for the endpoint's container.