GoogleApi.Admin.Datatransfer_v1.Api.Transfers (google_api_admin v0.26.0) View Source

API calls for all endpoints tagged Transfers.

Link to this section Summary

Functions

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

Link to this section Functions

Link to this function

datatransfer_transfers_get(connection, data_transfer_id, optional_params \\ [], opts \\ [])

View Source

Specs

datatransfer_transfers_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Datatransfer_v1.Model.DataTransfer.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a data transfer request by its resource ID.

Parameters

  • connection (type: GoogleApi.Admin.Datatransfer_v1.Connection.t) - Connection to server
  • data_transfer_id (type: String.t) - ID of the resource to be retrieved. This is returned in the response from the insert method.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Datatransfer_v1.Model.DataTransfer{}} on success
  • {:error, info} on failure
Link to this function

datatransfer_transfers_insert(connection, optional_params \\ [], opts \\ [])

View Source

Specs

datatransfer_transfers_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Datatransfer_v1.Model.DataTransfer.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Inserts a data transfer request.

Parameters

  • connection (type: GoogleApi.Admin.Datatransfer_v1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Admin.Datatransfer_v1.Model.DataTransfer.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Datatransfer_v1.Model.DataTransfer{}} on success
  • {:error, info} on failure
Link to this function

datatransfer_transfers_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

datatransfer_transfers_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Datatransfer_v1.Model.DataTransfersListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Admin.Datatransfer_v1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :customerId (type: String.t) - Immutable ID of the Google Apps account.
    • :maxResults (type: integer()) - Maximum number of results to return. Default is 100.
    • :newOwnerUserId (type: String.t) - Destination user's profile ID.
    • :oldOwnerUserId (type: String.t) - Source user's profile ID.
    • :pageToken (type: String.t) - Token to specify the next page in the list.
    • :status (type: String.t) - Status of the transfer.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Datatransfer_v1.Model.DataTransfersListResponse{}} on success
  • {:error, info} on failure