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

API calls for all endpoints tagged Drives.

Summary

Functions

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

Creates a shared drive.

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

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

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

Gets a shared drive's metadata by ID.

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

Hides a shared drive from the default view.

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

Lists the user's shared drives. This method accepts the q parameter, which is a search query combining one or more search terms. For more information, see the Search for shared drives guide.

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

Restores a shared drive to the default view.

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

Updates the metadata for a shared drive.

Functions

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

@spec 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 shared drive.

Parameters

connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
request_id (type: String.t) - Required. 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
- :"$.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.Drive.V3.Model.Drive.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec 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
- :"$.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").
- :allowItemDeletion (type: boolean()) - Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true.
- :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, %{}} on success
{:error, info} on failure

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

@spec 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
- :"$.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").
- :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

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

@spec 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
- :"$.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.Drive.V3.Model.Drive{}} on success
{:error, info} on failure

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

@spec 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. This method accepts the q parameter, which is a search query combining one or more search terms. For more information, see the Search for shared drives guide.

Parameters

connection (type: GoogleApi.Drive.V3.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").
- :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

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

@spec 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
- :"$.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.Drive.V3.Model.Drive{}} on success
{:error, info} on failure

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

@spec 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 metadata 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
- :"$.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").
- :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