View Source ExBackblaze.Files (ex_backblaze v0.1.0)

Endpoints:

  • b2_cancel_large_file
  • b2_copy_file
  • b2_delete_file_version
  • b2_finish_large_file
  • b2_get_file_info
  • b2_list_file_names
  • b2_list_file_versions
  • b2_start_large_file
  • b2_hide_file
  • b2_list_unfinished_large_files
  • b2_upload_part
  • b2_upload_file
  • b2_copy_part
  • b2_list_parts
  • b2_update_file_legal_hold
  • b2_update_file_retention

Link to this section Summary

Functions

POST /b2_cancel_large_file

POST /b2_copy_file

POST /b2_copy_part

POST /b2_delete_file_version

POST /b2_finish_large_file

POST /b2_get_file_info

POST /b2_hide_file

POST /b2_list_file_names

POST /b2_list_file_versions

POST /b2_list_parts

POST /b2_list_unfinished_large_files

POST /b2_start_large_file

POST /b2_update_file_legal_hold

POST /b2_update_file_retention

POST /b2_upload_file

POST /b2_upload_part

Link to this section Functions

Link to this function

cancel_large_file(token, headers, body)

View Source
@spec cancel_large_file(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, ExBackblaze.Files.File.t()}

POST /b2_cancel_large_file

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_cancel_large_file.html

Link to this function

copy_file(token, headers, body)

View Source

POST /b2_copy_file

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_copy_file.html

Link to this function

copy_part(token, headers, body)

View Source

POST /b2_copy_part

required-params

Required Params

  • %Token{apiUrl: api_url}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_copy_part.html

Link to this function

delete_file_version(token, headers, body)

View Source
@spec delete_file_version(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, ExBackblaze.Files.File.t()}

POST /b2_delete_file_version

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_delete_file_version.html

Link to this function

finish_large_file(token, headers, body)

View Source
@spec finish_large_file(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, ExBackblaze.Files.File.t()}

POST /b2_finish_large_file

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_finish_large_file.html

examples

Examples

iex> ExBackblaze.Files.finish_large_file(token, [Authorization: "authtoken"], [fileId: "fileid", partSha1Array: ["checksum", "checksum"]])
{:ok, %ExBackblaze.Files.File{}}
Link to this function

get_file_info(token, headers, body)

View Source
@spec get_file_info(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, ExBackblaze.Files.File.t()}

POST /b2_get_file_info

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_get_file_info.html

Link to this function

hide_file(token, headers, body)

View Source

POST /b2_hide_file

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_hide_file.html

Link to this function

list_file_names(token, headers, body)

View Source
@spec list_file_names(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, %{files: list(), next_file_name: any()}}

POST /b2_list_file_names

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_list_file_names.html

Examples

iex> ExBackblaze.Files.list_file_names(token, [Authorization: "authtoken"], [bucketId: "bucketid"])
{:ok, %{files: list, next_file_name: string}}
Link to this function

list_file_versions(token, headers, body)

View Source
@spec list_file_versions(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, %{files: list(), next_file_id: any(), next_file_name: any()}}

POST /b2_list_file_versions

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_list_file_versions.html

Link to this function

list_parts(token, headers, body)

View Source
@spec list_parts(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, %{parts: list(), next_part_number: any()}}

POST /b2_list_parts

required-params

Required Params

  • %Token{apiUrl: api_url}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_list_parts.html

Link to this function

list_unfinished_large_files(token, headers, body)

View Source
@spec list_unfinished_large_files(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, %{files: list(), next_file_id: any()}}

POST /b2_list_unfinished_large_files

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_list_unfinished_large_files.html

Link to this function

start_large_file(token, headers, body)

View Source
@spec start_large_file(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, ExBackblaze.Files.File.t()}

POST /b2_start_large_file

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_start_large_file.html

Link to this function

update_file_retention(token, headers, body)

View Source
@spec update_file_retention(ExBackblaze.Tokens.Token.t(), keyword(), keyword()) ::
  {:ok, ExBackblaze.Files.File.t()}

POST /b2_update_file_retention

required-params

Required Params

  • %Token{apiUrl: api_url}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_update_file_retention.html

Link to this function

upload_file(token, headers, body)

View Source
@spec upload_file(ExBackblaze.Tokens.Token.t(), keyword(), binary()) ::
  {:ok, ExBackblaze.Files.File.t()}

POST /b2_upload_file

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_upload_file.html

Link to this function

upload_part(token, headers, body)

View Source
@spec upload_part(ExBackblaze.Tokens.Token.t(), keyword(), binary()) ::
  {:ok, ExBackblaze.Files.File.t()}

POST /b2_upload_part

required-params

Required Params

  • %Token{}

see-docs

See docs:

https://www.backblaze.com/b2/docs/b2_upload_part.html