Aliyun.Oss.Object.Tagging (aliyun_oss v2.0.0)

Object operations - Tagging.

Link to this section Summary

Functions

DeleteObjectTagging - deletes the tags of an object.

GetObjectTagging - gets the tags of an object.

PutObjectTagging - adds tags to an object or updates the tags added to the object.

Link to this section Types

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

Link to this section Functions

Link to this function

delete(config, bucket, object)

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

DeleteObjectTagging - deletes the tags of an object.

examples

Examples

iex> Aliyun.Oss.Object.Tagging.delete("some-bucket", "some-object")
{:ok, %Aliyun.Oss.Client.Response{
    data: "",
    headers: [
      {"Server", "AliyunOSS"},
      {"Date", "Wed, 05 Dec 2018 02:34:57 GMT"},
      ...
    ]
  }
}
Link to this function

get(config, bucket, object)

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

GetObjectTagging - gets the tags of an object.

examples

Examples

iex> Aliyun.Oss.Object.Tagging.get(config, "some-bucket", "some-object")
{:ok, %Aliyun.Oss.Client.Response{
    data: %{"Tagging" => %{"TagSet" => [%{"Key" => "key", "Value" => "value"}]}},
    headers: [
      {"Server", "AliyunOSS"},
      {"Date", "Fri, 01 Mar 2019 06:26:07 GMT"},
      {"Content-Type", "text/plain"},
      {"Content-Length", "0"},
      {"Connection", "keep-alive"},
      {"x-oss-request-id", "5C7000000000000000000000"},
      {"Last-Modified", "Fri, 01 Mar 2019 06:23:13 GMT"},
      {"ETag", ""6751C000000000000000000000000000""},
      {"x-oss-symlink-target", "test.txt"},
      {"x-oss-server-time", "1"}
    ]
  }
}
Link to this function

put(config, bucket, object, tags)

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

PutObjectTagging - adds tags to an object or updates the tags added to the object.

examples

Examples

iex> Aliyun.Oss.Object.Tagging.put(config, "some-bucket", "some-object", [{"key1", "value1"}, {:key2, "value2}])
{:ok, %Aliyun.Oss.Client.Response{
    data: "",
    headers: [
      {"Server", "AliyunOSS"},
      {"Date", "Wed, 05 Dec 2018 02:34:57 GMT"},
      ...
    ]
  }
}