Seismic Drive Client API
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
seismicdrive::SDManager Class Reference

#include <SDManager.h>

Public Types

typedef std::string(* AuthProviderCallback) (const void *data)
 

Public Member Functions

 SDManager (const std::string &sdurl="", const std::string &sdapikey="", const int16_t logLevel=0)
 
 ~SDManager ()
 
 SDManager (SDManager &&sdsm) noexcept
 
SDManageroperator= (SDManager &&sdsm) noexcept
 
 SDManager (const SDManager &op)
 
SDManageroperator= (const SDManager &op)
 
void setAuthProviderFromImpToken (const std::string &impersonation_token="")
 
void setAuthProviderFromString (const std::string &idtoken)
 
void setAuthProviderCallback (AuthProviderCallback callback, const void *data=nullptr)
 
std::string getIDToken () const
 
std::string getSDUrl () const
 
std::string getSDApiKey () const
 
std::string serialize () const
 
void setLogStatus (const bool status)
 
bool getLogStatus () const
 
bool isTranslateUserInfo () const
 
void translateUserInfo (bool status)
 
void setLogLevel (int level)
 
int getLogLevel () const
 
uint_least16_t getVersionMajor () const
 
uint_least16_t getVersionMinor () const
 
uint_least16_t getVersionPatch () const
 
std::string getVersion () const
 
void setExponentialRetryBackoffPolicy (const ExponentialRetryBackoffPolicy *policy, HttpConnectionLink link)
 
std::shared_ptr< const ExponentialRetryBackoffPolicygetExponentialRetryBackoffPolicy (HttpConnectionLink link) const
 
void setCredentialsProvider (const std::string &authProvider, const std::vector< std::string > &args)
 
void setAuthProviderSauth (const std::string &clientID="", const std::string &filepath="")
 
void setAuthProviderSauthV2 (const std::string &clientID, const std::string &clientSecret, const std::string &clientCredentialsFile="")
 
void setAuthProviderServiceSauth (const std::string &projectID="", const std::string &serviceID="", const std::string &privateKey="")
 
void setAuthProviderServiceSauthV2 (const std::string &clientID, const std::string &clientSecret)
 
void setAuthProviderFromFile (const std::string &clientID, const std::string &filepath="")
 
void setAuthProviderFromFileV2 (const std::string &clientID, const std::string &clientSecret, const std::string &filepath="")
 
void setAuthProviderSauthImpersonationToken (const std::string &clientId, const std::string &clientSecret, const std::string &impersonationToken="", const std::string &impersonationTokenContext="")
 
void setAuthProviderSauthSinglePageApp (const std::string &clientID, const std::string &accessToken, const std::string &refreshToken)
 
void setAuthProviderSauthSinglePageApp (const std::string &clientID, const std::string &accessToken, const std::string &refreshToken, const std::string &credentialsFileName)
 
void setAuthProviderSauthSinglePageApp (const std::string &clientID, const std::string &credentialsFileName)
 

Static Public Member Functions

static SDManagercreate (const std::string &sd_manager_serialized)
 
static const std::map< std::string, std::string > & getHttpHeaders ()
 
static std::map< std::string, std::string > copyHttpHeaders ()
 
static void setHttpHeaders (const std::map< std::string, std::string > &httpHeaders, bool clearExistingHeaders=true)
 
static void clearHttpHeaders ()
 
static uint_least16_t versionMajor ()
 
static uint_least16_t versionMinor ()
 
static uint_least16_t versionPatch ()
 
static std::string version ()
 
static SDManagercreate (const std::string &sd_manager_serialized, const std::string &clientId, const std::string &clientSecret)
 

Friends

class SDDataset
 
class SDManagerImplTest
 
class SDReadOnlyGenericDatasetAccessor
 
class SeismicStore
 

Member Typedef Documentation

◆ AuthProviderCallback

typedef std::string(* seismicdrive::SDManager::AuthProviderCallback) (const void *data)

Constructor & Destructor Documentation

◆ SDManager() [1/3]

seismicdrive::SDManager::SDManager ( const std::string &  sdurl = "",
const std::string &  sdapikey = "",
const int16_t  logLevel = 0 
)

◆ ~SDManager()

seismicdrive::SDManager::~SDManager ( )

◆ SDManager() [2/3]

seismicdrive::SDManager::SDManager ( SDManager &&  sdsm)
noexcept

◆ SDManager() [3/3]

seismicdrive::SDManager::SDManager ( const SDManager op)

Member Function Documentation

◆ clearHttpHeaders()

void seismicdrive::SDManager::clearHttpHeaders ( )
static

◆ copyHttpHeaders()

std::map< std::string, std::string > seismicdrive::SDManager::copyHttpHeaders ( )
static

◆ create() [1/2]

static SDManager* seismicdrive::SDManager::create ( const std::string &  sd_manager_serialized)
static

◆ create() [2/2]

static SDManager* seismicdrive::SDManager::create ( const std::string &  sd_manager_serialized,
const std::string &  clientId,
const std::string &  clientSecret 
)
static

◆ getExponentialRetryBackoffPolicy()

std::shared_ptr<const ExponentialRetryBackoffPolicy> seismicdrive::SDManager::getExponentialRetryBackoffPolicy ( HttpConnectionLink  link) const

◆ getHttpHeaders()

const std::map< std::string, std::string > & seismicdrive::SDManager::getHttpHeaders ( )
static

◆ getIDToken()

std::string seismicdrive::SDManager::getIDToken ( ) const

◆ getLogLevel()

int seismicdrive::SDManager::getLogLevel ( ) const

◆ getLogStatus()

