Alixir.OSS (alixir_oss v0.2.1) View Source

Alixir.OSS enables puting and deleting objects for Aliyun OSS.

Examples

  Alixir.OSS.put_object(args...)
  |> Alixir.request()

  Alixir.OSS.delete_objects(args...)
  |> Alixir.request()

See put_object/4 and delete_object/4 for more details.

Link to this section Summary

Functions

delete_object(file_object, oss_headers \\ [])

Delete object from OSS. Return an Alixir.OSS.Operation struct which could be passed to Alixir.request to perform the request.

head_object(bucket, key)

Head an object. Return true if the object exists, or false if it doesn't exist.

post_object_data(file_object, policy_options \\ [])

Generate a presigned URL, which could be used by other other applications (such as frontend) to operate OSS

presigned_url(http_method, file_object, options \\ [])

Generate a presigned URL, which could be used by other other applications (such as frontend) to operate OSS

put_object(file_object, oss_headers \\ [])

Put object to OSS. Return an Alixir.OSS.Operation struct which could be passed to Alixir.request to perform the request.

Link to this section Functions

delete_object(file_object, oss_headers \\ [])

Specs

delete_object(
  %Alixir.OSS.FileObject{bucket: term(), object: term(), object_key: term()},
  list()
) :: %Alixir.OSS.Operation{
  bucket: term(),
  file: term(),
  http_method: :delete,
  object_key: term(),
  oss_headers: term()
}

Delete object from OSS. Return an Alixir.OSS.Operation struct which could be passed to Alixir.request to perform the request.

Example

iex> file_object = %Alixir.OSS.FileObject{bucket: "foo_bucket", object_key: "foo/bar.jpg"} ...> operation = Alixir.OSS.delete_object(file_object) ...> with %Alixir.OSS.Operation{http_method: :delete, bucket: "foo_bucket", object_key: "foo/bar.jpg", ...> oss_headers: oss_headers} when is_list(oss_headers) <- operation, do: true true

head_object(bucket, key)

Specs

head_object(String.t(), String.t()) :: boolean()

Head an object. Return true if the object exists, or false if it doesn't exist.

post_object_data(file_object, policy_options \\ [])

Specs

post_object_data(
  %Alixir.OSS.FileObject{bucket: term(), object: term(), object_key: term()},
  Keyword.t()
) :: map()

Generate a presigned URL, which could be used by other other applications (such as frontend) to operate OSS

presigned_url(http_method, file_object, options \\ [])

Specs

presigned_url(
  atom(),
  %Alixir.OSS.FileObject{bucket: term(), object: term(), object_key: term()},
  Keyword.t()
) :: String.t()

Generate a presigned URL, which could be used by other other applications (such as frontend) to operate OSS

put_object(file_object, oss_headers \\ [])

Specs

put_object(
  %Alixir.OSS.FileObject{bucket: term(), object: term(), object_key: term()},
  list()
) :: %Alixir.OSS.Operation{
  bucket: term(),
  file: term(),
  http_method: :put,
  object_key: term(),
  oss_headers: term()
}

Put object to OSS. Return an Alixir.OSS.Operation struct which could be passed to Alixir.request to perform the request.

Example

iex> file_object = %Alixir.OSS.FileObject{bucket: "foo_bucket", object_key: "foo/bar.jpg", object: File.stream!("test/data/bar.jpg")} ...> operation = Alixir.OSS.put_object(file_object, "X-OSS-Object-Acl": "public-read") ...> with %Alixir.OSS.Operation{http_method: :put, bucket: "foo_bucket", object_key: "foo/bar.jpg", ...> file: %File.Stream{path: "test/data/bar.jpg"}, oss_headers: oss_headers} when is_list(oss_headers) <- operation, do: true true