View Source GoogleApi.Books.V1.Api.Cloudloading (google_api_books v0.21.0)

API calls for all endpoints tagged Cloudloading.

Summary

Functions

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

Add a user-upload volume and triggers processing.

books_cloudloading_delete_book(connection, volume_id, optional_params \\ [], opts \\ [])

Remove the book and its contents

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

Updates a user-upload volume.

Functions

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

@spec books_cloudloading_add_book(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.BooksCloudloadingResource.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Add a user-upload volume and triggers processing.

Parameters

connection (type: GoogleApi.Books.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").
- :drive_document_id (type: String.t) - A drive document id. The upload_client_token must not be set.
- :mime_type (type: String.t) - The document MIME type. It can be set only if the drive_document_id is set.
- :name (type: String.t) - The document name. It can be set only if the drive_document_id is set.
- :upload_client_token (type: String.t) - Scotty upload token.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.BooksCloudloadingResource{}} on success
{:error, info} on failure

books_cloudloading_delete_book(connection, volume_id, optional_params \\ [], opts \\ [])

@spec books_cloudloading_delete_book(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Books.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Remove the book and its contents

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
volume_id (type: String.t) - The id of the book to be removed.
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.Books.V1.Model.Empty{}} on success
{:error, info} on failure

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

@spec books_cloudloading_update_book(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.BooksCloudloadingResource.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a user-upload volume.

Parameters

connection (type: GoogleApi.Books.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.Books.V1.Model.BooksCloudloadingResource.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.BooksCloudloadingResource{}} on success
{:error, info} on failure