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.

Method	`create`	Undocumented
Method	`delete`	Fully delete a transfer along with its history. Only stopped or failed transfers can be deleted.
Method	`get`	Undocumented
Method	`get_by_name`	Undocumented
Method	`get_iteration_history`	Undocumented
Method	`list`	Undocumented
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`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Class Variable	`__operation_source_method__`	Undocumented
Class Variable	`__service_name__`	Undocumented

Inherited from ClientWithOperations:

Method	`__init__`	Undocumented
Method	`operation_service`	Undocumented
Class Variable	`__operation_service_class__`	Undocumented
Class Variable	`__operation_type__`	Undocumented
Instance Variable	`__operation_service__`	Undocumented

Inherited from Client (via ClientWithOperations):

Method	`request`	Undocumented
Instance Variable	`_channel`	Undocumented

def create(self, request: CreateTransferRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[CreateTransferRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Undocumented

def delete(self, request: DeleteTransferRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[DeleteTransferRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Fully delete a transfer along with its history. Only stopped or failed transfers can be deleted.

def get(self, request: GetTransferRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[GetTransferRequest, Transfer]: (source) ¶

Undocumented

def get_by_name(self, request: v1_1.GetByNameRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[v1_1.GetByNameRequest, Transfer]: (source) ¶

Undocumented

def get_iteration_history(self, request: GetIterationHistoryRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[GetIterationHistoryRequest, GetIterationHistoryResponse]: (source) ¶

Undocumented

def list(self, request: ListTransfersRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[ListTransfersRequest, ListTransfersResponse]: (source) ¶

Undocumented

def resume(self, request: ResumeTransferRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[ResumeTransferRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Resume stopped or failed transfer.

def stop(self, request: StopTransferRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> 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 transfer in Active state can be stopped.

def update(self, request: UpdateTransferRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[UpdateTransferRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Undocumented

__PB2_DESCRIPTOR__ = (source) ¶

Undocumented

Value

descriptor.DescriptorWrap[descriptor_1.ServiceDescriptor]('.nebius.storage.v1alp↵
ha1.TransferService',
                                                          transfer_service_pb2.DESCRIPTOR↵
,
                                                          descriptor_1.ServiceDescriptor↵
)

__operation_source_method__: str = (source) ¶

overrides nebius.aio.client.ClientWithOperations.__operation_source_method__

Undocumented

__service_name__: str = (source) ¶

overrides nebius.aio.client.Client.__service_name__

Undocumented