class TransferServiceClient(ClientWithOperations[
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.
Supported until 06/01/26. Data Transfer v1alpha1 API is deprecated. Please use the v1 API instead. All existing transfers remain accessible through the v1 API.
This class provides client methods for the nebius.storage.v1alpha1.TransferService service.
| Class Method | get |
Return the protobuf service descriptor from the registry. |
| Method | create |
The request object is returned without starting the RPC. |
| Method | delete |
Fully delete a transfer along with its history. Only stopped or failed transfers can be deleted. |
| Method | get |
The request object is returned without starting the RPC. |
| Method | get |
The request object is returned without starting the RPC. |
| Method | get |
The request object is returned without starting the RPC. |
| Method | list |
The request object is returned without starting the RPC. |
| 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 |
The request object is returned without starting the RPC. |
| Constant | __PB2 |
Alias for code that expects a protobuf service descriptor. |
| Class Variable | __api |
API gateway name for service routes. |
| Class Variable | __operation |
RPC method that supplies the operation route. |
| Class Variable | __service |
Deprecation details emitted when the client is created. |
| Class Variable | __service |
Fully qualified protobuf service name for RPC routes. |
Inherited from ClientWithOperations:
| Method | __init__ |
Initialize the client-with-operations. |
| Method | operation |
Return a cached operation-service client instance. |
| Class Variable | __operation |
the client class used to manage operations. |
| Class Variable | __operation |
the protobuf message class used to represent long-running operations. |
| Instance Variable | __operation |
cached instance of the operation-service client. |
Inherited from Client (via ClientWithOperations):
| Method | request |
Construct a nebius.aio.request.Request for an RPC. |
| Method | stream |
Construct a native async request for a streaming RPC shape. |
| Class Variable | __registry__ |
Descriptor registry for request metadata. |
| Instance Variable | _channel |
Undocumented |
CreateTransferRequest, **kwargs: Unpack[ RequestKwargs]) -> Request[ CreateTransferRequest, nebius.aio.operation.Operation[ Operation]]:
(source)
¶
The request object is returned without starting the RPC.
DeleteTransferRequest, **kwargs: Unpack[ RequestKwargs]) -> Request[ DeleteTransferRequest, nebius.aio.operation.Operation[ Operation]]:
(source)
¶
Fully delete a transfer along with its history. Only stopped or failed transfers can be deleted.
The request object is returned without starting the RPC.
GetTransferRequest, **kwargs: Unpack[ RequestKwargs]) -> Request[ GetTransferRequest, Transfer]:
(source)
¶
The request object is returned without starting the RPC.
GetByNameRequest, **kwargs: Unpack[ RequestKwargs]) -> Request[ GetByNameRequest, Transfer]:
(source)
¶
The request object is returned without starting the RPC.
GetIterationHistoryRequest, **kwargs: Unpack[ RequestKwargs]) -> Request[ GetIterationHistoryRequest, GetIterationHistoryResponse]:
(source)
¶
The request object is returned without starting the RPC.
ListTransfersRequest, **kwargs: Unpack[ RequestKwargs]) -> Request[ ListTransfersRequest, ListTransfersResponse]:
(source)
¶
The request object is returned without starting the RPC.
ResumeTransferRequest, **kwargs: Unpack[ RequestKwargs]) -> Request[ ResumeTransferRequest, nebius.aio.operation.Operation[ Operation]]:
(source)
¶
Resume stopped or failed transfer.
The request object is returned without starting the RPC.
StopTransferRequest, **kwargs: Unpack[ RequestKwargs]) -> Request[ StopTransferRequest, nebius.aio.operation.Operation[ Operation]]:
(source)
¶
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. Only transfer in Active state can be stopped.
The request object is returned without starting the RPC.
UpdateTransferRequest, **kwargs: Unpack[ RequestKwargs]) -> Request[ UpdateTransferRequest, nebius.aio.operation.Operation[ Operation]]:
(source)
¶
The request object is returned without starting the RPC.
Alias for code that expects a protobuf service descriptor.
| Value |
|