nebius.api.nebius.storage.v1alpha1.TransferSpec

class documentation

class TransferSpec(pb_classes.Message): (source)

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

View In Hierarchy

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; 1/2 property, 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; 2/4 properties, 0/1 class variable, 0/2 constant, 0/6 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__ Undocumented
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 Undocumented
Class Method is_credentials Undocumented
Class Method is_sensitive Undocumented
Method __repr__ Undocumented
Method check_presence Undocumented
Method get_full_update_reset_mask Undocumented
Method get_mask Undocumented
Method is_default Undocumented
Method set_mask Undocumented
Method which_field_in_oneof Undocumented
Class Variable __PB2_CLASS__ Undocumented
Instance Variable __pb2_message__ Undocumented
Method _clear_field Undocumented
Method _get_field Undocumented
Method _set_field Undocumented
Class Variable __credentials_fields Undocumented
Class Variable __default Undocumented
Class Variable __sensitive_fields Undocumented
Instance Variable __recorded_reset_mask Undocumented
def __dir__(self) -> abc.Iterable[builtins.str]: (source)

Undocumented

def __init__(self, initial_message: message_1.Message | None = None, *, source: TransferSpec.SourceBucket | transfer_pb2.TransferSpec.SourceBucket | None | unset.UnsetType = unset.Unset, destination: TransferSpec.DestinationBucket | transfer_pb2.TransferSpec.DestinationBucket | None | unset.UnsetType = unset.Unset, after_one_iteration: TransferSpec.StopConditionAfterOneIteration | transfer_pb2.TransferSpec.StopConditionAfterOneIteration | None | unset.UnsetType = unset.Unset, after_n_empty_iterations: TransferSpec.StopConditionAfterNEmptyIterations | transfer_pb2.TransferSpec.StopConditionAfterNEmptyIterations | None | unset.UnsetType = unset.Unset, infinite: TransferSpec.StopConditionInfinite | transfer_pb2.TransferSpec.StopConditionInfinite | None | unset.UnsetType = unset.Unset, inter_iteration_interval: duration_pb2.Duration | datetime.timedelta | None | unset.UnsetType = unset.Unset, overwrite_strategy: TransferSpec.OverwriteStrategy | transfer_pb2.TransferSpec.OverwriteStrategy | None | unset.UnsetType = unset.Unset): (source)
overrides nebius.base.protos.pb_classes.Message.__init__

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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.