nebius.api.nebius.common.v1.ProgressTracker

class documentation

class ProgressTracker(pb_classes.Message): (source)

Constructor: ProgressTracker(initial_message, description, started_at, estimated_finished_at, ...)

Information for tracking the progress of a task (e.g., an API operation or background maintenance action). This serves as a UI contract and may be directly reflected in CLI, Console, and other tools.

Class	`Step`	Represents a basic step in the task. Fields are binary-compatible with ProgressTracker for easier processing.
Class	`WorkDone`	Information about the work done by the task or its step, expressed in ticks (abstract work units). Each tick may represent a real measurement (e.g., VMs created, KiB uploaded), number of substeps or a percentage of work completed.
Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`description.setter`	Undocumented
Method	`estimated_finished_at.setter`	Undocumented
Method	`finished_at.setter`	Undocumented
Method	`started_at.setter`	Undocumented
Method	`steps.setter`	Undocumented
Method	`work_done.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
Property	`description`	Human-readable description of the currently executing task, e.g., "Downloading dat-groot-llm.tar.xz". Relates to the overall task, not individual steps. SHOULD match the Operation's `description` field when this ProgressTracker tracks an API Operation's progress...
Property	`estimated_finished_at`	Estimated completion timestamp for the task. MUST be absent if the task is completed (i.e., finished_at is set). MAY be absent if the estimate is unknown. MAY be updated as the progress estimate changes.
Property	`finished_at`	Completion timestamp of the task. MUST be absent for running tasks; MUST be present for completed tasks. MUST match the operation's finished_at timestamp when tracking an API Operation's progress.
Property	`started_at`	Timestamp when the overall task started. MUST match the operation's created_at timestamp when tracking an API Operation's progress.
Property	`steps`	Detailed information about the task steps that are currently running or have been finished.
Property	`work_done`	Overall work progress details. MAY be absent if unknown.

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.

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

Undocumented

@estimated_finished_at.setter
def estimated_finished_at(self, value: timestamp_pb2.Timestamp | datetime.datetime | None): (source) ¶

Undocumented

@finished_at.setter
def finished_at(self, value: timestamp_pb2.Timestamp | datetime.datetime | None): (source) ¶

Undocumented

@started_at.setter
def started_at(self, value: timestamp_pb2.Timestamp | datetime.datetime | None): (source) ¶

Undocumented

@steps.setter
def steps(self, value: abc.Iterable[ProgressTracker.Step] | None): (source) ¶

Undocumented

@work_done.setter
def work_done(self, value: ProgressTracker.WorkDone | progress_tracker_pb2.ProgressTracker.WorkDone | None): (source) ¶

Undocumented

__PB2_DESCRIPTOR__ = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PB2_DESCRIPTOR__

Undocumented

Value

descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.common.v1.ProgressTr↵
acker',
                                                   progress_tracker_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

{'description': 'description',
 'started_at': 'started_at',
 'estimated_finished_at': 'estimated_finished_at',
 'finished_at': 'finished_at',
 'work_done': 'work_done',
 'steps': 'steps',
 'WorkDone': 'WorkDone',
...

__mask_functions__ = (source) ¶

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

Undocumented

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

Human-readable description of the currently executing task, e.g., "Downloading dat-groot-llm.tar.xz". Relates to the overall task, not individual steps. SHOULD match the Operation's description field when this ProgressTracker tracks an API Operation's progress. MAY provide more detailed overall information.

MUST be suitable for display to public users. Even if the task is internal, this description may be shown to end users in overall task step descriptions.

For individual step descriptions, use Step.description.

@builtins.property
estimated_finished_at: datetime.datetime = (source) ¶

Estimated completion timestamp for the task. MUST be absent if the task is completed (i.e., finished_at is set). MAY be absent if the estimate is unknown. MAY be updated as the progress estimate changes.

@builtins.property
finished_at: datetime.datetime = (source) ¶

Completion timestamp of the task. MUST be absent for running tasks; MUST be present for completed tasks. MUST match the operation's finished_at timestamp when tracking an API Operation's progress.

@builtins.property
started_at: datetime.datetime = (source) ¶

Timestamp when the overall task started. MUST match the operation's created_at timestamp when tracking an API Operation's progress.

@builtins.property
steps: abc.MutableSequence[ProgressTracker.Step] = (source) ¶

Detailed information about the task steps that are currently running or have been finished.

For a completed task, the step list MUST either be empty or contain finished steps only.
For a running task, the step list MAY be empty if the task consists of a single step or no detailed information is available. A non-empty step list MUST include all currently running steps and MAY include some or all finished steps.
Service SHOULD provide both running and finished steps if the task has around 10-20 steps, and provide only running steps otherwise. Service MUST consistently choose either the "running steps only" or the "running + finished steps" behavior.
The UI, CLI etc. MAY choose not to display all steps provided by the service.

@builtins.property
work_done: ProgressTracker.WorkDone = (source) ¶

Overall work progress details. MAY be absent if unknown.