nebius.api.nebius.storage.v1alpha1.TransferSpec

class documentation

class TransferSpec(pb_classes.Message): (source)

Constructor: TransferSpec(initial_message, source, destination, after_one_iteration, ...)

Undocumented

Class	`__OneOfClass_stop_condition__`	Undocumented
Class	`__OneOfClass_stop_condition_after_n_empty_iterations__`	Undocumented
Class	`__OneOfClass_stop_condition_after_one_iteration__`	Undocumented
Class	`__OneOfClass_stop_condition_infinite__`	Undocumented
Class	`BucketCredentials`	Undocumented
Class	`DestinationBucket`	No class docstring; 2/3 properties, 0/1 class variable, 0/2 constant, 0/5 method documented
Class	`Limiters`	No class docstring; 2/2 properties, 0/1 class variable, 0/2 constant, 0/4 method documented
Class	`OverwriteStrategy`	No class docstring; 3/5 constants documented
Class	`SourceBucket`	No class docstring; 4/6 properties, 0/1 class variable, 0/2 constant, 0/8 method documented
Class	`StopConditionAfterNEmptyIterations`	No class docstring; 1/1 property, 0/1 class variable, 0/2 constant, 0/3 method documented
Class	`StopConditionAfterOneIteration`	Undocumented
Class	`StopConditionInfinite`	Undocumented
Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`after_n_empty_iterations.setter`	Undocumented
Method	`after_one_iteration.setter`	Undocumented
Method	`destination.setter`	Undocumented
Method	`infinite.setter`	Undocumented
Method	`inter_iteration_interval.setter`	Undocumented
Method	`overwrite_strategy.setter`	Undocumented
Method	`source.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
Property	`after_n_empty_iterations`	Undocumented
Property	`after_one_iteration`	Undocumented
Property	`destination`	Undocumented
Property	`infinite`	Infinite transfers do not stop automatically and can be stopped manually by the user.
Property	`inter_iteration_interval`	Time to wait between transfer iterations. Default is 15 minutes if not specified.
Property	`overwrite_strategy`	Overwrite strategy set logic of overwrite already existed objects in destination bucket.
Property	`source`	Undocumented
Property	`stop_condition`	The stop condition is checked after every iteration. If the condition is met, the transfer will stop.

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

TransferSpec.StopConditionAfterOneIteration | transfer_pb2.TransferSpec.StopConditionAfterOneIteration | None | unset.UnsetType

= unset.Unset, after_n_empty_iterations:

TransferSpec.StopConditionAfterNEmptyIterations | transfer_pb2.TransferSpec.StopConditionAfterNEmptyIterations | None | unset.UnsetType

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.

@after_n_empty_iterations.setter
def after_n_empty_iterations(self, value: TransferSpec.StopConditionAfterNEmptyIterations | transfer_pb2.TransferSpec.StopConditionAfterNEmptyIterations | None): (source) ¶

Undocumented

@after_one_iteration.setter
def after_one_iteration(self, value: TransferSpec.StopConditionAfterOneIteration | transfer_pb2.TransferSpec.StopConditionAfterOneIteration | None): (source) ¶

Undocumented

@destination.setter
def destination(self, value: TransferSpec.DestinationBucket | transfer_pb2.TransferSpec.DestinationBucket | None): (source) ¶

Undocumented

@infinite.setter
def infinite(self, value: TransferSpec.StopConditionInfinite | transfer_pb2.TransferSpec.StopConditionInfinite | None): (source) ¶

Undocumented

@inter_iteration_interval.setter
def inter_iteration_interval(self, value: duration_pb2.Duration | datetime.timedelta | None): (source) ¶

Undocumented

@overwrite_strategy.setter
def overwrite_strategy(self, value: TransferSpec.OverwriteStrategy | transfer_pb2.TransferSpec.OverwriteStrategy | None): (source) ¶

Undocumented

@source.setter
def source(self, value: TransferSpec.SourceBucket | transfer_pb2.TransferSpec.SourceBucket | None): (source) ¶

Undocumented

__PB2_DESCRIPTOR__ = (source) ¶

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

Undocumented

Value

descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.storage.v1alpha1.Tra↵
nsferSpec',
                                                   transfer_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

{'source': 'source',
 'destination': 'destination',
 'after_one_iteration': 'after_one_iteration',
 'after_n_empty_iterations': 'after_n_empty_iterations',
 'infinite': 'infinite',
 'inter_iteration_interval': 'inter_iteration_interval',
 'overwrite_strategy': 'overwrite_strategy',
...

__mask_functions__ = (source) ¶

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

Undocumented

@builtins.property
after_n_empty_iterations: TransferSpec.StopConditionAfterNEmptyIterations | None = (source) ¶

Undocumented

@builtins.property
after_one_iteration: TransferSpec.StopConditionAfterOneIteration | None = (source) ¶

Undocumented

@builtins.property
destination: TransferSpec.DestinationBucket = (source) ¶

Undocumented

@builtins.property
infinite: TransferSpec.StopConditionInfinite | None = (source) ¶

Infinite transfers do not stop automatically and can be stopped manually by the user.

@builtins.property
inter_iteration_interval: datetime.timedelta = (source) ¶

Time to wait between transfer iterations. Default is 15 minutes if not specified.

@builtins.property
overwrite_strategy: TransferSpec.OverwriteStrategy = (source) ¶

Overwrite strategy set logic of overwrite already existed objects in destination bucket.

@builtins.property
source: TransferSpec.SourceBucket = (source) ¶

Undocumented

@builtins.property
stop_condition:

__OneOfClass_stop_condition_after_one_iteration__ | __OneOfClass_stop_condition_after_n_empty_iterations__ | __OneOfClass_stop_condition_infinite__ | None

= (source) ¶

The stop condition is checked after every iteration. If the condition is met, the transfer will stop.