C# Class CommandLineParser, TabMigrate

Gives parsed values for the command line arguments
Show file Open project: tableau/TabMigrate Class Usage Examples

Public Methods

Method Description
GenerateCommandLine_SiteExport ( bool showPasswordInUi, string pathToExportDir, string siteUrl, string userName, string password, bool isSiteAdmin, string exportSingleProject, string exportOnlyWithTag, bool removeExportTag, string pathToLogFile, string pathToErrorsFile, bool backgroundKeepAliveRequests, bool logVerbose, bool generateDownloadInfoFiles, string &commandLineOut, CommandLineParser, &parsedCommandLine ) : void

Gives us an example command line for getting a site inventory

GenerateCommandLine_SiteInventory ( bool showPasswordInUi, string pathToOutputFile, string siteUrl, string userName, string password, bool isSystemAdmin, string pathToLogFile, string pathToErrorsFile, bool generateTwbFile, bool logVerbose, string &commandLineOut, CommandLineParser, &parsedCommandLine ) : void

Gives us an example command line for getting a site inventory

HasUseableCommandLine ( CommandLineParser, commandLine ) : bool

TRUE if we believe there is enough information in the command line to proceed with running the headless task

Private Methods

Method Description
GenerateCommandLine_SiteImport ( bool showPasswordInUi, string pathToImportFrom, string siteUrl, string userName, string password, bool isSiteAdmin, bool remapDataServerReferences, string pathToDbCredentialsFile, string pathToLogFile, string pathToErrorsFile, string pathToManualStepsFile, bool remapContentOwnership, bool logVerbose, string &commandLineOut, CommandLineParser, &parsedCommandLine ) : void

Site import from local file system

helper_AppendParameter ( List arguments, StringBuilder sb, string param, string value ) : void

Appends a paramter and value

helper_AppendParameter ( List arguments, StringBuilder sb, string param, string value, string valueForStringBuilder ) : void

Appends a paramter and value

helper_BoolToText ( bool b ) : string

Simple conversion bool to text

helper_DetermineIfDummyPasswordNeeded ( bool showPasswordInUi, string password ) : string

Determines whether we are showing the dummy password or not

Method Details

GenerateCommandLine_SiteExport() public static method

Gives us an example command line for getting a site inventory
public static GenerateCommandLine_SiteExport ( bool showPasswordInUi, string pathToExportDir, string siteUrl, string userName, string password, bool isSiteAdmin, string exportSingleProject, string exportOnlyWithTag, bool removeExportTag, string pathToLogFile, string pathToErrorsFile, bool backgroundKeepAliveRequests, bool logVerbose, bool generateDownloadInfoFiles, string &commandLineOut, CommandLineParser, &parsedCommandLine ) : void
showPasswordInUi bool
pathToExportDir string
siteUrl string
userName string
password string
isSiteAdmin bool
exportSingleProject string
exportOnlyWithTag string
removeExportTag bool
pathToLogFile string
pathToErrorsFile string
backgroundKeepAliveRequests bool
logVerbose bool
generateDownloadInfoFiles bool
commandLineOut string Command line as text ready to show the user
parsedCommandLine CommandLineParser, Command line as set of
return void

GenerateCommandLine_SiteInventory() public static method

Gives us an example command line for getting a site inventory
public static GenerateCommandLine_SiteInventory ( bool showPasswordInUi, string pathToOutputFile, string siteUrl, string userName, string password, bool isSystemAdmin, string pathToLogFile, string pathToErrorsFile, bool generateTwbFile, bool logVerbose, string &commandLineOut, CommandLineParser, &parsedCommandLine ) : void
showPasswordInUi bool
pathToOutputFile string
siteUrl string
userName string
password string
isSystemAdmin bool
pathToLogFile string
pathToErrorsFile string
generateTwbFile bool
logVerbose bool
commandLineOut string Command line as text ready to show the user
parsedCommandLine CommandLineParser, Command line as set of
return void

HasUseableCommandLine() public static method

TRUE if we believe there is enough information in the command line to proceed with running the headless task
public static HasUseableCommandLine ( CommandLineParser, commandLine ) : bool
commandLine CommandLineParser,
return bool