Struct ResourceDescribeArgs 

pub struct ResourceDescribeArgs {
    pub server: Option<String>,
    pub resource: Option<String>,
    pub project: Option<String>,
    pub values: bool,
    pub format: FormatArgs,
}

Arguments for dsp vre resource describe.

Fetches the envelope metadata of a single resource by its internal IRI. Authentication is optional; anonymous callers see only publicly-visible resources. Use --project to assert that the resource belongs to the expected project (a cross-project guard — fails if the resource’s attached project does not match).

ARK addressing is not supported in v1. Use the resource’s internal IRI (e.g. http://rdfh.ch/0803/AbCdEf) as returned by dsp vre resource list.

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.

resource: Option<String>

Internal IRI of the resource to describe (e.g. http://rdfh.ch/0803/AbCdEf). ARK addressing is not supported in v1 — use the internal IRI directly. Run dsp vre resource list to discover resource IRIs.

project: Option<String>

Shortcode, shortname, or IRI of the expected project. When given, the command fails with a usage error unless the resource’s attached project matches this value. Omit to describe a resource regardless of project.

values: bool

Include the resource’s field values in the output (off by default; metadata envelope only when omitted). In prose and json this adds a values section on top of the metadata; in tabular formats (csv, tsv, lines) the output becomes one row per value instead of the metadata row. Resolving field and list-item labels requires additional server requests. See also: dsp docs concepts

format: FormatArgs

Trait Implementations

impl Args for ResourceDescribeArgs

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 ResourceDescribeArgs

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

Formats the value using the given formatter.

impl FromArgMatches for ResourceDescribeArgs

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.