Class | CloudFiles::Container |
In: |
lib/cloudfiles/container.rb
|
Parent: | Object |
connection | [R] | The parent CloudFiles::Connection object for this container |
name | [R] | Name of the container which corresponds to the instantiated container class |
Retrieves an existing CloudFiles::Container object tied to the current CloudFiles::Connection. If the requested container does not exist, it will raise a CloudFiles::Exception::NoSuchContainer Exception.
Will likely not be called directly, instead use connection.container(‘container_name’) to retrieve the object.
Returns true if the container is public and CDN-enabled. Returns false otherwise.
Aliased as container.public?
public_container.cdn_enabled? => true private_container.public? => false
Creates a new CloudFiles::StorageObject in the current container.
If an object with the specified name exists in the current container, that object will be returned. Otherwise, an empty new object will be returned.
Passing in the optional make_path argument as true will create zero-byte objects to simulate a filesystem path to the object, if an objectname with path separators ("/path/to/myfile.mp3") is supplied. These path objects can be used in the Container.objects method.
Removes an CloudFiles::StorageObject from a container. True is returned if the removal is successful. Throws NoSuchObjectException if the object doesn‘t exist. Throws InvalidResponseException if the request fails.
container.delete_object('new.txt') => true container.delete_object('nonexistent_file.txt') => NoSuchObjectException: Object nonexistent_file.txt does not exist
Returns true if a container is empty and returns false otherwise.
new_container.empty? => true full_container.empty? => false
Change the log retention status for this container. Values are true or false.
These logs will be periodically (at unpredictable intervals) compressed and uploaded to a ".CDN_ACCESS_LOGS" container in the form of "container_name.YYYYMMDDHH-XXXX.gz".
Makes a container private and returns true upon success. Throws NoSuchContainerException if the container doesn‘t exist or if the request fails.
Note that if the container was previously public, it will continue to exist out on the CDN until it expires.
container.make_private => true
Makes a container publicly available via the Cloud Files CDN and returns true upon success. Throws NoSuchContainerException if the container doesn‘t exist or if the request fails.
Takes an optional hash of options, including:
:ttl, which is the CDN cache TTL in seconds (default 86400 seconds or 1 day, minimum 3600 or 1 hour, maximum 259200 or 3 days)
:user_agent_acl, a Perl-compatible regular expression limiting access to this container to user agents matching the given regular expression
:referrer_acl, a Perl-compatible regular expression limiting access to this container to HTTP referral URLs matching the given regular expression
container.make_public(:ttl => 8900, :user_agent_acl => "/Mozilla/", :referrer_acl => "/^http://rackspace.com") => true
Returns the container‘s metadata as a nicely formatted hash, stripping off the X-Meta-Object- prefix that the system prepends to the key name.
object.metadata => {"ruby"=>"cool", "foo"=>"bar"}
Returns the CloudFiles::StorageObject for the named object. Refer to the CloudFiles::StorageObject class for available methods. If the object exists, it will be returned. If the object does not exist, a NoSuchObjectException will be thrown.
object = container.object('test.txt') object.data => "This is test data" object = container.object('newfile.txt') => NoSuchObjectException: Object newfile.txt does not exist
Returns true if object exists and returns false otherwise.
container.object_exists?('goodfile.txt') => true container.object_exists?('badfile.txt') => false
Gathers a list of all available objects in the current container and returns an array of object names.
container = cf.container("My Container") container.objects #=> [ "cat", "dog", "donkey", "monkeydir", "monkeydir/capuchin"]
Pass a limit argument to limit the list to a number of objects:
container.objects(:limit => 1) #=> [ "cat" ]
Pass an marker with or without a limit to start the list at a certain object:
container.objects(:limit => 1, :marker => 'dog') #=> [ "donkey" ]
Pass a prefix to search for objects that start with a certain string:
container.objects(:prefix => "do") #=> [ "dog", "donkey" ]
Only search within a certain pseudo-filesystem path:
container.objects(:path => 'monkeydir') #=> ["monkeydir/capuchin"]
Only grab "virtual directories", based on a single-character delimiter (no "directory" objects required):
container.objects(:delimiter => '/') #=> ["monkeydir"]
All arguments to this method are optional.
Returns an empty array if no object exist in the container. Throws an InvalidResponseException if the request fails.
Retrieves a list of all objects in the current container along with their size in bytes, hash, and content_type. If no objects exist, an empty hash is returned. Throws an InvalidResponseException if the request fails. Takes a parameter hash as an argument, in the same form as the objects method.
Accepts the same options as objects to limit the returned set.
Returns a hash in the same format as the containers_detail from the CloudFiles class.
container.objects_detail => {"test.txt"=>{:content_type=>"application/octet-stream", :hash=>"e2a6fcb4771aa3509f6b27b6a97da55b", :last_modified=>Mon Jan 19 10:43:36 -0600 2009, :bytes=>"16"}, "new.txt"=>{:content_type=>"application/octet-stream", :hash=>"0aa820d91aed05d2ef291d324e47bc96", :last_modified=>Wed Jan 28 10:16:26 -0600 2009, :bytes=>"22"} }
Purges CDN Edge Cache for all objects inside of this container
:email, An valid email address or comma seperated
list of emails to be notified once purge is complete . container.purge_from_cdn => true or container.purge_from_cdn("User@domain.com") => true or container.purge_from_cdn("User@domain.com, User2@domain.com") => true
Refreshes data about the container and populates class variables. Items are otherwise loaded in a lazy loaded fashion.
container.count => 2 [Upload new file to the container] container.count => 2 container.populate container.count => 3
Sets the metadata for an object. By passing a hash as an argument, you can set the metadata for an object. New calls to set metadata are additive. To remove metadata, set the value of the key to nil.
Throws NoSuchObjectException if the container doesn‘t exist. Throws InvalidResponseException if the request fails.