aliyun_oss v2.0.0

Aliyun.Oss.Bucket.RequestPayment (aliyun_oss v2.0.0)

Bucket operations - RequestPayment.

Link to this section Summary

Types

error()

Functions

get(config, bucket)

GetBucketRequestPayment - gets pay-by-requester configurations for a bucket.

put(config, bucket, payer)

PutBucketRequestPayment - enables pay-by-requester for a bucket.

Link to this section Types

Link to this type

error()

@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

get(config, bucket)

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

GetBucketRequestPayment - gets pay-by-requester configurations for a bucket.

examples

 Examples 

iex> Aliyun.Oss.Bucket.RequestPayment.get("some-bucket")
{:ok, %Aliyun.Oss.Client.Response{
    data: %{"RequestPaymentConfiguration" => %{"Payer" => "BucketOwner"}},
    headers: [
      {"Server", "AliyunOSS"},
      {"Date", "Fri, 01 Mar 2019 06:26:07 GMT"},
      ...
    ]
  }
}
Link to this function

put(config, bucket, payer)

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

PutBucketRequestPayment - enables pay-by-requester for a bucket.

examples

 Examples 

iex> Aliyun.Oss.Bucket.RequestPayment.put("some-bucket", "Requester)
{:ok, %Aliyun.Oss.Client.Response{
    data: "",
    headers: [
      {"Server", "AliyunOSS"},
      {"Date", "Fri, 01 Mar 2019 06:26:07 GMT"},
      ...
    ]
  }
}