bool seismicdrive::SDManager::getLogStatus ( ) const

◆ getSDApiKey()

std::string seismicdrive::SDManager::getSDApiKey ( ) const

◆ getSDUrl()

std::string seismicdrive::SDManager::getSDUrl ( ) const

◆ getVersion()

std::string seismicdrive::SDManager::getVersion ( ) const

Deprecated. Use version() instead.

◆ getVersionMajor()

uint_least16_t seismicdrive::SDManager::getVersionMajor ( ) const

Deprecated. Use versionMajor() instead.

◆ getVersionMinor()

uint_least16_t seismicdrive::SDManager::getVersionMinor ( ) const

Deprecated. Use versionMinor() instead.

◆ getVersionPatch()

uint_least16_t seismicdrive::SDManager::getVersionPatch ( ) const

Deprecated. Use versionPatch() instead.

◆ isTranslateUserInfo()

bool seismicdrive::SDManager::isTranslateUserInfo ( ) const

◆ operator=() [1/2]

SDManager& seismicdrive::SDManager::operator= ( SDManager &&  sdsm)
noexcept

◆ operator=() [2/2]

SDManager& seismicdrive::SDManager::operator= ( const SDManager op)

◆ serialize()

std::string seismicdrive::SDManager::serialize ( ) const

◆ setAuthProviderCallback()

void seismicdrive::SDManager::setAuthProviderCallback ( AuthProviderCallback  callback,
const void *  data = nullptr 
)

◆ setAuthProviderFromFile()

void seismicdrive::SDManager::setAuthProviderFromFile ( const std::string &  clientID,
const std::string &  filepath = "" 
)

◆ setAuthProviderFromFileV2()

void seismicdrive::SDManager::setAuthProviderFromFileV2 ( const std::string &  clientID,
const std::string &  clientSecret,
const std::string &  filepath = "" 
)

◆ setAuthProviderFromImpToken()

void seismicdrive::SDManager::setAuthProviderFromImpToken ( const std::string &  impersonation_token = "")

◆ setAuthProviderFromString()

void seismicdrive::SDManager::setAuthProviderFromString ( const std::string &  idtoken)

◆ setAuthProviderSauth()

void seismicdrive::SDManager::setAuthProviderSauth ( const std::string &  clientID = "",
const std::string &  filepath = "" 
)

◆ setAuthProviderSauthImpersonationToken()

void seismicdrive::SDManager::setAuthProviderSauthImpersonationToken ( const std::string &  clientId,
const std::string &  clientSecret,
const std::string &  impersonationToken = "",
const std::string &  impersonationTokenContext = "" 
)

◆ setAuthProviderSauthSinglePageApp() [1/3]

void seismicdrive::SDManager::setAuthProviderSauthSinglePageApp ( const std::string &  clientID,
const std::string &  accessToken,
const std::string &  refreshToken 
)

◆ setAuthProviderSauthSinglePageApp() [2/3]

void seismicdrive::SDManager::setAuthProviderSauthSinglePageApp ( const std::string &  clientID,
const std::string &  accessToken,
const std::string &  refreshToken,
const std::string &  credentialsFileName 
)

◆ setAuthProviderSauthSinglePageApp() [3/3]

void seismicdrive::SDManager::setAuthProviderSauthSinglePageApp ( const std::string &  clientID,
const std::string &  credentialsFileName 
)

◆ setAuthProviderSauthV2()

void seismicdrive::SDManager::setAuthProviderSauthV2 ( const std::string &  clientID,
const std::string &  clientSecret,
const std::string &  clientCredentialsFile = "" 
)

◆ setAuthProviderServiceSauth()

void seismicdrive::SDManager::setAuthProviderServiceSauth ( const std::string &  projectID = "",
const std::string &  serviceID = "",
const std::string &  privateKey = "" 
)

◆ setAuthProviderServiceSauthV2()

void seismicdrive::SDManager::setAuthProviderServiceSauthV2 ( const std::string &  clientID,
const std::string &  clientSecret 
)

◆ setCredentialsProvider()

void seismicdrive::SDManager::setCredentialsProvider ( const std::string &  authProvider,
const std::vector< std::string > &  args 
)

◆ setExponentialRetryBackoffPolicy()

void seismicdrive::SDManager::setExponentialRetryBackoffPolicy ( const ExponentialRetryBackoffPolicy policy,
HttpConnectionLink  link 
)

◆ setHttpHeaders()

void seismicdrive::SDManager::setHttpHeaders ( const std::map< std::string, std::string > &  httpHeaders,
bool  clearExistingHeaders = true 
)
static

◆ setLogLevel()

void seismicdrive::SDManager::setLogLevel ( int  level)

◆ setLogStatus()

void seismicdrive::SDManager::setLogStatus ( const bool  status)

◆ translateUserInfo()

void seismicdrive::SDManager::translateUserInfo ( bool  status)

◆ version()

static std::string seismicdrive::SDManager::version ( )
static

◆ versionMajor()

static uint_least16_t seismicdrive::SDManager::versionMajor ( )
static

◆ versionMinor()

static uint_least16_t seismicdrive::SDManager::versionMinor ( )
static

◆ versionPatch()

static uint_least16_t seismicdrive::SDManager::versionPatch ( )
static

Friends And Related Function Documentation

◆ SDDataset

friend class SDDataset
friend

◆ SDManagerImplTest

friend class SDManagerImplTest
friend

◆ SDReadOnlyGenericDatasetAccessor

friend class SDReadOnlyGenericDatasetAccessor
friend

◆ SeismicStore

friend class SeismicStore
friend

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