Microsoft Azure Storage Client Library for C++  7.5.0
The Microsoft Azure Storage Client Library for C++ is a library for working with the Azure Storage Services in C++.
Public Member Functions | List of all members
azure::storage::copy_state Class Reference

Represents the attributes of a copy blob operation. More...

Public Member Functions

 copy_state (const copy_state &other)
 
copy_stateoperator= (const copy_state &other)
 
 copy_state (copy_state &&other)
 Initializes a new instance of the azure::storage::copy_state class based on an existing instance. More...
 
copy_stateoperator= (copy_state &&other)
 Returns a reference to an azure::storage::copy_state object. More...
 
const utility::string_t & copy_id () const
 Gets the ID of the copy blob operation. More...
 
utility::datetime completion_time () const
 Gets the time that the copy blob operation completed, and indicates whether completion was due to a successful copy, whether the operation was cancelled, or whether the operation failed. More...
 
copy_status status () const
 Gets the status of the copy blob operation. More...
 
const web::http::uri & source () const
 Gets the URI of the source blob for a copy operation. More...
 
const utility::string_t & source_raw () const
 Gets the URI string of the source blob for a copy operation. More...
 
int64_t bytes_copied () const
 Gets the number of bytes copied in the operation so far. More...
 
int64_t total_bytes () const
 Gets the total number of bytes in the source blob for the copy operation. More...
 
const utility::string_t & status_description () const
 Gets the description of the current status of the copy blob operation, if status is available. More...
 
utility::datetime destination_snapshot_time () const
 Gets the incremental destination snapshot time for the latest incremental copy, if the time is available. More...
 

Detailed Description

Represents the attributes of a copy blob operation.

Constructor & Destructor Documentation

◆ copy_state()

azure::storage::copy_state::copy_state ( copy_state &&  other)
inline

Initializes a new instance of the azure::storage::copy_state class based on an existing instance.

Parameters
otherAn existing azure::storage::copy_state object.

Member Function Documentation

◆ bytes_copied()

int64_t azure::storage::copy_state::bytes_copied ( ) const
inline

Gets the number of bytes copied in the operation so far.

Returns
The number of bytes copied in the operation so far.

◆ completion_time()

utility::datetime azure::storage::copy_state::completion_time ( ) const
inline

Gets the time that the copy blob operation completed, and indicates whether completion was due to a successful copy, whether the operation was cancelled, or whether the operation failed.

Returns
A utility::datetime containing the completion time.

◆ copy_id()

const utility::string_t& azure::storage::copy_state::copy_id ( ) const
inline

Gets the ID of the copy blob operation.

Returns
An ID string for the copy operation.

◆ destination_snapshot_time()

utility::datetime azure::storage::copy_state::destination_snapshot_time ( ) const
inline

Gets the incremental destination snapshot time for the latest incremental copy, if the time is available.

Returns
A utility::datetime containing the destination snapshot time for the latest incremental copy.

◆ operator=()

copy_state& azure::storage::copy_state::operator= ( copy_state &&  other)
inline

Returns a reference to an azure::storage::copy_state object.

Parameters
otherAn existing azure::storage::copy_state object to use to set properties.
Returns
An azure::storage::copy_state object with properties set.

◆ source()

const web::http::uri& azure::storage::copy_state::source ( ) const
inline

Gets the URI of the source blob for a copy operation.

Returns
A web::http::uri indicating the source of a copy operation.

◆ source_raw()

const utility::string_t& azure::storage::copy_state::source_raw ( ) const
inline

Gets the URI string of the source blob for a copy operation.

Returns
A utility::string_t indicating the source of a copy operation.

◆ status()

copy_status azure::storage::copy_state::status ( ) const
inline

Gets the status of the copy blob operation.

Returns
An azure::storage::copy_status enumeration indicating the status of the copy operation.

◆ status_description()

const utility::string_t& azure::storage::copy_state::status_description ( ) const
inline

Gets the description of the current status of the copy blob operation, if status is available.

Returns
A status description string.

◆ total_bytes()

int64_t azure::storage::copy_state::total_bytes ( ) const
inline

Gets the total number of bytes in the source blob for the copy operation.

Returns
The number of bytes in the source blob.