Struct DocumentInfo 

#[non_exhaustive]
pub struct DocumentInfo {
    pub document_id: String,
    pub attributes: Option<Vec<DocumentAttribute>>,
}

Identifies a document for which to retrieve status information

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

document_id: String

The identifier of the document.

attributes: Option<Vec<DocumentAttribute>>

Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version

• datasourceId

• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.

• version is ignored if dataSourceId and jobExecutionId are not provided.

• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

Implementations

impl DocumentInfo

pub fn document_id(&self) -> &str

The identifier of the document.

pub fn attributes(&self) -> &[DocumentAttribute]

Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version

• datasourceId

• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.

• version is ignored if dataSourceId and jobExecutionId are not provided.

• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attributes.is_none().

impl DocumentInfo

pub fn builder() -> DocumentInfoBuilder

Creates a new builder-style object to manufacture DocumentInfo.

Trait Implementations

impl Clone for DocumentInfo

fn clone(&self) -> DocumentInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentInfo

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

Formats the value using the given formatter.

impl PartialEq for DocumentInfo

fn eq(&self, other: &DocumentInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentInfo