View Source LibOss.Request (lib_oss v0.1.1)

request struct

Summary

Types

@type request_schema_t() :: [
  host: binary(),
  method: term(),
  object: binary(),
  resource: binary(),
  sub_resources: [term()],
  bucket: binary(),
  params: %{optional(binary()) => binary()},
  body: binary(),
  headers: [term()],
  expires: integer(),
  debug: boolean()
]
@type t() :: %LibOss.Request{
  body: LibOss.Typespecs.body(),
  bucket: LibOss.Typespecs.bucket(),
  debug: boolean(),
  expires: non_neg_integer(),
  headers: LibOss.Typespecs.headers(),
  host: LibOss.Typespecs.host(),
  method: LibOss.Typespecs.method(),
  object: String.t(),
  params: LibOss.Typespecs.params(),
  resource: String.t(),
  sub_resources: [{String.t(), String.t()}]
}

Functions

@spec auth(t(), LibOss.t()) :: t()
Link to this function

build_headers(request, client)

View Source
@spec build_headers(t(), LibOss.t()) :: t()
@spec new(request_schema_t()) :: t()

create a new request struct

Options

  • :host (String.t/0) - OSS host The default value is "".

  • :method - Required. HTTP method

  • :object (String.t/0) - OSS object The default value is "".

  • :resource (String.t/0) - OSS resource The default value is "/".

  • :sub_resources (list of term/0) - OSS sub resources The default value is [].

  • :bucket (String.t/0) - Required. OSS bucket

  • :params (map of String.t/0 keys and String.t/0 values) - OSS query params The default value is %{}.

  • :body (String.t/0) - HTTP body The default value is "".

  • :headers (list of term/0) - HTTP headers The default value is [].

  • :expires (integer/0) - oss expires The default value is 0.

  • :debug (boolean/0) - debug The default value is false.