Admin SDK API . transfers

close()

Close httplib2 connections.

get(dataTransferId, x__xgafv=None)

Retrieves a data transfer request by its resource ID.

Args:
  dataTransferId: string, ID of the resource to be retrieved. This is returned in the response from the insert method. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Transfer resource represents the transfer of the ownership of user data between users.
  "applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
    { # Template to map fields of ApplicationDataTransfer resource.
      "applicationId": "A String", # The application's ID.
      "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
        { # Template for application transfer parameters.
          "key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
          "value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
            "A String",
          ],
        },
      ],
      "applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
    },
  ],
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The transfer's ID.
  "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
  "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
  "oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
  "overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
  "requestTime": "A String", # Read-only. The time at which the data transfer was requested.
}

insert(body=None, x__xgafv=None)

Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.

Args:
  body: object, The request body.
    The object takes the form of:

{ # A Transfer resource represents the transfer of the ownership of user data between users.
  "applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
    { # Template to map fields of ApplicationDataTransfer resource.
      "applicationId": "A String", # The application's ID.
      "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
        { # Template for application transfer parameters.
          "key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
          "value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
            "A String",
          ],
        },
      ],
      "applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
    },
  ],
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The transfer's ID.
  "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
  "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
  "oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
  "overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
  "requestTime": "A String", # Read-only. The time at which the data transfer was requested.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Transfer resource represents the transfer of the ownership of user data between users.
  "applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
    { # Template to map fields of ApplicationDataTransfer resource.
      "applicationId": "A String", # The application's ID.
      "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
        { # Template for application transfer parameters.
          "key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
          "value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
            "A String",
          ],
        },
      ],
      "applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
    },
  ],
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The transfer's ID.
  "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
  "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
  "oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
  "overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
  "requestTime": "A String", # Read-only. The time at which the data transfer was requested.
}

list(customerId=None, maxResults=None, newOwnerUserId=None, oldOwnerUserId=None, pageToken=None, status=None, x__xgafv=None)

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

Args:
  customerId: string, Immutable ID of the Google Workspace account.
  maxResults: integer, Maximum number of results to return. Default is 100.
  newOwnerUserId: string, Destination user's profile ID.
  oldOwnerUserId: string, Source user's profile ID.
  pageToken: string, Token to specify the next page in the list.
  status: string, Status of the transfer.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Template for a collection of DataTransfer resources.
  "dataTransfers": [ # List of data transfer requests.
    { # A Transfer resource represents the transfer of the ownership of user data between users.
      "applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
        { # Template to map fields of ApplicationDataTransfer resource.
          "applicationId": "A String", # The application's ID.
          "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.
            { # Template for application transfer parameters.
              "key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`.
              "value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
                "A String",
              ],
            },
          ],
          "applicationTransferStatus": "A String", # Read-only. Current status of transfer for this application.
        },
      ],
      "etag": "A String", # ETag of the resource.
      "id": "A String", # Read-only. The transfer's ID.
      "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
      "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
      "oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
      "overallTransferStatusCode": "A String", # Read-only. Overall transfer status.
      "requestTime": "A String", # Read-only. The time at which the data transfer was requested.
    },
  ],
  "etag": "A String", # ETag of the resource.
  "kind": "admin#datatransfer#dataTransfersList", # Identifies the resource as a collection of data transfer requests.
  "nextPageToken": "A String", # Token to specify the next page in the list.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.