azure::storage::list_blob_item Class Reference

Represents an item that may be returned by a blob listing operation. More...

Public Member Functions
	list_blob_item (utility::string_t blob_name, utility::string_t snapshot_time, utility::string_t version_id, bool is_current_version, cloud_blob_container container, cloud_blob_properties properties, cloud_metadata metadata, copy_state copy_state)
	Initializes a new instance of the azure::storage::list_blob_item class that represents a cloud blob. More...
	list_blob_item (utility::string_t directory_name, cloud_blob_container container)
	Initializes a new instance of the azure::storage::list_blob_item class that represents a cloud blob directory. More...
bool	is_blob () const
	Gets a value indicating whether this azure::storage::list_blob_item represents a cloud blob or a cloud blob directory. More...
bool	is_current_version () const
	Gets a value indicating whether this azure::storage::list_blob_item represents current active version of a blob. More...
cloud_blob	as_blob () const
	Returns the item as an azure::storage::cloud_blob object, if and only if it represents a cloud blob. More...
cloud_blob_directory	as_directory () const
	Returns the item as an azure::storage::cloud_blob_directory object, if and only if it represents a cloud blob directory. More...

Detailed Description

Represents an item that may be returned by a blob listing operation.

Constructor & Destructor Documentation

list_blob_item() [1/2]

azure::storage::list_blob_item::list_blob_item ( utility::string_t  blob_name, utility::string_t  snapshot_time, utility::string_t  version_id, bool  is_current_version, cloud_blob_container  container, cloud_blob_properties  properties, cloud_metadata  metadata, copy_state  copy_state  )

inlineexplicit

Initializes a new instance of the azure::storage::list_blob_item class that represents a cloud blob.

Parameters

blob_name	The name of the blob.
snapshot_time	The snapshot timestamp, if the blob is a snapshot.
version_id	The version id of the blob.
is_current_version	If this blob version is current active version.
container	A reference to the parent container.
properties	A set of properties for the blob.
metadata	User-defined metadata for the blob.
copy_state	the state of the most recent or pending copy operation.

list_blob_item() [2/2]

azure::storage::list_blob_item::list_blob_item ( utility::string_t  directory_name, cloud_blob_container  container  )

inlineexplicit

Initializes a new instance of the azure::storage::list_blob_item class that represents a cloud blob directory.

Parameters

directory_name	Name of the virtual directory.
container	The container.

Member Function Documentation

as_blob()

cloud_blob azure::storage::list_blob_item::as_blob ( ) const

inline

Returns the item as an azure::storage::cloud_blob object, if and only if it represents a cloud blob.

Returns

An azure::storage::cloud_blob object.

as_directory()

cloud_blob_directory azure::storage::list_blob_item::as_directory ( ) const

inline

Returns the item as an azure::storage::cloud_blob_directory object, if and only if it represents a cloud blob directory.

Returns

An azure::storage::cloud_blob_directory object.

is_blob()

bool azure::storage::list_blob_item::is_blob ( ) const

inline

Gets a value indicating whether this azure::storage::list_blob_item represents a cloud blob or a cloud blob directory.

Returns

true if this azure::storage::list_blob_item represents a cloud blob; otherwise, false.

is_current_version()

bool azure::storage::list_blob_item::is_current_version ( ) const

inline

Gets a value indicating whether this azure::storage::list_blob_item represents current active version of a blob.

Returns

true if this azure::storage::list_blob_item represents current active version of a blob; otherwise, false.