Module: Aliyun::Oss::Client::BucketObjects

Included in:
BucketObjectsService
Defined in:
lib/aliyun/oss/client/bucket_objects.rb

Instance Method Summary collapse

Instance Method Details

#append(*args) ⇒ true

Append data to a object, will create Appendable object

Parameters:

  • key (String) —

    object name

  • file (file, bin data) —

    the data to append

  • position (Integer) —

    append to position of object

  • headers (Hash) —

    a customizable set of options

Returns:

  • (true)

Raises:

See Also:



105
106
107
 
# File 'lib/aliyun/oss/client/bucket_objects.rb', line 105

def append(*args)
  !!client.bucket_append_object(*args)
end

#copy(*args) ⇒ true

Copy from existing object

Parameters:

  • key (String) —

    the object name

  • source_bucket (String) —

    the source bucket name

  • source_key (String) —

    the source object name

  • headers (Hash)
  • options (Hash) —

    a customizable set of options

Returns:

  • (true)

Raises:

See Also:



75
76
77
 
# File 'lib/aliyun/oss/client/bucket_objects.rb', line 75

def copy(*args)
  !!client.bucket_copy_object(*args)
end

#create(*args) ⇒ true

create object of bucket

Parameters:

  • key (String) —

    Specify object name

  • file (File, Bin data) —

    Specify need upload resource

  • headers (Hash) —

    Specify other options

Returns:

  • (true)

Raises:

See Also:



34
35
36
 
# File 'lib/aliyun/oss/client/bucket_objects.rb', line 34

def create(*args)
  !!client.bucket_create_object(*args)
end

#delete(*args) ⇒ true

Delete object for bucket

Parameters:

  • key (String) —

    the object name

Returns:

  • (true)

Raises:

See Also:



47
48
49
 
# File 'lib/aliyun/oss/client/bucket_objects.rb', line 47

def delete(*args)
  !!client.bucket_delete_object(*args)
end

#delete_multiple(*args) ⇒ true

Delete objects for bucket

Parameters:

  • keys (Array<String>) —

    the object names

  • quiet (Boolean) —

    Specify response mode: false(Quiet) return results for error objects, true(Verbose) return results of every objects

Returns:

  • (true)

Raises:

See Also:



60
61
62
 
# File 'lib/aliyun/oss/client/bucket_objects.rb', line 60

def delete_multiple(*args)
  !!client.bucket_delete_objects(*args)
end

#get(*args) ⇒ String

Get Object

Parameters:

  • key (String) —

    the object name

  • query (Hash) —

    query params

  • headers (Hash) —

    headers

Returns:

  • (String)

Raises:

See Also:

  • Client#bucekt_get_object


90
91
92
 
# File 'lib/aliyun/oss/client/bucket_objects.rb', line 90

def get(*args)
  client.bucket_get_object(*args).body
end

#list(*args) ⇒ Array<Aliyun::Oss::Struct::Object>

List objects of bucket

Parameters:

  • options (Hash) —

    options

Returns:

Raises:

See Also:



16
17
18
19
20
21
22
23
 
# File 'lib/aliyun/oss/client/bucket_objects.rb', line 16

def list(*args)
  result = client.bucket_list_objects(*args).parsed_response

  object_keys = %w(ListBucketResult Contents)
  Utils.wrap(Utils.dig_value(result, *object_keys)).map do |object|
    Struct::Object.new(object.merge(client: client))
  end
end