nebius.api.nebius.storage.v1.TransferServiceClient

class documentation

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

Constructor: TransferServiceClient(channel)

View In Hierarchy

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 client methods for the nebius.storage.v1.TransferService service.

Class Method get_descriptor 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. If the transfer is active, it will be stopped and then deleted.
Method get The request object is returned without starting the RPC.
Method get_by_name The request object is returned without starting the RPC.
Method get_iteration_history Get transfer iteration history.
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_DESCRIPTOR__ Alias for code that expects a protobuf service descriptor.
Class Variable __api_service_name__ API gateway name for service routes.
Class Variable __operation_source_method__ RPC method that supplies the operation route.
Class Variable __service_name__ Fully qualified protobuf service name for RPC routes.

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.
Method stream_request Construct a native async request for a streaming RPC shape.
Class Variable __registry__ Descriptor registry for request metadata.
Class Variable __service_deprecation_details__ Optional deprecation message. The client writes this message to the warning log when it starts.
Instance Variable _channel Undocumented
@classmethod
def get_descriptor(cls) -> object: (source)

Return the protobuf service descriptor from the registry.

def create(self, request: CreateTransferRequest, **kwargs: Unpack[RequestKwargs]) -> Request[CreateTransferRequest, nebius.aio.operation.Operation[Operation]]: (source)

The request object is returned without starting the RPC.

def delete(self, request: DeleteTransferRequest, **kwargs: Unpack[RequestKwargs]) -> Request[DeleteTransferRequest, nebius.aio.operation.Operation[Operation]]: (source)

Fully delete a transfer along with its history. If the transfer is active, it will be stopped and then deleted.

The request object is returned without starting the RPC.

def get(self, request: GetTransferRequest, **kwargs: Unpack[RequestKwargs]) -> Request[GetTransferRequest, Transfer]: (source)

The request object is returned without starting the RPC.

def get_by_name(self, request: GetByNameRequest, **kwargs: Unpack[RequestKwargs]) -> Request[GetByNameRequest, Transfer]: (source)

The request object is returned without starting the RPC.

def get_iteration_history(self, request: GetIterationHistoryRequest, **kwargs: Unpack[RequestKwargs]) -> Request[GetIterationHistoryRequest, GetIterationHistoryResponse]: (source)

Get transfer iteration history.

The request object is returned without starting the RPC.

def list(self, request: ListTransfersRequest, **kwargs: Unpack[RequestKwargs]) -> Request[ListTransfersRequest, ListTransfersResponse]: (source)

The request object is returned without starting the RPC.

def resume(self, request: 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.

def stop(self, request: 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 transfers in Active state can be stopped.

The request object is returned without starting the RPC.

def update(self, request: UpdateTransferRequest, **kwargs: Unpack[RequestKwargs]) -> Request[UpdateTransferRequest, nebius.aio.operation.Operation[Operation]]: (source)

The request object is returned without starting the RPC.

__PB2_DESCRIPTOR__ = (source)

Alias for code that expects a protobuf service descriptor.

Value
REGISTRY.service_descriptor('nebius.storage.v1.TransferService')
__api_service_name__: str = (source)
overrides nebius.aio.client.Client.__api_service_name__

API gateway name for service routes.

__operation_source_method__: str = (source)
overrides nebius.aio.client.ClientWithOperations.__operation_source_method__

RPC method that supplies the operation route.

__service_name__: str = (source)
overrides nebius.aio.client.Client.__service_name__

Fully qualified protobuf service name for RPC routes.