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

API calls for all endpoints tagged Applications.

Link to this section Summary

Functions

Retrieves information about an application for the given application ID.

Lists the applications available for data transfer for a customer.

Link to this section Functions

Link to this function

datatransfer_applications_get(connection, application_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Retrieves information about an application for the given application ID.

Parameters

  • connection (type: GoogleApi.Admin.Datatransfer_v1.Connection.t) - Connection to server
  • application_id (type: String.t) - ID of the application resource to be retrieved.
  • 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.Application{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

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

Lists the applications available for data transfer for a customer.

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.
    • :pageToken (type: String.t) - Token to specify next page in the list.
  • opts (type: keyword()) - Call options

Returns

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