Struct ProjectDumpArgs 

pub struct ProjectDumpArgs {
    pub server: Option<String>,
    pub project: Option<String>,
    pub skip_assets: bool,
    pub output: Option<PathBuf>,
    pub force: bool,
    pub cleanup: bool,
    pub timeout: u64,
    pub replace: bool,
    pub delete: bool,
    pub discard_other_project: bool,
    pub format: FormatArgs,
}

Arguments for dsp vre project dump.

Triggers a server-side project dump (a bagit-zip archive of the project’s data) and downloads it to a local file. Assets (images, audio, video, etc.) are included by default; use --skip-assets to download only the structured RDF data.

Requires a system-administrator token. Obtain one via dsp auth login --server <server> or set the DSP_TOKEN environment variable.

Fields

server: Option<String>

DSP server URL or shortcut (e.g. https://api.example.org or prod). Can also be set via the DSP_SERVER environment variable or a .env file.

project: Option<String>

Shortcode, shortname, or IRI of the project to dump.

skip_assets: bool

Skip binary assets (images, audio, video, etc.); download only the project’s structured RDF data. Assets are included by default.

output: Option<PathBuf>

Write the dump to this path instead of the default ./<shortcode>-<timestamp>.zip.

force: bool

Overwrite an existing output file. Without this flag, the command refuses to overwrite an existing path.

cleanup: bool

Delete the server-side dump after a successful download.

timeout: u64

Abort if the dump has not completed within this many seconds (must be at least 1).

replace: bool

Discard this project’s existing dump and create a fresh one. If the server’s single dump slot is held by a different project, this refuses unless --discard-other-project is also given.

delete: bool

Remove this project’s dump without downloading. If the slot is held by a different project, this is a no-op (it never removes another project’s dump).

discard_other_project: bool

Only valid with --replace. The DSP-API holds one dump server-wide; if the slot is held by a different project, also discard that project’s dump to make room. Without this, --replace refuses when the slot belongs to another project. (Distinct from --force, which only governs overwriting the local output file.)

format: FormatArgs

Trait Implementations

impl Args for ProjectDumpArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for ProjectDumpArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for ProjectDumpArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.