Class: Oss::Api
- Inherits:
-
Object
- Object
- Oss::Api
- Defined in:
- lib/oss/api.rb
Instance Attribute Summary collapse
-
#bucket ⇒ Object
Returns the value of attribute bucket.
-
#client ⇒ Object
Returns the value of attribute client.
Instance Method Summary collapse
-
#abort_multipart_upload(bucket_name, object_name, upload_id) ⇒ Object
params: - bucket_name - object_name - upload_id.
-
#append_object(bucket_name, object_name, file, position, options = {}) ⇒ Object
params: - bucket_name - object_name - file - options.
-
#complete_multipart_upload(bucket_name, object_name, upload_id, parts) ⇒ Object
params: - bucket_name - object_name - upload_id - parts.
-
#copy_object(bucket_name, object, old_bucket, old_object, options = {}) ⇒ Object
params: - bucket_name - object_name - file - options.
-
#delete_bucket(bucket_name) ⇒ Object
params: - bucket_name.
-
#delete_bucket_cors(bucket_name) ⇒ Object
params: - bucket_name - rules.
-
#delete_bucket_lifecycle(bucket_name) ⇒ Object
params: - bucket_name.
-
#delete_bucket_logging(bucket_name) ⇒ Object
params: - bucket_name.
-
#delete_bucket_website(bucket_name) ⇒ Object
params: - bucket_name.
-
#delete_multiple_objects(bucket_name, objects) ⇒ Object
params: - bucket_name - objects.
-
#delete_object(bucket_name, object_name) ⇒ Object
params: - bucket_name - object_name.
-
#get_bucket(bucket_name, options = {}) ⇒ Object
params: - bucket_name - options: - delimiter - prefix - marker - max_keys - encoding_type.
-
#get_bucket_acl(bucket_name) ⇒ Object
params: - bucket_name.
-
#get_bucket_cors(bucket_name) ⇒ Object
params: - bucket_name - rules.
-
#get_bucket_lifecycle(bucket_name) ⇒ Object
params: - bucket_name.
-
#get_bucket_location(bucket_name) ⇒ Object
params: - bucket_name.
-
#get_bucket_logging(bucket_name) ⇒ Object
params: - bucket_name.
-
#get_bucket_referer(bucket_name) ⇒ Object
params: - bucket_name.
-
#get_bucket_website(bucket_name) ⇒ Object
params: - bucket_name.
-
#get_object(bucket_name, object, options = {}) ⇒ Object
params: - bucket_name - object - options.
-
#get_service(options = {}) ⇒ Object
(also: #list_bucket)
params: - options: - prefix - marker - max_keys.
-
#head_object(bucket_name, object_name) ⇒ Object
params: - bucket_name - object_name - options.
-
#initialize(endpoint, access_key_id, access_key_secret, bucket = nil) ⇒ Api
constructor
A new instance of Api.
-
#initiate_multipart_upload(bucket_name, object_name, options = {}) ⇒ Object
params: - bucket_name - object_name - options.
-
#list_multipart_upload(bucket_name, options = {}) ⇒ Object
params: - bucket_name - options.
-
#list_parts(bucket_name, object_name, options = {}) ⇒ Object
params: - bucket_name - object_name - options.
-
#option_object(bucket_name, object_name, origin, request_method, request_headers) ⇒ Object
params: - bucket_name - object_name - origin - request_method - request_headers.
-
#post_object(bucket_name, key, options = {}) ⇒ Object
params: - bucket_name - object_name - acl.
-
#put_bucket(bucket_name, acl) ⇒ Object
params: - bucket_name - acl.
-
#put_bucket_acl(bucket_name, acl) ⇒ Object
params: - bucket_name - acl.
-
#put_bucket_cors(bucket_name, rules) ⇒ Object
params: - bucket_name - rules.
-
#put_bucket_lifecycle(bucket_name, rules = []) ⇒ Object
params: - bucket_name - allow_empty - referer_list.
-
#put_bucket_logging(bucket_name, target_bucket, enable = true, target_prefix = nil) ⇒ Object
params: - bucket_name - target_bucket - enable - target_prefix.
-
#put_bucket_referer(bucket_name, allow_empty, referer_list = []) ⇒ Object
params: - bucket_name - allow_empty - referer_list.
-
#put_bucket_website(bucket_name, index_doc, error_doc) ⇒ Object
params: - bucket_name - index_doc - error_doc.
-
#put_object(bucket_name, object_name, file, options = {}) ⇒ Object
params: - bucket_name - object_name - file - options.
-
#put_object_acl(bucket_name, object_name, acl) ⇒ Object
params: - bucket_name - object_name - acl.
-
#upload_part(bucket_name, object_name, upload_id, file, part_number = 1, options = {}) ⇒ Object
params: - bucket_name - object_name - upload_id - file - part_number - options.
-
#upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number = 1, options = {}) ⇒ Object
params: - bucket_name - object_name - upload_id - old_bucket - old_object - part_number - options.
Constructor Details
#initialize(endpoint, access_key_id, access_key_secret, bucket = nil) ⇒ Api
Returns a new instance of Api.
13 14 15 16 |
# 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 |
Instance Attribute Details
#bucket ⇒ Object
Returns the value of attribute bucket.
11 12 13 |
# File 'lib/oss/api.rb', line 11 def bucket @bucket end |
#client ⇒ Object
Returns the value of attribute client.
11 12 13 |
# File 'lib/oss/api.rb', line 11 def client @client end |
Instance Method Details
#abort_multipart_upload(bucket_name, object_name, upload_id) ⇒ Object
params:
-
bucket_name
-
object_name
-
upload_id
285 286 287 |
# 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 = {}) ⇒ Object
params:
-
bucket_name
-
object_name
-
file
-
options
194 195 196 |
# File 'lib/oss/api.rb', line 194 def append_object(bucket_name, object_name, file, position, = {}) Object.new(@client).append_object(bucket_name, object_name, file, position, ) end |
#complete_multipart_upload(bucket_name, object_name, upload_id, parts) ⇒ Object
params:
-
bucket_name
-
object_name
-
upload_id
-
parts
277 278 279 |
# 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 = {}) ⇒ Object
params:
-
bucket_name
-
object_name
-
file
-
options
177 178 179 |
# File 'lib/oss/api.rb', line 177 def copy_object(bucket_name, object, old_bucket, old_object, = {}) Object.new(@client).copy_object(bucket_name, object, old_bucket, old_object, ) end |
#delete_bucket(bucket_name) ⇒ Object
params:
-
bucket_name
136 137 138 |
# 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) ⇒ Object
params:
-
bucket_name
-
rules
326 327 328 |
# 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) ⇒ Object
params:
-
bucket_name
154 155 156 |
# 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) ⇒ Object
params:
-
bucket_name
142 143 144 |
# 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) ⇒ Object
params:
-
bucket_name
148 149 150 |
# 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) ⇒ Object
params:
-
bucket_name
-
objects
208 209 210 |
# 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) ⇒ Object
params:
-
bucket_name
-
object_name
201 202 203 |
# 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 = {}) ⇒ Object
params:
-
bucket_name
-
options:
-
delimiter
-
prefix
-
marker
-
max_keys
-
encoding_type
-
94 95 96 |
# File 'lib/oss/api.rb', line 94 def get_bucket(bucket_name, = {}) Bucket.new(@client).get_bucket(bucket_name, ) end |
#get_bucket_acl(bucket_name) ⇒ Object
params:
-
bucket_name
100 101 102 |
# 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) ⇒ Object
params:
-
bucket_name
-
rules
319 320 321 |
# 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) ⇒ Object
params:
-
bucket_name
130 131 132 |
# 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) ⇒ Object
params:
-
bucket_name
106 107 108 |
# 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) ⇒ Object
params:
-
bucket_name
112 113 114 |
# 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) ⇒ Object
params:
-
bucket_name
124 125 126 |
# 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) ⇒ Object
params:
-
bucket_name
118 119 120 |
# 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 = {}) ⇒ Object
params:
-
bucket_name
-
object
-
options
185 186 187 |
# File 'lib/oss/api.rb', line 185 def get_object(bucket_name, object, = {}) Object.new(@client).get_object(bucket_name, object, ) end |
#get_service(options = {}) ⇒ Object Also known as: list_bucket
params:
-
options:
-
prefix
-
marker
-
max_keys
-
28 29 30 |
# File 'lib/oss/api.rb', line 28 def get_service( = {}) Service.new(@client).get_service() end |
#head_object(bucket_name, object_name) ⇒ Object
params:
-
bucket_name
-
object_name
-
options
216 217 218 |
# 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 = {}) ⇒ Object
params:
-
bucket_name
-
object_name
-
options
245 246 247 |
# File 'lib/oss/api.rb', line 245 def initiate_multipart_upload(bucket_name, object_name, = {}) Multipart.new(@client).initiate_multipart_upload(bucket_name, object_name, ) end |
#list_multipart_upload(bucket_name, options = {}) ⇒ Object
params:
-
bucket_name
-
options
292 293 294 |
# File 'lib/oss/api.rb', line 292 def list_multipart_upload(bucket_name, = {}) Multipart.new(@client).list_multipart_upload(bucket_name, ) end |
#list_parts(bucket_name, object_name, options = {}) ⇒ Object
params:
-
bucket_name
-
object_name
-
options
300 301 302 |
# File 'lib/oss/api.rb', line 300 def list_parts(bucket_name, object_name, = {}) Multipart.new(@client).list_parts(bucket_name, object_name, ) end |
#option_object(bucket_name, object_name, origin, request_method, request_headers) ⇒ Object
params:
-
bucket_name
-
object_name
-
origin
-
request_method
-
request_headers
336 337 338 |
# 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 = {}) ⇒ Object
params:
-
bucket_name
-
object_name
-
acl
232 233 234 |
# File 'lib/oss/api.rb', line 232 def post_object(bucket_name, key, = {}) Object.new(@client).post_object(bucket_name, key, ) end |
#put_bucket(bucket_name, acl) ⇒ Object
params:
-
bucket_name
-
acl
42 43 44 |
# 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) ⇒ Object
params:
-
bucket_name
-
acl
49 50 51 |
# 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) ⇒ Object
params:
-
bucket_name
-
rules
312 313 314 |
# 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 = []) ⇒ Object
params:
-
bucket_name
-
allow_empty
-
referer_list
82 83 84 |
# 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) ⇒ Object
params:
-
bucket_name
-
target_bucket
-
enable
-
target_prefix
58 59 60 |
# 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 = []) ⇒ Object
params:
-
bucket_name
-
allow_empty
-
referer_list
74 75 76 |
# 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) ⇒ Object
params:
-
bucket_name
-
index_doc
-
error_doc
66 67 68 |
# 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 = {}) ⇒ Object
params:
-
bucket_name
-
object_name
-
file
-
options
168 169 170 |
# File 'lib/oss/api.rb', line 168 def put_object(bucket_name, object_name, file, = {}) Object.new(@client).put_object(bucket_name, object_name, file, ) end |
#put_object_acl(bucket_name, object_name, acl) ⇒ Object
params:
-
bucket_name
-
object_name
-
acl
224 225 226 |
# 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 = {}) ⇒ Object
params:
-
bucket_name
-
object_name
-
upload_id
-
file
-
part_number
-
options
256 257 258 |
# File 'lib/oss/api.rb', line 256 def upload_part(bucket_name, object_name, upload_id, file, part_number = 1, = {}) Multipart.new(@client).upload_part(bucket_name, object_name, upload_id, file, part_number, ) end |
#upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number = 1, options = {}) ⇒ Object
params:
-
bucket_name
-
object_name
-
upload_id
-
old_bucket
-
old_object
-
part_number
-
options
268 269 270 |
# File 'lib/oss/api.rb', line 268 def upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number = 1, = {}) Multipart.new(@client).upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number, ) end |