nebius.api.nebius.common.v1.ProgressTracker

class documentation

class ProgressTracker(Message): (source)

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

View In Hierarchy

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.

Method __init__ Create a message from a source message and field values.
Method description.setter Set or clear the generated description field.
Method estimated_finished_at.setter Set or clear the generated estimated_finished_at field.
Method finished_at.setter Set or clear the generated finished_at field.
Method started_at.setter Set or clear the generated started_at field.
Method steps.setter Set or clear the generated steps field.
Method work_done.setter Set or clear the generated work_done 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 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 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, *, description: str | None | UnsetType = _NEBIUS_UNSET, started_at: datetime | Timestamp | None | UnsetType = _NEBIUS_UNSET, estimated_finished_at: datetime | Timestamp | None | UnsetType = _NEBIUS_UNSET, finished_at: datetime | Timestamp | None | UnsetType = _NEBIUS_UNSET, work_done: ProgressTracker__WorkDone | None | UnsetType = _NEBIUS_UNSET, steps: Iterable[ProgressTracker__Step] | None | UnsetType = _NEBIUS_UNSET): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

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

Set or clear the generated description field.

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

Set or clear the generated estimated_finished_at field.

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

Set or clear the generated finished_at field.

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

Set or clear the generated started_at field.

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

Set or clear the generated steps field.

@work_done.setter
def work_done(self, value: ProgressTracker__WorkDone | None): (source)

Set or clear the generated work_done field.

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

Protobuf message descriptor from the registry.

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

Fully qualified protobuf message name.

Value
'nebius.common.v1.ProgressTracker'
__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
{'description': 'description',
 'started_at': 'started_at',
 'estimated_finished_at': 'estimated_finished_at',
 'finished_at': 'finished_at',
 'work_done': 'work_done',
 'steps': 'steps',
 'WorkDone': 'WorkDone',
...
@_NebiusProperty
description: 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.

@_NebiusProperty
estimated_finished_at: datetime | None = (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.

@_NebiusProperty
finished_at: datetime | None = (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.

@_NebiusProperty
started_at: datetime | None = (source)

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

@_NebiusProperty
steps: 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.
@_NebiusProperty
work_done: ProgressTracker__WorkDone = (source)

Overall work progress details. MAY be absent if unknown.