nebius.api.nebius.applications.v1alpha1.ContainerDefinition

class documentation

class ContainerDefinition(Message): (source)

Constructor: ContainerDefinition(initial_message, name, image, environment_variables, ...)

View In Hierarchy

ContainerDefinition defines a container that will be run on the VM.

Class __OneOfClass_gpu__ GPU configuration for the container. If not specified, the container will not have access to GPUs. Ignored if the compute instance does not have GPUs.
Class __OneOfClass_gpu_all_gpus__ If true, all available GPUs will be allocated to the container.
Class __OneOfClass_gpu_gpu_count__ The number of GPUs to allocate to the container.
Class InjectedFile InjectedFile is a small file materialized inside the container at launch.
Class Port Port defines a port that is exposed by the container.
Class RestartPolicy No class docstring; 4/4 constants documented
Class User No class docstring; 2/2 properties, 3/3 methods documented
Class Volume Volume defines a volume that will be mounted into the container.
Method __init__ Create a message from a source message and field values.
Method all_gpus.setter Set or clear the generated all_gpus field.
Method command.setter Set or clear the generated command field.
Method entrypoint.setter Set or clear the generated entrypoint field.
Method environment_variables.setter Set or clear the generated environment_variables field.
Method export_logs.setter Set or clear the generated export_logs field.
Method gpu_count.setter Set or clear the generated gpu_count field.
Method host_ipc.setter Set or clear the generated host_ipc field.
Method host_network.setter Set or clear the generated host_network field.
Method image.setter Set or clear the generated image field.
Method injected_files.setter Set or clear the generated injected_files field.
Method max_attempts.setter Set or clear the generated max_attempts field.
Method name.setter Set or clear the generated name field.
Method ports.setter Set or clear the generated ports field.
Method privileged.setter Set or clear the generated privileged field.
Method registry_password.setter Set or clear the generated registry_password field.
Method registry_username.setter Set or clear the generated registry_username field.
Method restart_policy.setter Set or clear the generated restart_policy field.
Method runtime_user.setter Set or clear the generated runtime_user field.
Method shm_size_bytes.setter Set or clear the generated shm_size_bytes field.
Method volumes.setter Set or clear the generated volumes field.
Method working_dir.setter Set or clear the generated working_dir field.
Property all_gpus If true, all available GPUs will be allocated to the container.
Property command The command for the container in shell-string format. If not specified, the default entrypoint from the image will be used.
Property entrypoint The entrypoint for the container.
Property environment_variables Specifies the environment variables for the container.
Property export_logs Enables logs export to Nebius Observability.
Property gpu GPU configuration for the container. If not specified, the container will not have access to GPUs. Ignored if the compute instance does not have GPUs.
Property gpu_count The number of GPUs to allocate to the container.
Property host_ipc Enables host IPC namespace sharing.
Property host_network Enables host network namespace sharing.
Property image The Docker image to use for the container.
Property injected_files Small files materialized inside the container before it starts.
Property max_attempts The maximum number of restart attempts for the ON_FAILURE restart policy. If absent or zero, restarts have no limit. A positive value limits the number of restarts. Other restart policies ignore this field...
Property name The name of the container. This name is should be unique within the VM app. If not specified, it will be generated based on the image name.
Property ports Specifies the ports that the container exposes.
Property privileged If true, the container will be run in privileged mode.
Property registry_password The docker registry password to configure for the container.
Property registry_username The docker registry username to configure for the container.
Property restart_policy The restart policy for the container. If not specified, the default policy is "always".
Property runtime_user The user to run the container as.
Property shm_size_bytes Shared memory size in bytes.
Property volumes The volume to be mounted into the container.
Property working_dir The working directory for the 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 __DEPRECATION_DETAILS__ Undocumented
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 __PROTO_DESCRIPTOR__ Message descriptor from the registry.
Constant __PY_TO_PB2__ Mapping from Python names to protobuf names.
Constant __REGISTRY__ Registry for the message and its descriptor.
Class Variable __PROTO_FULL_NAME__ Fully qualified protobuf message name.
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 _initialize Initialize message state, optionally suppressing generated warnings.
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, *, name: str | None | UnsetType = ..., image: str | None | UnsetType = ..., environment_variables: Iterable[EnvironmentVariable] | None | UnsetType = ..., ports: Iterable[Port] | None | UnsetType = ..., volumes: Iterable[Volume] | None | UnsetType = ..., command: str | None | UnsetType = ..., shm_size_bytes: int | None | UnsetType = ..., runtime_user: User | None | UnsetType = ..., working_dir: str | None | UnsetType = ..., privileged: bool | None | UnsetType = ..., entrypoint: str | None | UnsetType = ..., restart_policy: RestartPolicy | None | UnsetType = ..., max_attempts: int | None | UnsetType = ..., host_ipc: bool | None | UnsetType = ..., host_network: bool | None | UnsetType = ..., export_logs: bool | None | UnsetType = ..., gpu_count: int | None | UnsetType = ..., all_gpus: bool | None | UnsetType = ..., registry_username: str | None | UnsetType = ..., registry_password: str | None | UnsetType = ..., injected_files: Iterable[InjectedFile] | None | UnsetType = ...): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

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

