nebius.api.nebius.common.v1.ProgressTracker.WorkDone

class documentation

class WorkDone(pb_classes.Message): (source)

Constructor: ProgressTracker.WorkDone(initial_message, total_tick_count, done_tick_count)

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	`done_tick_count.setter`	Undocumented
Method	`total_tick_count.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
Property	`done_tick_count`	Number of ticks completed so far. MUST be between 0 and total_tick_count, inclusive. MUST equal total_tick_count if the task or step is finished.
Property	`total_tick_count`	Total number of ticks (work units) to be completed. MUST be greater than 0.

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.

@done_tick_count.setter
def done_tick_count(self, value: builtins.int | None): (source) ¶

Undocumented

@total_tick_count.setter
def total_tick_count(self, value: builtins.int | 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.WorkDone',
                                                   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

{'total_tick_count': 'total_tick_count', 'done_tick_count': 'done_tick_count'}

__mask_functions__: dict = (source) ¶

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

Undocumented

@builtins.property
done_tick_count: builtins.int = (source) ¶

Number of ticks completed so far. MUST be between 0 and total_tick_count, inclusive. MUST equal total_tick_count if the task or step is finished.

@builtins.property
total_tick_count: builtins.int = (source) ¶

Total number of ticks (work units) to be completed. MUST be greater than 0.