@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface TransferServiceBaseClient

    Defines the low-level gRPC client for the nebius.storage.v1.TransferService service.

    interface TransferServiceBaseClient {
        create(
            request: CreateTransferRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        delete(
            request: DeleteTransferRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        get(
            request: GetTransferRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Transfer) => void,
        ): SurfaceCall;
        getByName(
            request: GetByNameRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Transfer) => void,
        ): SurfaceCall;
        getIterationHistory(
            request: GetIterationHistoryRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: GetIterationHistoryResponse,
            ) => void,
        ): SurfaceCall;
        list(
            request: ListTransfersRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListTransfersResponse,
            ) => void,
        ): SurfaceCall;
        resume(
            request: ResumeTransferRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        stop(
            request: StopTransferRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        update(
            request: UpdateTransferRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
    }

    Hierarchy

    • Client
      • TransferServiceBaseClient
    Index
    create delete get getByName getIterationHistory list resume stop update

    • Calls the Create RPC.

      Parameters

      • request: CreateTransferRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Calls the Create RPC.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

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

      Parameters

      • request: DeleteTransferRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

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

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Calls the Get RPC.

      Parameters

      • request: GetTransferRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Transfer) => void
          • (error: ServiceError | null, response: Transfer): void

          • Calls the Get RPC.

            Parameters

            • error: ServiceError | null
            • response: Transfer

            Returns void

      Returns SurfaceCall

    • Calls the GetByName RPC.

      Parameters

      • request: GetByNameRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Transfer) => void
          • (error: ServiceError | null, response: Transfer): void

          • Calls the GetByName RPC.

            Parameters

            • error: ServiceError | null
            • response: Transfer

            Returns void

      Returns SurfaceCall

    • Calls the List RPC.

      Parameters

      Returns SurfaceCall

    • Resume stopped or failed transfer.

      Parameters

      • request: ResumeTransferRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Resume stopped or failed transfer.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • 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.

      Parameters

      • request: StopTransferRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • 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.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Calls the Update RPC.

      Parameters

      • request: UpdateTransferRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Calls the Update RPC.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    Settings
    Member Visibility

    On This Page
    Methods