class Oss::Api

Attributes

bucket[RW]
client[RW]

Public Class Methods

new(endpoint, access_key_id, access_key_secret, bucket = nil) click to toggle source
# File lib/oss/api.rb, line 13
def initialize(endpoint, access_key_id, access_key_secret, bucket = nil)
  @bucket = bucket
  @client = Client.new(endpoint, access_key_id, access_key_secret)
end

Public Instance Methods

abort_multipart_upload(bucket_name, object_name, upload_id) click to toggle source

params:

  • bucket_name

  • object_name

  • upload_id

# File lib/oss/api.rb, line 285
def abort_multipart_upload(bucket_name, object_name, upload_id)
  Multipart.new(@client).abort_multipart_upload(bucket_name, object_name, upload_id)
end
append_object(bucket_name, object_name, file, position, options = {}) click to toggle source

params:

  • bucket_name

  • object_name

  • file

  • options

# File lib/oss/api.rb, line 194
def append_object(bucket_name, object_name, file, position, options = {})
  Object.new(@client).append_object(bucket_name, object_name, file, position, options)
end
complete_multipart_upload(bucket_name, object_name, upload_id, parts) click to toggle source

params:

  • bucket_name

  • object_name

  • upload_id

  • parts

# File lib/oss/api.rb, line 277
def complete_multipart_upload(bucket_name, object_name, upload_id, parts)
  Multipart.new(@client).complete_multipart_upload(bucket_name, object_name, upload_id, parts)
end
copy_object(bucket_name, object, old_bucket, old_object, options = {}) click to toggle source

params:

  • bucket_name

  • object_name

  • file

  • options

# File lib/oss/api.rb, line 177
def copy_object(bucket_name, object, old_bucket, old_object, options = {})
  Object.new(@client).copy_object(bucket_name, object, old_bucket, old_object, options)