Set or clear the generated all_gpus field.

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

Set or clear the generated command field.

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

Set or clear the generated entrypoint field.

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

Set or clear the generated environment_variables field.

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

Set or clear the generated export_logs field.

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

Set or clear the generated gpu_count field.

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

Set or clear the generated host_ipc field.

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

Set or clear the generated host_network 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[InjectedFile] | None): (source)

Set or clear the generated injected_files field.

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

Set or clear the generated max_attempts field.

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

Set or clear the generated name field.

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

Set or clear the generated ports field.

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

Set or clear the generated privileged field.

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

Set or clear the generated registry_password field.

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

Set or clear the generated registry_username field.

@restart_policy.setter
def restart_policy(self, value: RestartPolicy | None): (source)

Set or clear the generated restart_policy field.

@runtime_user.setter
def runtime_user(self, value: User | None): (source)

Set or clear the generated runtime_user field.

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

Set or clear the generated shm_size_bytes field.

@volumes.setter
def volumes(self, value: Iterable[Volume] | 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.

@property
all_gpus: bool | None = (source)

If true, all available GPUs will be allocated to the container.

@property
command: str = (source)

The command for the container in shell-string format. If not specified, the default entrypoint from the image will be used.

@property
entrypoint: str = (source)

The entrypoint for the container.

@property
environment_variables: MutableSequence[EnvironmentVariable] = (source)

Specifies the environment variables for the container.

@property
export_logs: bool = (source)

Enables logs export to Nebius Observability.

@property
gpu: __OneOfClass_gpu_gpu_count__ | __OneOfClass_gpu_all_gpus__ | None = (source)

GPU configuration for the container. If not specified, the container will not have access to GPUs. Ignored if the compute instance does not have GPUs.

@property
gpu_count: int | None = (source)

The number of GPUs to allocate to the container.

@property
host_ipc: bool = (source)

Enables host IPC namespace sharing.

@property
host_network: bool = (source)

Enables host network namespace sharing.

@property
image: str = (source)

The Docker image to use for the container.

@property
injected_files: MutableSequence[InjectedFile] = (source)

Small files materialized inside the container before it starts.

@property
max_attempts: int | None = (source)

The maximum number of restart attempts for the ON_FAILURE restart policy. If absent or zero, restarts have no limit. A positive value limits the number of restarts. Other restart policies ignore this field. Devlab templates must omit it.

@property
name: str = (source)

The name of the container. This name is should be unique within the VM app. If not specified, it will be generated based on the image name.

@property
ports: MutableSequence[Port] = (source)

Specifies the ports that the container exposes.

@property
privileged: bool = (source)

If true, the container will be run in privileged mode.

@property
registry_password: str = (source)

The docker registry password to configure for the container.

@property
registry_username: str = (source)

The docker registry username to configure for the container.

@property
restart_policy: RestartPolicy = (source)

The restart policy for the container. If not specified, the default policy is "always".

@property
runtime_user: User = (source)

The user to run the container as.

@property
shm_size_bytes: int = (source)

Shared memory size in bytes.

@property
volumes: MutableSequence[Volume] = (source)

The volume to be mounted into the container.

@property
working_dir: str = (source)

The working directory for the container.