Class TransferService

constructor

• new TransferService(sdk: SDKInterface): TransferService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns TransferService

$type

create

• create(
      request: CreateTransferRequest,
  ): Request<CreateTransferRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateTransferRequest

  Returns Request<CreateTransferRequest, Operation<GetOperationRequest>>

• create(
      request: CreateTransferRequest,
      metadata: Metadata,
  ): Request<CreateTransferRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateTransferRequest
  • metadata: Metadata

  Returns Request<CreateTransferRequest, Operation<GetOperationRequest>>

• create(
      request: CreateTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateTransferRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateTransferRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateTransferRequest, Operation<GetOperationRequest>>

• create(
      request: CreateTransferRequest,
  ): Request<CreateTransferRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateTransferRequest

  Returns Request<CreateTransferRequest, Operation<GetOperationRequest>>

• create(
      request: CreateTransferRequest,
      metadata: Metadata,
  ): Request<CreateTransferRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateTransferRequest
  • metadata: Metadata

  Returns Request<CreateTransferRequest, Operation<GetOperationRequest>>

• create(
      request: CreateTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateTransferRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateTransferRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateTransferRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteTransferRequest,
  ): Request<DeleteTransferRequest, Operation<GetOperationRequest>>

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

  Parameters

  • request: DeleteTransferRequest

  Returns Request<DeleteTransferRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteTransferRequest,
      metadata: Metadata,
  ): Request<DeleteTransferRequest, Operation<GetOperationRequest>>

  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

  Returns Request<DeleteTransferRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteTransferRequest, Operation<GetOperationRequest>>

  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> & RetryOptions

  Returns Request<DeleteTransferRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteTransferRequest,
  ): Request<DeleteTransferRequest, Operation<GetOperationRequest>>

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

  Parameters

  • request: DeleteTransferRequest

  Returns Request<DeleteTransferRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteTransferRequest,
      metadata: Metadata,
  ): Request<DeleteTransferRequest, Operation<GetOperationRequest>>

  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

  Returns Request<DeleteTransferRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteTransferRequest, Operation<GetOperationRequest>>

  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> & RetryOptions

  Returns Request<DeleteTransferRequest, Operation<GetOperationRequest>>

get

• get(request: GetTransferRequest): Request<GetTransferRequest, Transfer>

  Calls the Get RPC.

  Parameters

  • request: GetTransferRequest

  Returns Request<GetTransferRequest, Transfer>

• get(
      request: GetTransferRequest,
      metadata: Metadata,
  ): Request<GetTransferRequest, Transfer>

  Calls the Get RPC.

  Parameters

  • request: GetTransferRequest
  • metadata: Metadata

  Returns Request<GetTransferRequest, Transfer>

