Package yakumo :: Package swift :: Package v1 :: Module file_object :: Class Resource
[hide private]
[frames] | no frames]

Class Resource

source code

      object --+        
               |        
   base.Resource --+    
                   |    
base.SwiftV1Resource --+
                       |
                      Resource

resource class for containers on Object Storage V1 API

Instance Methods [hide private]
None
update(self, content_disposition='__UNDEF__', content_encoding='__UNDEF__', content_type='__UNDEF__', delete_after='__UNDEF__', delete_at='__UNDEF__', trans_id_extra='__UNDEF__', metadata='__UNDEF__')
Update metadata of an object
source code
None
replace(self, content_disposition='__UNDEF__', content_encoding='__UNDEF__', content_type='__UNDEF__', etag='__UNDEF__', if_none_match='__UNDEF__', delete_after='__UNDEF__', delete_at='__UNDEF__', object_manifest='__UNDEF__', size='__UNDEF__', trans_id_extra='__UNDEF__', metadata='__UNDEF__', file=None)
Replace an object
source code
swift.v1.file_object.Resource
copy(self, container='__UNDEF__', name='__UNDEF__')
Copy an object
source code
None
download(self, file=None)
Download an object into a file
source code
None
set_metadata(self, **metadata)
Update metadata of an object
source code
None
unset_metadata(self, *keys)
Delete metadata of an object
source code

Inherited from base.SwiftV1Resource: get_metadata

Inherited from base.Resource: __enter__, __eq__, __exit__, __getattr__, __init__, __ne__, __repr__, __str__, delete, get_attrs, get_id, reload, wait_for_finished

Inherited from base.Resource (private): _clear_attrs, _set_attrs

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

update(self, content_disposition='__UNDEF__', content_encoding='__UNDEF__', content_type='__UNDEF__', delete_after='__UNDEF__', delete_at='__UNDEF__', trans_id_extra='__UNDEF__', metadata='__UNDEF__')

source code 

Update metadata of an object

Parameters:
  • content_disposition (str) - Specifies the override behavior for the browser
  • content_encoding (str) - Content-Encoding metadata
  • content_type (str) - MIME type for the object
  • delete_after (int) - Seconds after which the system removes the object
  • delete_at (datetime.datetime) - When the system removes the object
  • trans_id_extra (str) - Extra transaction information
  • metadata (dict) - Key-value style metadata
Returns: None
Overrides: base.Resource.update

replace(self, content_disposition='__UNDEF__', content_encoding='__UNDEF__', content_type='__UNDEF__', etag='__UNDEF__', if_none_match='__UNDEF__', delete_after='__UNDEF__', delete_at='__UNDEF__', object_manifest='__UNDEF__', size='__UNDEF__', trans_id_extra='__UNDEF__', metadata='__UNDEF__', file=None)

source code 

Replace an object

Parameters:
  • content_disposition (str) - Specifies the override behavior for the browser
  • content_encoding (str) - Content-Encoding metadata
  • content_type (str) - MIME type for the object
  • etag (str) - MD5 checksum of the object
  • if_none_match (str) - If-None-Match header
  • delete_after (datetime.datetime) - When the system removes the object
  • delete_at (datetime.datetime) - When the system removes the object
  • object_manifest (str) - Dynamic large object manifest object
  • size (int) - Object size
  • trans_id_extra (str) - Extra transaction information
  • metadata (dict) - Key-value style metadata
  • file (str) - File name to upload
Returns: None

copy(self, container='__UNDEF__', name='__UNDEF__')

source code 

Copy an object

Parameters:
  • container (swift.container.Resource) - Destination container
  • name (str) - Destination object name
Returns: swift.v1.file_object.Resource
New object

download(self, file=None)

source code 

Download an object into a file

Parameters:
  • file (str) - File name to save
Returns: None

set_metadata(self, **metadata)

source code 

Update metadata of an object

Parameters:
  • metadata (dict) - key=value style.
Returns: None
Overrides: base.SwiftV1Resource.set_metadata

unset_metadata(self, *keys)

source code 

Delete metadata of an object

Parameters:
  • key - key of the metadata
  • keys ([str])
Returns: None
Overrides: base.SwiftV1Resource.unset_metadata