end
delete_bucket(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 136
def delete_bucket(bucket_name)
  Bucket.new(@client).delete_bucket(bucket_name)
end
delete_bucket_cors(bucket_name) click to toggle source

params:

  • bucket_name

  • rules

# File lib/oss/api.rb, line 326
def delete_bucket_cors(bucket_name)
  Cors.new(@client).delete_bucket_cors(bucket_name)
end
delete_bucket_lifecycle(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 154
def delete_bucket_lifecycle(bucket_name)
  Bucket.new(@client).delete_bucket_lifecycle(bucket_name)
end
delete_bucket_logging(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 142
def delete_bucket_logging(bucket_name)
  Bucket.new(@client).delete_bucket_logging(bucket_name)
end
delete_bucket_website(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 148
def delete_bucket_website(bucket_name)
  Bucket.new(@client).delete_bucket_website(bucket_name)
end
delete_multiple_objects(bucket_name, objects) click to toggle source

params:

  • bucket_name

  • objects

# File lib/oss/api.rb, line 208
def delete_multiple_objects(bucket_name, objects)
  Object.new(@client).delete_multiple_objects(bucket_name, objects)
end
delete_object(bucket_name, object_name) click to toggle source

params:

  • bucket_name

  • object_name

# File lib/oss/api.rb, line 201
def delete_object(bucket_name, object_name)
  Object.new(@client).delete_object(bucket_name, object_name)
end
get_bucket(bucket_name, options = {}) click to toggle source

params:

  • bucket_name

  • options:

    • delimiter

    • prefix

    • marker

    • max_keys

    • encoding_type

# File lib/oss/api.rb, line 94
def get_bucket(bucket_name, options = {})
  Bucket.new(@client).get_bucket(bucket_name, options)
end
get_bucket_acl(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 100
def get_bucket_acl(bucket_name)
  Bucket.new(@client).get_bucket_acl(bucket_name)
end
get_bucket_cors(bucket_name) click to toggle source

params:

  • bucket_name

  • rules

# File lib/oss/api.rb, line 319
def get_bucket_cors(bucket_name)
  Cors.new(@client).get_bucket_cors(bucket_name)
end
get_bucket_lifecycle(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 130
def get_bucket_lifecycle(bucket_name)
  Bucket.new(@client).get_bucket_lifecycle(bucket_name)
end
get_bucket_location(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 106
def get_bucket_location(bucket_name)
  Bucket.new(@client).get_bucket_location(bucket_name)
end
get_bucket_logging(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 112
def get_bucket_logging(bucket_name)
  Bucket.new(@client).get_bucket_logging(bucket_name)
end
get_bucket_referer(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 124
def get_bucket_referer(bucket_name)
  Bucket.new(@client).get_bucket_referer(bucket_name)
end
get_bucket_website(bucket_name) click to toggle source

params:

  • bucket_name

# File lib/oss/api.rb, line 118
def get_bucket_website(bucket_name)
  Bucket.new(@client).get_bucket_website(bucket_name)
end
get_object(bucket_name, object, options = {}) click to toggle source

params:

  • bucket_name

  • object

  • options

# File lib/oss/api.rb, line 185
def get_object(bucket_name, object, options = {})
  Object.new(@client).get_object(bucket_name, object, options)
end
get_service(options = {}) click to toggle source

params:

  • options:

    • prefix

    • marker

    • max_keys

# File lib/oss/api.rb, line 28
def get_service(options = {})
  Service.new(@client).get_service(options)
end
Also aliased as: list_bucket
head_object(bucket_name, object_name) click to toggle source

params:

  • bucket_name

  • object_name

  • options

# File lib/oss/api.rb, line 216
def head_object(bucket_name, object_name)
  Object.new(@client).head_object(bucket_name, object_name)
end
initiate_multipart_upload(bucket_name, object_name, options = {}) click to toggle source

params:

  • bucket_name

  • object_name

  • options

# File lib/oss/api.rb, line 245
def initiate_multipart_upload(bucket_name, object_name, options = {})
  Multipart.new(@client).initiate_multipart_upload(bucket_name, object_name, options)
end
list_bucket(options = {})
Alias for: get_service
list_multipart_upload(bucket_name, options = {}) click to toggle source

params:

  • bucket_name

  • options

# File lib/oss/api.rb, line 292
def list_multipart_upload(bucket_name, options = {})
  Multipart.new(@client).list_multipart_upload(bucket_name, options)
end
list_parts(bucket_name, object_name, options = {}) click to toggle source

params:

  • bucket_name

  • object_name

  • options

# File lib/oss/api.rb, line 300
def list_parts(bucket_name, object_name, options = {})
  Multipart.new(@client).list_parts(bucket_name, object_name, options)
end
option_object(bucket_name, object_name, origin, request_method, request_headers) click to toggle source

params:

  • bucket_name

  • object_name

  • origin

  • request_method

  • request_headers

# File lib/oss/api.rb, line 336
def option_object(bucket_name, object_name, origin, request_method, request_headers)
  Cors.new(@client).option_object(bucket_name, object_name, origin, request_method, request_headers)
end
post_object(bucket_name, key, options = {}) click to toggle source

params:

  • bucket_name

  • object_name

  • acl

# File lib/oss/api.rb, line 232
def post_object(bucket_name, key, options = {})
  Object.new(@client).post_object(bucket_name, key, options)
end
put_bucket(bucket_name, acl) click to toggle source

params:

  • bucket_name

  • acl

# File lib/oss/api.rb, line 42
def put_bucket(bucket_name, acl)
  Bucket.new(@client).put_bucket(bucket_name, acl)
end
put_bucket_acl(bucket_name, acl) click to toggle source

params:

  • bucket_name

  • acl

# File lib/oss/api.rb, line 49
def put_bucket_acl(bucket_name, acl)
  Bucket.new(@client).put_bucket_acl(bucket_name, acl)
end
put_bucket_cors(bucket_name, rules) click to toggle source

params:

  • bucket_name

  • rules

# File lib/oss/api.rb, line 312
def put_bucket_cors(bucket_name, rules)
  Cors.new(@client).put_bucket_cors(bucket_name, rules)
end
put_bucket_lifecycle(bucket_name, rules = []) click to toggle source

params:

  • bucket_name

  • allow_empty

  • referer_list

# File lib/oss/api.rb, line 82
def put_bucket_lifecycle(bucket_name, rules = [])
  Bucket.new(@client).put_bucket_lifecycle(bucket_name, rules)
end
put_bucket_logging(bucket_name, target_bucket, enable = true, target_prefix = nil) click to toggle source

params:

  • bucket_name

  • target_bucket

  • enable

  • target_prefix

# File lib/oss/api.rb, line 58
def put_bucket_logging(bucket_name, target_bucket, enable = true, target_prefix = nil)
  Bucket.new(@client).put_bucket_logging(bucket_name, target_bucket, enable, target_prefix)
end
put_bucket_referer(bucket_name, allow_empty, referer_list = []) click to toggle source

params:

  • bucket_name

  • allow_empty

  • referer_list

# File lib/oss/api.rb, line 74
def put_bucket_referer(bucket_name, allow_empty, referer_list = [])
  Bucket.new(@client).put_bucket_referer(bucket_name, allow_empty, referer_list)
end
put_bucket_website(bucket_name, index_doc, error_doc) click to toggle source

params:

  • bucket_name

  • index_doc

  • error_doc

# File lib/oss/api.rb, line 66
def put_bucket_website(bucket_name, index_doc, error_doc)
  Bucket.new(@client).put_bucket_website(bucket_name, index_doc, error_doc)
end
put_object(bucket_name, object_name, file, options = {}) click to toggle source

params:

  • bucket_name

  • object_name

  • file

  • options

# File lib/oss/api.rb, line 168
def put_object(bucket_name, object_name, file, options = {})
  Object.new(@client).put_object(bucket_name, object_name, file, options)
end
put_object_acl(bucket_name, object_name, acl) click to toggle source

params:

  • bucket_name

  • object_name

  • acl

# File lib/oss/api.rb, line 224
def put_object_acl(bucket_name, object_name, acl)
  Object.new(@client).put_object_acl(bucket_name, object_name, acl)
end
upload_part(bucket_name, object_name, upload_id, file, part_number = 1, options = {}) click to toggle source

params:

  • bucket_name

  • object_name

  • upload_id

  • file

  • part_number

  • options

# File lib/oss/api.rb, line 256
def upload_part(bucket_name, object_name, upload_id, file, part_number = 1, options = {})
  Multipart.new(@client).upload_part(bucket_name, object_name, upload_id, file, part_number, options)
end
upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number = 1, options = {}) click to toggle source

params:

  • bucket_name

  • object_name

  • upload_id

  • old_bucket

  • old_object

  • part_number

  • options

# File lib/oss/api.rb, line 268
def upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number = 1, options = {})
  Multipart.new(@client).upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number, options)
end