Aliyun.Oss.Object.Symlink (aliyun_oss v3.1.2)

Object operations - Symlink.

Summary

Functions

GetSymlink - gets a symbol link.

PutSymlink - creates a symbolic link that points to target object.

Types

error()

@type error() ::
  %Aliyun.Oss.Client.Error{
    body: String.t(),
    parsed_details: map(),
    status_code: integer()
  }
  | atom()

Functions

get(config, bucket, object)

@spec get(Aliyun.Oss.Config.t(), String.t(), String.t()) ::
  {:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}

GetSymlink - gets a symbol link.

Examples

iex> Aliyun.Oss.Object.Symlink.get(config, "some-bucket", "some-object")
{:ok, %Aliyun.Oss.Client.Response{
    data: "",
    headers: %{
      "connection" => ["keep-alive"],
      "content-length" => ["0"],
      "content-type" => ["text/plain"],
      "date" => ["Fri, 11 Jul 2025 06:51:54 GMT"],
      "etag" => [""6751C61F42E*********************""],
      "last-modified" => ["Fri, 08 Mar 2019 05:11:29 GMT"],
      "server" => ["AliyunOSS"],
      "x-oss-request-id" => ["6870B4******************"],
      "x-oss-server-time" => ["8"],
      "x-oss-symlink-target" => ["test.txt"],
      "x-oss-version-id" => ["null"]
    }
  }
}

put(config, bucket, symlink, target_object, options \\ [])

@spec put(Aliyun.Oss.Config.t(), String.t(), String.t(), String.t(), keyword()) ::
  {:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}

PutSymlink - creates a symbolic link that points to target object.

Options

  • :storage_class - the storage class of the symlink object, default is "Standard". Acceptable values are:
    • "Standard"
    • "IA"
    • "Archive"
  • :acl - the access control list (ACL) of the symlink object, default is "default". Acceptable values are:
    • "default"
    • "private"
    • "public-read"
    • "public-read-write"

Examples

iex> Aliyun.Oss.Object.Symlink.put("some-bucket", "symlink", "target-object")
{:ok, %Aliyun.Oss.Client.Response{
    data: "",
    headers: %{
      "connection" => ["keep-alive"],
      "content-length" => ["0"],
      ...
    }
  }
}