Rackspace CloudFiles API
Public Member Functions | Properties | List of all members
Rackspace.Cloudfiles.CF_Container Class Reference

CF_Container object that provides Container level functionality and information More...

Inheritance diagram for Rackspace.Cloudfiles.CF_Container:
Rackspace.Cloudfiles.Container

Public Member Functions

 CF_Container (Connection conn, Client client, string container_name)
 Initializes a new instance of the Rackspace.Cloudfiles.CF_Container class.
 
 CF_Container (Connection conn, string container_name)
 Initializes a new instance of the Rackspace.Cloudfiles.CF_Container class.
 
void ReloadMetadata ()
 Reload all metadata for the Container.
 
StorageObject CreateObject (string object_name)
 Creates the object.
 
StorageObject GetObject (string object_name)
 Creates the Object.
 
List< StorageObjectGetObjects ()
 Gets a list of StorageObject objects.
 
List< StorageObjectGetObjects (bool full_listing)
 Gets a list of StorageObject objects.
 
List< StorageObjectGetObjects (Dictionary< ObjectQuery, string > query)
 Gets a list of StorageObject objects.
 
List< StorageObjectGetObjects (bool full_listing, Dictionary< ObjectQuery, string > query)
 Gets a list of StorageObject objects.
 
List< Dictionary< string,
string > > 
GetObjectList ()
 Gets a list of Dictionaries that contain storage object info.
 
List< Dictionary< string,
string > > 
GetObjectList (bool full_listing)
 Gets a list of Dictionaries that contain storage object info.
 
List< Dictionary< string,
string > > 
GetObjectList (Dictionary< ObjectQuery, string > query)
 Gets a list of Dictionaries that contain storage object info.
 
List< Dictionary< string,
string > > 
GetObjectList (bool full_listing, Dictionary< ObjectQuery, string > query)
 Gets a list of Dictionaries that contain storage object info.
 
void DeleteObject (string object_name)
 Deletes an Object.
 
void AddMetadata (Dictionary< string, string > metadata)
 Adds the metadata.
 
void AddHeaders (Dictionary< string, string > headers)
 Adds Headers.
 
void EnableStaticWeb (string index, string error, string css, bool listing)
 Add Static web headers.
 
void EnableStaticWeb (string index, string error, bool listing)
 Add Static web headers.
 
void EnableStaticWeb (string css, bool listing)
 Add Static web headers.
 
void EnableStaticWeb (string index, string error)
 Add Static web headers.
 
void DisableStaticWeb ()
 Turn off static web functionality.
 
void EnableObjectVersioning (string container)
 Enable object versioning.
 
void DisableObjectVersioning ()
 Turn off object versioning.
 

Properties

string Name [get]
 Gets the Container Name.
 
string ObjectVersionLocation [get]
 Gets the destination container for object versioning.
 
string WebIndex [get]
 The Web Index for the container.
 
string WebError [get]
 Gets the Web Error Prefix for the container.
 
string WebCSS [get]
 Gets the Web CSS for the container.
 
Dictionary< string, string > Headers [get]
 Gets Raw headers.
 
Dictionary< string, string > Metadata [get]
 Gets the metadata.
 
long ObjectCount [get]
 Gets the object count.
 
long BytesUsed [get]
 Gets the bytes used.
 
int Retries [get, set]
 Gets or sets the retries.
 
Uri StorageUrl [get]
 Gets the storage URL.
 
bool WebListingEnabled [get]
 Get a the Web Listing status on this container.
 
- Properties inherited from Rackspace.Cloudfiles.Container
string Name [get]
 
string ObjectVersionLocation [get]
 
string WebIndex [get]
 
string WebError [get]
 
string WebCSS [get]
 
Dictionary< string, string > Headers [get]
 
Dictionary< string, string > Metadata [get]
 
int Retries [get, set]
 
long ObjectCount [get]
 
long BytesUsed [get]
 
Uri StorageUrl [get]
 
bool WebListingEnabled [get]
 

Detailed Description

CF_Container object that provides Container level functionality and information

Constructor & Destructor Documentation

Rackspace.Cloudfiles.CF_Container.CF_Container ( Connection  conn,
Client  client,
string  container_name 
)

Initializes a new instance of the Rackspace.Cloudfiles.CF_Container class.

Parameters
connConn.
clientClient.
container_nameContainer_name.
Rackspace.Cloudfiles.CF_Container.CF_Container ( Connection  conn,
string  container_name 
)

Initializes a new instance of the Rackspace.Cloudfiles.CF_Container class.

Parameters
connConn.
container_nameContainer_name.

Member Function Documentation

void Rackspace.Cloudfiles.CF_Container.AddHeaders ( Dictionary< string, string >  headers)

Adds Headers.

Parameters
headersA Dictionary<System.String, System.String>

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.AddMetadata ( Dictionary< string, string >  metadata)

Adds the metadata.

Parameters
metadataMetadata.
Exceptions
ArgumentNullExceptionIs thrown when an argument passed to a method is invalid because it is .

Implements Rackspace.Cloudfiles.Container.

StorageObject Rackspace.Cloudfiles.CF_Container.CreateObject ( string  object_name)

Creates the object.

Returns
The object.
Parameters
object_nameObject_name.
Exceptions
ArgumentNullExceptionIs thrown when an argument passed to a method is invalid because it is .

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.DeleteObject ( string  object_name)

