View Source GoogleApi.Drive.V3.Api.Drives (google_api_drive v0.25.0)

API calls for all endpoints tagged Drives.

Link to this section Summary

Functions

Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.

Link to this section Functions

Link to this function

drive_drives_create(connection, request_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_drives_create(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Drive.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new shared drive.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • request_id (type: String.t) - An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.Drive.V3.Model.Drive.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.Drive{}} on success
  • {:error, info} on failure
Link to this function

drive_drives_delete(connection, drive_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_drives_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • drive_id (type: String.t) - The ID of the shared drive.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

drive_drives_get(connection, drive_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_drives_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Drive.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a shared drive's metadata by ID.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • drive_id (type: String.t) - The ID of the shared drive.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :useDomainAdminAccess (type: boolean()) - Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.Drive{}} on success
  • {:error, info} on failure
Link to this function

drive_drives_hide(connection, drive_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_drives_hide(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Drive.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Hides a shared drive from the default view.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • drive_id (type: String.t) - The ID of the shared drive.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.Drive{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

drive_drives_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.DriveList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the user's shared drives.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :pageSize (type: integer()) - Maximum number of shared drives to return per page.
    • :pageToken (type: String.t) - Page token for shared drives.
    • :q (type: String.t) - Query string for searching shared drives.
    • :useDomainAdminAccess (type: boolean()) - Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.DriveList{}} on success
  • {:error, info} on failure
Link to this function

drive_drives_unhide(connection, drive_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_drives_unhide(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Drive.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Restores a shared drive to the default view.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • drive_id (type: String.t) - The ID of the shared drive.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.Drive{}} on success
  • {:error, info} on failure
Link to this function

drive_drives_update(connection, drive_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_drives_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Drive.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the metadate for a shared drive.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • drive_id (type: String.t) - The ID of the shared drive.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :useDomainAdminAccess (type: boolean()) - Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
    • :body (type: GoogleApi.Drive.V3.Model.Drive.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.Drive{}} on success
  • {:error, info} on failure