• get(
      request: GetTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetTransferRequest, Transfer>

  Calls the Get RPC.

  Parameters

  • request: GetTransferRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetTransferRequest, Transfer>

• get(request: GetTransferRequest): Request<GetTransferRequest, Transfer>

  Calls the Get RPC.

  Parameters

  • request: GetTransferRequest

  Returns Request<GetTransferRequest, Transfer>

• get(
      request: GetTransferRequest,
      metadata: Metadata,
  ): Request<GetTransferRequest, Transfer>

  Calls the Get RPC.

  Parameters

  • request: GetTransferRequest
  • metadata: Metadata

  Returns Request<GetTransferRequest, Transfer>

• get(
      request: GetTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetTransferRequest, Transfer>

  Calls the Get RPC.

  Parameters

  • request: GetTransferRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetTransferRequest, Transfer>

getByName

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Transfer>

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Transfer>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Transfer>

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Transfer>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Transfer>

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Transfer>

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Transfer>

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Transfer>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Transfer>

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Transfer>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Transfer>

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Transfer>

getIterationHistory

• getIterationHistory(
      request: GetIterationHistoryRequest,
  ): Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

  Get transfer iteration history.

  Parameters

  • request: GetIterationHistoryRequest

  Returns Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

• getIterationHistory(
      request: GetIterationHistoryRequest,
      metadata: Metadata,
  ): Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

  Get transfer iteration history.

  Parameters

  • request: GetIterationHistoryRequest
  • metadata: Metadata

  Returns Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

• getIterationHistory(
      request: GetIterationHistoryRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

  Get transfer iteration history.

  Parameters

  • request: GetIterationHistoryRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

• getIterationHistory(
      request: GetIterationHistoryRequest,
  ): Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

  Get transfer iteration history.

  Parameters

  • request: GetIterationHistoryRequest

  Returns Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

• getIterationHistory(
      request: GetIterationHistoryRequest,
      metadata: Metadata,
  ): Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

  Get transfer iteration history.

  Parameters

  • request: GetIterationHistoryRequest
  • metadata: Metadata

  Returns Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

• getIterationHistory(
      request: GetIterationHistoryRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

  Get transfer iteration history.

  Parameters

  • request: GetIterationHistoryRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetIterationHistoryRequest, GetIterationHistoryResponse>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListTransfersRequest,
  ): Request<ListTransfersRequest, ListTransfersResponse>

  Calls the List RPC.

  Parameters

  • request: ListTransfersRequest

  Returns Request<ListTransfersRequest, ListTransfersResponse>

• list(
      request: ListTransfersRequest,
      metadata: Metadata,
  ): Request<ListTransfersRequest, ListTransfersResponse>

  Calls the List RPC.

  Parameters

  • request: ListTransfersRequest
  • metadata: Metadata

  Returns Request<ListTransfersRequest, ListTransfersResponse>

• list(
      request: ListTransfersRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListTransfersRequest, ListTransfersResponse>

  Calls the List RPC.

  Parameters

  • request: ListTransfersRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListTransfersRequest, ListTransfersResponse>

• list(
      request: ListTransfersRequest,
  ): Request<ListTransfersRequest, ListTransfersResponse>

  Calls the List RPC.

  Parameters

  • request: ListTransfersRequest

  Returns Request<ListTransfersRequest, ListTransfersResponse>

• list(
      request: ListTransfersRequest,
      metadata: Metadata,
  ): Request<ListTransfersRequest, ListTransfersResponse>

  Calls the List RPC.

  Parameters

  • request: ListTransfersRequest
  • metadata: Metadata

  Returns Request<ListTransfersRequest, ListTransfersResponse>

• list(
      request: ListTransfersRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListTransfersRequest, ListTransfersResponse>

  Calls the List RPC.

  Parameters

  • request: ListTransfersRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListTransfersRequest, ListTransfersResponse>

resume

• resume(
      request: ResumeTransferRequest,
  ): Request<ResumeTransferRequest, Operation<GetOperationRequest>>

  Resume stopped or failed transfer.

  Parameters

  • request: ResumeTransferRequest

  Returns Request<ResumeTransferRequest, Operation<GetOperationRequest>>

• resume(
      request: ResumeTransferRequest,
      metadata: Metadata,
  ): Request<ResumeTransferRequest, Operation<GetOperationRequest>>

  Resume stopped or failed transfer.

  Parameters

  • request: ResumeTransferRequest
  • metadata: Metadata

  Returns Request<ResumeTransferRequest, Operation<GetOperationRequest>>

• resume(
      request: ResumeTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ResumeTransferRequest, Operation<GetOperationRequest>>

  Resume stopped or failed transfer.

  Parameters

  • request: ResumeTransferRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ResumeTransferRequest, Operation<GetOperationRequest>>

• resume(
      request: ResumeTransferRequest,
  ): Request<ResumeTransferRequest, Operation<GetOperationRequest>>

  Resume stopped or failed transfer.

  Parameters

  • request: ResumeTransferRequest

  Returns Request<ResumeTransferRequest, Operation<GetOperationRequest>>

• resume(
      request: ResumeTransferRequest,
      metadata: Metadata,
  ): Request<ResumeTransferRequest, Operation<GetOperationRequest>>

  Resume stopped or failed transfer.

  Parameters

  • request: ResumeTransferRequest
  • metadata: Metadata

  Returns Request<ResumeTransferRequest, Operation<GetOperationRequest>>

• resume(
      request: ResumeTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ResumeTransferRequest, Operation<GetOperationRequest>>

  Resume stopped or failed transfer.

  Parameters

  • request: ResumeTransferRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ResumeTransferRequest, Operation<GetOperationRequest>>

stop

• stop(
      request: StopTransferRequest,
  ): Request<StopTransferRequest, Operation<GetOperationRequest>>

  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

  Returns Request<StopTransferRequest, Operation<GetOperationRequest>>

• stop(
      request: StopTransferRequest,
      metadata: Metadata,
  ): Request<StopTransferRequest, Operation<GetOperationRequest>>

  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

  Returns Request<StopTransferRequest, Operation<GetOperationRequest>>

• stop(
      request: StopTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<StopTransferRequest, Operation<GetOperationRequest>>

  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> & RetryOptions

  Returns Request<StopTransferRequest, Operation<GetOperationRequest>>

• stop(
      request: StopTransferRequest,
  ): Request<StopTransferRequest, Operation<GetOperationRequest>>

  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

  Returns Request<StopTransferRequest, Operation<GetOperationRequest>>

• stop(
      request: StopTransferRequest,
      metadata: Metadata,
  ): Request<StopTransferRequest, Operation<GetOperationRequest>>

  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

  Returns Request<StopTransferRequest, Operation<GetOperationRequest>>

• stop(
      request: StopTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<StopTransferRequest, Operation<GetOperationRequest>>

  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> & RetryOptions

  Returns Request<StopTransferRequest, Operation<GetOperationRequest>>

update

• update(
      request: UpdateTransferRequest,
  ): Request<UpdateTransferRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateTransferRequest

  Returns Request<UpdateTransferRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateTransferRequest,
      metadata: Metadata,
  ): Request<UpdateTransferRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateTransferRequest
  • metadata: Metadata

  Returns Request<UpdateTransferRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateTransferRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateTransferRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateTransferRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateTransferRequest,
  ): Request<UpdateTransferRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateTransferRequest

  Returns Request<UpdateTransferRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateTransferRequest,
      metadata: Metadata,
  ): Request<UpdateTransferRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateTransferRequest
  • metadata: Metadata

  Returns Request<UpdateTransferRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateTransferRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateTransferRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateTransferRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateTransferRequest, Operation<GetOperationRequest>>