nebius.api.nebius.storage.v1alpha1.TransferServiceClient

class documentation

class TransferServiceClient(client.ClientWithOperations[v1_1.Operation, v1_1.OperationServiceClient]): (source)

Constructor: TransferServiceClient(channel)

TransferService provides functionality for creating and managing transfers that migrate data from other S3 providers or across different regions of Nebius Object Storage. Each transfer consists of consecutive iterations where the service lists objects in the source bucket and moves those that need to be transferred according to the specified overwrite strategy. After an iteration completes, the transfer will stop if its stop condition is met. Otherwise, it will wait for the defined inter-iteration interval before starting the next iteration.

This class provides the client methods for the .nebius.storage.v1alpha1.TransferService service.

Each method constructs a nebius.aio.request.Request object that represents the in-flight RPC. The request can be awaited (async) or waited synchronously using its .wait() helpers.

The request methods accept various parameters to configure metadata, timeouts, authorization, and retries. See individual method docstrings for details.

Method	`create`	Other parameters can be provided as keyword arguments in the `**kwargs` dictionary, including metadata, timeouts, and retries. See `nebius.aio.request_kwargs.RequestKwargs` for details.
Method	`delete`	Fully delete a transfer along with its history. Only stopped or failed transfers can be deleted.
Method	`get`	Other parameters can be provided as keyword arguments in the `**kwargs` dictionary, including metadata, timeouts, and retries. See `nebius.aio.request_kwargs.RequestKwargs` for details.
Method	`get_by_name`	Other parameters can be provided as keyword arguments in the `**kwargs` dictionary, including metadata, timeouts, and retries. See `nebius.aio.request_kwargs.RequestKwargs` for details.
Method	`get_iteration_history`	Other parameters can be provided as keyword arguments in the `**kwargs` dictionary, including metadata, timeouts, and retries. See `nebius.aio.request_kwargs.RequestKwargs` for details.
Method	`list`	Other parameters can be provided as keyword arguments in the `**kwargs` dictionary, including metadata, timeouts, and retries. See `nebius.aio.request_kwargs.RequestKwargs` for details.
Method	`resume`	Resume stopped or failed transfer.
Method	`stop`	Stop active transfer. If the transfer is currently moving data, it will be transitioned to the Stopping state and will move to the Stopped state once all processes have been stopped. If the transfer is waiting between iterations, it will stop immediately...
Method	`update`	Other parameters can be provided as keyword arguments in the `**kwargs` dictionary, including metadata, timeouts, and retries. See `nebius.aio.request_kwargs.RequestKwargs` for details.
Constant	`__PB2_DESCRIPTOR__`	The protobuf service descriptor extraction function.
Class Variable	`__operation_source_method__`	The method name that can be used to fetch the address channel for the operation.
Class Variable	`__service_name__`	The full protobuf service name.

Inherited from ClientWithOperations:

Method	`__init__`	Initialize the client-with-operations.
Method	`operation_service`	Return a cached operation-service client instance.
Class Variable	`__operation_service_class__`	the client class used to manage operations.
Class Variable	`__operation_type__`	the protobuf message class used to represent long-running operations.
Instance Variable	`__operation_service__`	cached instance of the operation-service client.

Inherited from Client (via ClientWithOperations):

Method	`request`	Construct a `nebius.aio.request.Request` for an RPC.
Class Variable	`__service_deprecation_details__`	optional deprecation message emitted as a runtime warning when the client is constructed.
Instance Variable	`_channel`	Undocumented

def create(self, request: CreateTransferRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[CreateTransferRequest, operation.Operation[v1_1.Operation]]: (source) ¶