nebius.api.nebius.common.v1.ProgressTracker.Step

class documentation

class Step(pb_classes.Message): (source)

Constructor: ProgressTracker.Step(initial_message, description, started_at, finished_at, ...)

Represents a basic step in the task. Fields are binary-compatible with ProgressTracker for easier processing.

Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`description.setter`	Undocumented
Method	`finished_at.setter`	Undocumented
Method	`started_at.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 step, e.g., "Connecting to localhost:8080". MUST be suitable for display to public users. Private descriptions must be filtered server-side based on the use case.
Property	`finished_at`	Timestamp when the step finished. MUST be absent for running steps; MUST be present for completed steps.
Property	`started_at`	Timestamp when the step started.
Property	`work_done`	Details on the work to be done for this step and progress made. 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

@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

@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.Step',
                                                   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',
 'finished_at': 'finished_at',
 'work_done': 'work_done'}

__mask_functions__ = (source) ¶

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

Undocumented

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

Human-readable description of the step, e.g., "Connecting to localhost:8080". MUST be suitable for display to public users. Private descriptions must be filtered server-side based on the use case.

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

Timestamp when the step finished. MUST be absent for running steps; MUST be present for completed steps.

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

Timestamp when the step started.

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

Details on the work to be done for this step and progress made. MAY be absent if unknown.