# `LibOss.Api.Symlink`
[🔗](https://github.com/tt67wq/lib-oss/blob/main/lib/lib_oss/api/symlink.ex#L1)

OSS符号链接管理相关API

提供符号链接的创建和获取功能。

# `__using__`
*macro* 

创建宏，用于在客户端模块中导入所有符号链接管理函数

# `get_symlink`

```elixir
@spec get_symlink(module(), LibOss.Typespecs.bucket(), LibOss.Typespecs.object()) ::
  {:ok, binary()} | {:error, LibOss.Exception.t()}
```

调用GetSymlink接口获取软链接。

Doc: https://help.aliyun.com/document_detail/45146.html

## Examples

    iex> get_symlink(bucket, "/test/test.txt")
    {:ok, "/test/test_symlink.txt"}

# `put_symlink`

```elixir
@spec put_symlink(
  module(),
  LibOss.Typespecs.bucket(),
  LibOss.Typespecs.object(),
  String.t(),
  LibOss.Typespecs.headers()
) :: :ok | {:error, LibOss.Exception.t()}
```

调用PutSymlink接口用于为OSS的目标文件（TargetObject）创建软链接（Symlink）

Doc: https://help.aliyun.com/document_detail/45126.html

## Examples

    iex> put_symlink(bucket, "/test/test.txt", "/test/test_symlink.txt")
    :ok

---

*Consult [api-reference.md](api-reference.md) for complete listing*