Admin SDK . 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.
      "etag": "A String", # ETag of the resource.
      "applicationDataTransfers": [ # 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.
        { # Template to map fields of ApplicationDataTransfer resource.
          "applicationId": "A String", # The application's ID.
          "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
          "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.
            { # Template for application transfer parameters.
              "value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
                "A String",
              ],
              "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
            },
          ],
        },
      ],
      "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
      "oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
      "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
      "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
      "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
      "id": "A String", # The transfer's ID (Read-only).
    }

insert(body=None, x__xgafv=None)

Inserts a data transfer request.

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.
    "etag": "A String", # ETag of the resource.
    "applicationDataTransfers": [ # 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.
      { # Template to map fields of ApplicationDataTransfer resource.
        "applicationId": "A String", # The application's ID.
        "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
        "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.
          { # Template for application transfer parameters.
            "value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
              "A String",
            ],
            "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
          },
        ],
      },
    ],
    "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
    "oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
    "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
    "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
    "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
    "id": "A String", # The transfer's ID (Read-only).
  }

  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.
      "etag": "A String", # ETag of the resource.
      "applicationDataTransfers": [ # 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.
        { # Template to map fields of ApplicationDataTransfer resource.
          "applicationId": "A String", # The application's ID.
          "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
          "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.
            { # Template for application transfer parameters.
              "value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
                "A String",
              ],
              "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
            },
          ],
        },
      ],
      "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
      "oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
      "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
      "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
      "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
      "id": "A String", # The transfer's ID (Read-only).
    }

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

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

Args:
  maxResults: integer, Maximum number of results to return. Default is 100.
  customerId: string, Immutable ID of the Google Apps account.
  newOwnerUserId: string, Destination user's profile ID.
  status: string, Status of the transfer.
  pageToken: string, Token to specify the next page in the list.
  oldOwnerUserId: string, Source user's profile ID.
  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.
          "etag": "A String", # ETag of the resource.
          "applicationDataTransfers": [ # 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.
            { # Template to map fields of ApplicationDataTransfer resource.
              "applicationId": "A String", # The application's ID.
              "applicationTransferStatus": "A String", # Current status of transfer for this application. (Read-only)
              "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.
                { # Template for application transfer parameters.
                  "value": [ # The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'
                    "A String",
                  ],
                  "key": "A String", # The type of the transfer parameter. eg: 'PRIVACY_LEVEL'
                },
              ],
            },
          ],
          "overallTransferStatusCode": "A String", # Overall transfer status (Read-only).
          "oldOwnerUserId": "A String", # ID of the user whose data is being transferred.
          "newOwnerUserId": "A String", # ID of the user to whom the data is being transferred.
          "requestTime": "A String", # The time at which the data transfer was requested (Read-only).
          "kind": "admin#datatransfer#DataTransfer", # Identifies the resource as a DataTransfer request.
          "id": "A String", # The transfer's ID (Read-only).
        },
    ],
    "nextPageToken": "A String", # Continuation token which will be used to specify next page in list API.
    "etag": "A String", # ETag of the resource.
    "kind": "admin#datatransfer#dataTransfersList", # Identifies the resource as a collection of data transfer requests.
  }

list_next(previous_request, previous_response)

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.