class TransferServiceClient(client.ClientWithOperations[
Constructor: TransferServiceClient(channel)
TransferService provides functionality for creating and managing transfers that migrate data from other providers or across different regions of Nebius Object Storage.
This class provides the client methods for the .nebius.storage.v1.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. If the transfer is active, it will be stopped and then 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 |
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 |
Get transfer iteration history. |
| 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 |
The protobuf service descriptor extraction function. |
| Class Variable | __operation |
The method name that can be used to fetch the address channel for the operation. |
| Class Variable | __service |
The full protobuf service name. |
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. |
| Class Variable | __service |
optional deprecation message emitted as a runtime warning when the client is constructed. |
| Instance Variable | _channel |
Undocumented |
CreateTransferRequest, **kwargs: typing_extensions.Unpack[ request_kwargs.RequestKwargs]) -> request_1.Request[ CreateTransferRequest, operation.Operation[ v1_1.Operation]]:
(source)
¶
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.
| Parameters | |
request:nebius.api.nebius.storage.v1.CreateTransferRequest | The request object to send. |
**kwargs:typing_extensions.Unpack[ | Undocumented |
| Returns | |
nebius.aio.request.Request of
nebius.api.nebius.common.v1.Operation. | A nebius.aio.request.Request object representing the
in-flight RPC. It can be awaited (async) or waited
synchronously using its .wait() helpers. |
DeleteTransferRequest, **kwargs: typing_extensions.Unpack[ request_kwargs.RequestKwargs]) -> request_1.Request[ DeleteTransferRequest, operation.Operation[ v1_1.Operation]]:
(source)
¶
Fully delete a transfer along with its history. If the transfer is active, it will be stopped and then deleted.
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.
| Parameters | |
request:nebius.api.nebius.storage.v1.DeleteTransferRequest | The request object to send. |
**kwargs:typing_extensions.Unpack[ | Undocumented |
| Returns | |
nebius.aio.request.Request of
nebius.api.nebius.common.v1.Operation. | A nebius.aio.request.Request object representing the
in-flight RPC. It can be awaited (async) or waited
synchronously using its .wait() helpers. |
GetTransferRequest, **kwargs: typing_extensions.Unpack[ request_kwargs.RequestKwargs]) -> request_1.Request[ GetTransferRequest, Transfer]:
(source)
¶
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.
| Parameters | |
request:nebius.api.nebius.storage.v1.GetTransferRequest | The request object to send. |
**kwargs:typing_extensions.Unpack[ | Undocumented |
| Returns | |
nebius.aio.request.Request of
nebius.api.nebius.storage.v1.Transfer. | A nebius.aio.request.Request object representing the
in-flight RPC. It can be awaited (async) or waited
synchronously using its .wait() helpers. |
v1_1.GetByNameRequest, **kwargs: typing_extensions.Unpack[ request_kwargs.RequestKwargs]) -> request_1.Request[ v1_1.GetByNameRequest, Transfer]:
(source)
¶
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.
| Parameters | |
request:nebius.api.nebius.common.v1.GetByNameRequest | The request object to send. |
**kwargs:typing_extensions.Unpack[ | Undocumented |
| Returns | |
nebius.aio.request.Request of
nebius.api.nebius.storage.v1.Transfer. | A nebius.aio.request.Request object representing the
in-flight RPC. It can be awaited (async) or waited
synchronously using its .wait() helpers. |
GetIterationHistoryRequest, **kwargs: typing_extensions.Unpack[ request_kwargs.RequestKwargs]) -> request_1.Request[ GetIterationHistoryRequest, GetIterationHistoryResponse]:
(source)
¶
Get transfer 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.
| Parameters | |
request:nebius.api.nebius.storage.v1.GetIterationHistoryRequest | The request object to send. |
**kwargs:typing_extensions.Unpack[ | Undocumented |
| Returns | |
nebius.aio.request.Request of
nebius.api.nebius.storage.v1.GetIterationHistoryResponse. | A nebius.aio.request.Request object representing the
in-flight RPC. It can be awaited (async) or waited
synchronously using its .wait() helpers. |
ListTransfersRequest, **kwargs: typing_extensions.Unpack[ request_kwargs.RequestKwargs]) -> request_1.Request[ ListTransfersRequest, ListTransfersResponse]:
(source)
¶
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.
| Parameters | |
request:nebius.api.nebius.storage.v1.ListTransfersRequest | The request object to send. |
**kwargs:typing_extensions.Unpack[ | Undocumented |
| Returns | |
nebius.aio.request.Request of
nebius.api.nebius.storage.v1.ListTransfersResponse. | A nebius.aio.request.Request object representing the
in-flight RPC. It can be awaited (async) or waited
synchronously using its .wait() helpers. |
ResumeTransferRequest, **kwargs: typing_extensions.Unpack[ request_kwargs.RequestKwargs]) -> request_1.Request[ ResumeTransferRequest, operation.Operation[ v1_1.Operation]]:
(source)
¶
Resume stopped or failed transfer.
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.
| Parameters | |
request:nebius.api.nebius.storage.v1.ResumeTransferRequest | The request object to send. |
**kwargs:typing_extensions.Unpack[ | Undocumented |
| Returns | |
nebius.aio.request.Request of
nebius.api.nebius.common.v1.Operation. | A nebius.aio.request.Request object representing the
in-flight RPC. It can be awaited (async) or waited
synchronously using its .wait() helpers. |
StopTransferRequest, **kwargs: typing_extensions.Unpack[ request_kwargs.RequestKwargs]) -> request_1.Request[ StopTransferRequest, operation.Operation[ v1_1.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 transfers in Active state can be stopped.
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.
| Parameters | |
request:nebius.api.nebius.storage.v1.StopTransferRequest | The request object to send. |
**kwargs:typing_extensions.Unpack[ | Undocumented |
| Returns | |
nebius.aio.request.Request of
nebius.api.nebius.common.v1.Operation. | A nebius.aio.request.Request object representing the
in-flight RPC. It can be awaited (async) or waited
synchronously using its .wait() helpers. |
UpdateTransferRequest, **kwargs: typing_extensions.Unpack[ request_kwargs.RequestKwargs]) -> request_1.Request[ UpdateTransferRequest, operation.Operation[ v1_1.Operation]]:
(source)
¶
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.
| Parameters | |
request:nebius.api.nebius.storage.v1.UpdateTransferRequest | The request object to send. |
**kwargs:typing_extensions.Unpack[ | Undocumented |
| Returns | |
nebius.aio.request.Request of
nebius.api.nebius.common.v1.Operation. | A nebius.aio.request.Request object representing the
in-flight RPC. It can be awaited (async) or waited
synchronously using its .wait() helpers. |
The protobuf service descriptor extraction function.
| Value |
|