nebius.api.nebius.storage.v1.TransferSpec

class documentation

class TransferSpec(Message): (source)

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

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
Method __init__ Create a message from a source message and field values.
Method after_n_empty_iterations.setter Set or clear the generated after_n_empty_iterations field.
Method after_one_iteration.setter Set or clear the generated after_one_iteration field.
Method destination.setter Set or clear the generated destination field.
Method enable_deletes_in_destination.setter Set or clear the generated enable_deletes_in_destination field.
Method infinite.setter Set or clear the generated infinite field.
Method inter_iteration_interval.setter Set or clear the generated inter_iteration_interval field.
Method limiters.setter Set or clear the generated limiters field.
Method overwrite_strategy.setter Set or clear the generated overwrite_strategy field.
Method source.setter Set or clear the generated source field.
Method touch_unmanaged.setter Set or clear the generated touch_unmanaged 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 after_n_empty_iterations Undocumented
Property after_one_iteration Undocumented
Property destination Destination to which the transfer writes data.
Property enable_deletes_in_destination If enable_deletes_in_destination flag is set, service will delete objects that exist in destination, but don't exist in source. If touch_unmanaged flag isn't set, we do not delete objects that haven't been created by Data Transfer service.
Property infinite Infinite transfers do not stop automatically and can be stopped manually by the user.
Property inter_iteration_interval The time to wait since the previous iteration before starting the next one. Default is 15 minutes if not specified.
Property limiters Limiters applied to source bucket operations. These limits include all operations required for transfer (HeadObject, GetObject, ListObjects). For details about which operations are used, see public documentation: ...
Property overwrite_strategy Overwrite strategy set logic of overwrite already existed objects in destination bucket.
Property source Source from which the transfer reads data.
Property stop_condition Undocumented
Property touch_unmanaged If touch_unmanaged flag is set, service will be allowed to overwrite and delete from destination objects that were not created by Data Transfer Service. If this flag is false, Data Transfer Service will never overwrite or delete objects that haven't been created by Data Transfer service.

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, *, source: TransferSource | None | UnsetType = _NEBIUS_UNSET, destination: TransferDestination | None | UnsetType = _NEBIUS_UNSET, limiters: TransferSpec__Limiters | None | UnsetType = _NEBIUS_UNSET, after_one_iteration: TransferSpec__StopConditionAfterOneIteration | None | UnsetType = _NEBIUS_UNSET, after_n_empty_iterations: TransferSpec__StopConditionAfterNEmptyIterations | None | UnsetType = _NEBIUS_UNSET, infinite: TransferSpec__StopConditionInfinite | None | UnsetType = _NEBIUS_UNSET, inter_iteration_interval: timedelta | Duration | None | UnsetType = _NEBIUS_UNSET, overwrite_strategy: TransferSpec__OverwriteStrategy | None | UnsetType = _NEBIUS_UNSET, enable_deletes_in_destination: bool | None | UnsetType = _NEBIUS_UNSET, touch_unmanaged: bool | None | UnsetType = _NEBIUS_UNSET): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

@after_n_empty_iterations.setter
def after_n_empty_iterations(self, value: TransferSpec__StopConditionAfterNEmptyIterations | None): (source)

Set or clear the generated after_n_empty_iterations field.

@after_one_iteration.setter
def after_one_iteration(self, value: TransferSpec__StopConditionAfterOneIteration | None): (source)

Set or clear the generated after_one_iteration field.

@destination.setter
def destination(self, value: TransferDestination | None): (source)

Set or clear the generated destination field.

@enable_deletes_in_destination.setter
def enable_deletes_in_destination(self, value: bool | None): (source)

Set or clear the generated enable_deletes_in_destination field.

@infinite.setter
def infinite(self, value: TransferSpec__StopConditionInfinite | None): (source)

Set or clear the generated infinite field.

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

Set or clear the generated inter_iteration_interval field.

@limiters.setter
def limiters(self, value: TransferSpec__Limiters | None): (source)

Set or clear the generated limiters field.

@overwrite_strategy.setter
def overwrite_strategy(self, value: TransferSpec__OverwriteStrategy | None): (source)

Set or clear the generated overwrite_strategy field.

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

Set or clear the generated source field.

@touch_unmanaged.setter
def touch_unmanaged(self, value: bool | None): (source)

Set or clear the generated touch_unmanaged field.

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

Protobuf message descriptor from the registry.

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

Fully qualified protobuf message name.

Value
'nebius.storage.v1.TransferSpec'
__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
{'source': 'source',
 'destination': 'destination',
 'limiters': 'limiters',
 'after_one_iteration': 'after_one_iteration',
 'after_n_empty_iterations': 'after_n_empty_iterations',
 'infinite': 'infinite',
 'inter_iteration_interval': 'inter_iteration_interval',
...
@_NebiusProperty
after_n_empty_iterations: TransferSpec__StopConditionAfterNEmptyIterations | None = (source)

Undocumented

@_NebiusProperty
after_one_iteration: TransferSpec__StopConditionAfterOneIteration | None = (source)

Undocumented

@_NebiusProperty
destination: TransferDestination = (source)

Destination to which the transfer writes data.

@_NebiusProperty
enable_deletes_in_destination: bool = (source)

If enable_deletes_in_destination flag is set, service will delete objects that exist in destination, but don't exist in source. If touch_unmanaged flag isn't set, we do not delete objects that haven't been created by Data Transfer service.

@_NebiusProperty
infinite: TransferSpec__StopConditionInfinite | None = (source)

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

@_NebiusProperty
inter_iteration_interval: timedelta | None = (source)

The time to wait since the previous iteration before starting the next one. Default is 15 minutes if not specified.

@_NebiusProperty
limiters: TransferSpec__Limiters = (source)

Limiters applied to source bucket operations. These limits include all operations required for transfer (HeadObject, GetObject, ListObjects). For details about which operations are used, see public documentation: http://docs.nebius.com/object-storage/transfer/quickstart#background.

Note: Since the service performs comparable request volumes and data transfers to both source and destination, these limits will indirectly constrain destination operations as well.

@_NebiusProperty
overwrite_strategy: TransferSpec__OverwriteStrategy = (source)

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

@_NebiusProperty
source: TransferSource = (source)

Source from which the transfer reads data.

@_NebiusProperty
stop_condition: __OneOfClass_stop_condition_after_one_iteration__ | __OneOfClass_stop_condition_after_n_empty_iterations__ | __OneOfClass_stop_condition_infinite__ | None = (source)

Undocumented

@_NebiusProperty
touch_unmanaged: bool = (source)

If touch_unmanaged flag is set, service will be allowed to overwrite and delete from destination objects that were not created by Data Transfer Service. If this flag is false, Data Transfer Service will never overwrite or delete objects that haven't been created by Data Transfer service.