Class Fog::Storage::Rackspace::Directory
In: lib/fog/rackspace/models/storage/directory.rb
Parent: Fog::Model

Methods

destroy   files   ios_url   metadata   metadata=   public?   public_url   reload   save   streaming_url  

Attributes

public  [W]  @!attribute [w] public Required for compatibility with other Fog providers. Not Used.
public_url  [W]  @!attribute [w] public_url Required for compatibility with other Fog providers. Not Used.

Public Instance methods

destroy()

Destroy the directory and remove it from CDN @return [Boolean] returns true if directory was deleted @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400 @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500 @raise [Fog::Storage::Rackspace::ServiceError] @note Directory must be empty before it is destroyed. @see docs.rackspace.com/files/api/v1/cf-devguide/content/Delete_Container-d1e1765.html

files()

Returns collection of files in directory @return [Fog::Storage::Rackspace::Files] collection of files in directory @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400 @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500 @raise [Fog::Storage::Rackspace::ServiceError]

ios_url()

URL used to stream video to iOS devices. Cloud Files will auto convert to the approprate format. @return [String] iOS URL @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400 @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500 @raise [Fog::Storage::Rackspace::ServiceError] @see docs.rackspace.com/files/api/v1/cf-devguide/content/iOS-Streaming-d1f3725.html

metadata()

Retrieve directory metadata @return [Fog::Storage::Rackspace::Metadata] metadata key value pairs.

metadata=(hash)

Set directory metadata @param [Hash,Fog::Storage::Rackspace::Metadata] hash contains key value pairs

public?()

Is directory published to CDN @return [Boolean] return true if published to CDN @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400 @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500 @raise [Fog::Storage::Rackspace::ServiceError]

public_url()

Returns the public url for the directory. If the directory has not been published to the CDN, this method will return nil as it is not publically accessible. This method will return the approprate url in the following order:

  1. If the service used to access this directory was created with the option :rackspace_cdn_ssl => true, this method will return the SSL-secured URL.
  2. If the cdn_cname attribute is populated this method will return the cname.
  3. return the default CDN url.

@return [String] public url for directory @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400 @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500 @raise [Fog::Storage::Rackspace::ServiceError]

reload()

Reload directory with latest data from Cloud Files @return [Fog::Storage::Rackspace::Directory] returns itself @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400 @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500 @raise [Fog::Storage::Rackspace::ServiceError]

save()

Create or update directory and associated metadata @return [Boolean] returns true if directory was saved @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400 @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500 @raise [Fog::Storage::Rackspace::ServiceError] @note If public attribute is true, directory will be CDN enabled @see docs.rackspace.com/files/api/v1/cf-devguide/content/Create_Container-d1e1694.html

streaming_url()

URL used to stream resources @return [String] streaming url @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400 @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500 @raise [Fog::Storage::Rackspace::ServiceError] @see docs.rackspace.com/files/api/v1/cf-devguide/content/Streaming-CDN-Enabled_Containers-d1f3721.html

[Validate]