Deletes an Object.

Parameters
object_nameA System.String

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.DisableObjectVersioning ( )

Turn off object versioning.

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.DisableStaticWeb ( )

Turn off static web functionality.

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.EnableObjectVersioning ( string  container)

Enable object versioning.

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.EnableStaticWeb ( string  index,
string  error,
string  css,
bool  listing 
)

Add Static web headers.

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.EnableStaticWeb ( string  index,
string  error,
bool  listing 
)

Add Static web headers.

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.EnableStaticWeb ( string  css,
bool  listing 
)

Add Static web headers.

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.EnableStaticWeb ( string  index,
string  error 
)

Add Static web headers.

Implements Rackspace.Cloudfiles.Container.

StorageObject Rackspace.Cloudfiles.CF_Container.GetObject ( string  object_name)

Creates the Object.

Parameters
object_nameA System.String
Returns
A StorageObject

Implements Rackspace.Cloudfiles.Container.

List<Dictionary<string, string> > Rackspace.Cloudfiles.CF_Container.GetObjectList ( )

Gets a list of Dictionaries that contain storage object info.

Returns
A List<Dictionary<System.String, System.String>>

Implements Rackspace.Cloudfiles.Container.

List<Dictionary<string, string> > Rackspace.Cloudfiles.CF_Container.GetObjectList ( bool  full_listing)

Gets a list of Dictionaries that contain storage object info.

Parameters
full_listingA System.Boolean
Returns
A List<Dictionary<System.String, System.String>>

Implements Rackspace.Cloudfiles.Container.

List<Dictionary<string, string> > Rackspace.Cloudfiles.CF_Container.GetObjectList ( Dictionary< ObjectQuery, string >  query)

Gets a list of Dictionaries that contain storage object info.

Parameters
queryA Dictionary<ObjectQuery, System.String>
Returns
A List<Dictionary<System.String, System.String>>

Implements Rackspace.Cloudfiles.Container.

List<Dictionary<string, string> > Rackspace.Cloudfiles.CF_Container.GetObjectList ( bool  full_listing,
Dictionary< ObjectQuery, string >  query 
)

Gets a list of Dictionaries that contain storage object info.

Parameters
full_listingA System.Boolean
queryA Dictionary<ObjectQuery, System.String>
Returns
A List<Dictionary<System.String, System.String>>

Implements Rackspace.Cloudfiles.Container.

List<StorageObject> Rackspace.Cloudfiles.CF_Container.GetObjects ( )

Gets a list of StorageObject objects.

Returns
The objects.

Implements Rackspace.Cloudfiles.Container.

List<StorageObject> Rackspace.Cloudfiles.CF_Container.GetObjects ( bool  full_listing)

Gets a list of StorageObject objects.

Parameters
full_listingA System.Boolean
Returns
A List<StorageObject>

Implements Rackspace.Cloudfiles.Container.

List<StorageObject> Rackspace.Cloudfiles.CF_Container.GetObjects ( Dictionary< ObjectQuery, string >  query)

Gets a list of StorageObject objects.

Parameters
queryA Dictionary<ObjectQuery, System.String>
Returns
A List<StorageObject>

Implements Rackspace.Cloudfiles.Container.

List<StorageObject> Rackspace.Cloudfiles.CF_Container.GetObjects ( bool  full_listing,
Dictionary< ObjectQuery, string >  query 
)

Gets a list of StorageObject objects.

Parameters
full_listingA System.Boolean
queryA Dictionary<ObjectQuery, System.String>
Returns
A List<StorageObject>

Implements Rackspace.Cloudfiles.Container.

void Rackspace.Cloudfiles.CF_Container.ReloadMetadata ( )

Reload all metadata for the Container.

Property Documentation

long Rackspace.Cloudfiles.CF_Container.BytesUsed
get

Gets the bytes used.

The bytes used.

Dictionary<string, string> Rackspace.Cloudfiles.CF_Container.Headers
get

Gets Raw headers.

The headers.

Dictionary<string, string> Rackspace.Cloudfiles.CF_Container.Metadata
get

Gets the metadata.

The metadata.

string Rackspace.Cloudfiles.CF_Container.Name
get

Gets the Container Name.

The name.

long Rackspace.Cloudfiles.CF_Container.ObjectCount
get

Gets the object count.

The object count.

string Rackspace.Cloudfiles.CF_Container.ObjectVersionLocation
get

Gets the destination container for object versioning.

The destination container for object versioning.

int Rackspace.Cloudfiles.CF_Container.Retries
getset

Gets or sets the retries.

The retries.

Uri Rackspace.Cloudfiles.CF_Container.StorageUrl
get

Gets the storage URL.

The storage URL.

string Rackspace.Cloudfiles.CF_Container.WebCSS
get

Gets the Web CSS for the container.

The name.

string Rackspace.Cloudfiles.CF_Container.WebError
get

Gets the Web Error Prefix for the container.

The name.

string Rackspace.Cloudfiles.CF_Container.WebIndex
get

The Web Index for the container.

The web Index for the container..

bool Rackspace.Cloudfiles.CF_Container.WebListingEnabled
get

Get a the Web Listing status on this container.


The documentation for this class was generated from the following file: