StorageObject

class object_storage.storage_object.StorageObject(container, name, headers=None, client=None)

Representation of a Object Storage object.

constructor for StorageObject

@param container: container name @param name: object name @param headers: init headers to use when initializing the object @param client: object_storage.client instance.

exists()

Tries to load the object to check existance

@raises ResponseError @return: boolean, true if exists else false

load(cdn=True)

load data for the object

@param cdn: True if you want CDN information; default=True @return: object_storage.storage_object, self

get_info()

loads data if not already available and returns the properties

properties

loads data if not already available and returns the properties

props

loads data if not already available and returns the properties

headers

loads data if not already available and returns the raw headers for the object

meta

loads data if not already available and returns the metadata for the object

url

Get the URL of the object

path

Get the path of the object

list(limit=None, marker=None)

Uses sudo-hierarchical structure to list the children objects.

@param limit: limit of results to return. @param marker: start listing after this object name @raises ResponseError @return: list of StorageObject instances

is_dir()

returns True if content_type is ‘text/directory’

set_metadata(meta)

Sets metadata for the object

@param meta: dict of metadata on the object @raises ResponseError

create()

Create object

@raises ResponseError @return: StorageObject - self

delete(recursive=False)

Delete object

@raises ResponseError @return: True

read(size=0, offset=0)

Reads object content

@param size: number of bytes to read (0 reads all of the object data) @param offset: number of bytes to offset the read @raises ResponseError @return: str, data

save_to_filename(filename)

Reads object content into a file

@param filename: filename @raises ResponseError

chunk_download(chunk_size=None)

Returns an iterator to read the object data.

@param chunk_size: size of the chunks to read in.

If not defined uses self.chunk_size

@raises: ResponseError @return: iterable

iter_content(chunk_size=None)

Returns an iterator to read the object data.

@param chunk_size: size of the chunks to read in.

If not defined uses self.chunk_size

@raises: ResponseError @return: iterable

chunk_upload(headers=None)

Returns a chunkable upload instance.

This is needed for transient data uploads

@param headers: extra headers to use to initialize the request @raises: ResponseError @return: object that responds to o.send(‘data’) to send data

and o.finish() to finish the upload.

send(data)

Uploads object data

@param data: either a file-like object or a string. @raises: ResponseError @return: StorageObject, self

write(data)

Uploads object data

@param data: either a file-like object or a string. @raises: ResponseError @return: StorageObject, self

upload_directory(directory)

Uploads an entire directory

@param directory: path of the directory to upload @raises: ResponseError

load_from_filename(filename)

Uploads a file from the local filename

@param filename: path of the directory to upload @raises: ResponseError, IOError

copy_from(old_obj, *args, **kwargs)

Copies content from an existing object

@param old_obj: StorageObject instance to copy data from @raises: ResponseError @return: StorageObject, self

copy_to(new_obj, *args, **kwargs)

Copies content from an existing object

@param new_obj: StorageObject instance to copy data to @raises: ResponseError @return: StorageObject, new_obj

rename(new_obj, *args, **kwargs)

Copies content to a new object existing object and deletes the current object

@param new_obj: StorageObject instance to copy data to @raises: ResponseError

search(q, options=None, **kwargs)

Search within path

prime_cdn()

Prime the object for CDN usage

purge_cdn()

Purge the object for CDN usage

make_request(method, path=None, *args, **kwargs)

returns a request object

fileno()