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 Types | Public Member Functions | Static Public Member Functions | List of all members
azure::storage::sequence_number Class Reference

Describes actions that can be performed on a page blob sequence number. More...

Public Types

enum  sequence_number_action { sequence_number_action::maximum, sequence_number_action::update, sequence_number_action::increment }
 

Public Member Functions

sequence_number_action action () const
 Gets the action that will be performed on a page blob sequence number. More...
 
int64_t value () const
 Gets the page blob's sequence number. More...
 

Static Public Member Functions

static sequence_number maximum (int64_t value)
 Constructs a sequence number action to set the higher of two values: the value included on the request, or the value currently stored for the blob. More...
 
static sequence_number update (int64_t value)
 Constructs a sequence number action to set the sequence number to the value included with the request. More...
 
static sequence_number increment ()
 Constructs a sequence number action to increment the value of the sequence number by 1. More...
 

Detailed Description

Describes actions that can be performed on a page blob sequence number.

Member Enumeration Documentation

◆ sequence_number_action

Enumerator
maximum 

Sets the sequence number to be the higher of two values: the value included on the request, or the value currently stored for the blob.

update 

Sets the sequence number to the value included with the request.

increment 

Increments the value of the sequence number by 1.

Member Function Documentation

◆ action()

sequence_number_action azure::storage::sequence_number::action ( ) const
inline

Gets the action that will be performed on a page blob sequence number.

Returns
The sequence number action.

◆ increment()

static sequence_number azure::storage::sequence_number::increment ( )
inlinestatic

Constructs a sequence number action to increment the value of the sequence number by 1.

Returns
An azure::storage::sequence_number object that represents the action.

◆ maximum()

static sequence_number azure::storage::sequence_number::maximum ( int64_t  value)
inlinestatic

Constructs a sequence number action to set the higher of two values: the value included on the request, or the value currently stored for the blob.

Parameters
valueThe sequence number.
Returns
An azure::storage::sequence_number object that represents the action.

◆ update()

static sequence_number azure::storage::sequence_number::update ( int64_t  value)
inlinestatic

Constructs a sequence number action to set the sequence number to the value included with the request.

Parameters
valueThe sequence number.
Returns
An azure::storage::sequence_number object that represents the action.

◆ value()

int64_t azure::storage::sequence_number::value ( ) const
inline

Gets the page blob's sequence number.

Returns
The sequence number.