REST Resource: transfers

Resource: DataTransfer

A Transfer resource represents the transfer of the ownership of user data between users.

JSON representation
{
  "id": string,
  "oldOwnerUserId": string,
  "newOwnerUserId": string,
  "applicationDataTransfers": [
    {
      object (ApplicationDataTransfer)
    }
  ],
  "overallTransferStatusCode": string,
  "kind": string,
  "etag": string,
  "requestTime": string
}
Fields
id

string

The transfer's ID (Read-only).

oldOwnerUserId

string

ID of the user whose data is being transferred.

newOwnerUserId

string

ID of the user to whom the data is being transferred.

applicationDataTransfers[]

object (ApplicationDataTransfer)

applications.list of per application data transfer resources. It contains data transfer details of the applications associated with this transfer resource. Note that this list is also used to specify the applications for which data transfer has to be done at the time of the transfer resource creation.

overallTransferStatusCode

string

Overall transfer status (Read-only).

kind

string

Identifies the resource as a DataTransfer request.

etag

string

ETag of the resource.

requestTime

string

The time at which the data transfer was requested (Read-only).

ApplicationDataTransfer

Template to map fields of ApplicationDataTransfer resource.

JSON representation
{
  "applicationId": string,
  "applicationTransferParams": [
    {
      object (ApplicationTransferParam)
    }
  ],
  "applicationTransferStatus": string
}
Fields
applicationId

string (int64 format)

The application's ID.

applicationTransferParams[]

object (ApplicationTransferParam)

The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.

applicationTransferStatus

string

Current status of transfer for this application. (Read-only)

Methods

get

Retrieves a data transfer request by its resource ID.

insert

Inserts a data transfer request.

list

Lists the transfers for a customer by source user, destination user, or status.