Struct SharedDashboard 

#[non_exhaustive]
pub struct SharedDashboard {

    pub author: Option<SharedDashboardAuthor>,
    pub created: Option<DateTime<Utc>>,
    pub dashboard_id: String,
    pub dashboard_type: DashboardType,
    pub embeddable_domains: Option<Vec<String>>,
    pub expiration: Option<Option<DateTime<Utc>>>,
    pub global_time: Option<DashboardGlobalTime>,
    pub global_time_selectable_enabled: Option<Option<bool>>,
    pub invitees: Option<Vec<SharedDashboardInviteesItems>>,
    pub last_accessed: Option<Option<DateTime<Utc>>>,
    pub public_url: Option<String>,
    pub selectable_template_vars: Option<Option<Vec<SelectableTemplateVariableItems>>>,
    pub share_list: Option<Option<Vec<String>>>,
    pub share_type: Option<Option<DashboardShareType>>,
    pub status: Option<SharedDashboardStatus>,
    pub title: Option<String>,
    pub token: Option<String>,
    pub viewing_preferences: Option<ViewingPreferences>,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

The metadata object associated with how a dashboard has been/will be shared.

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.

author: Option<SharedDashboardAuthor>

User who shared the dashboard.

created: Option<DateTime<Utc>>

Date the dashboard was shared.

dashboard_id: String

ID of the dashboard to share.

dashboard_type: DashboardType

The type of the associated private dashboard.

embeddable_domains: Option<Vec<String>>

The SharedDashboard embeddable_domains.

expiration: Option<Option<DateTime<Utc>>>

The time when an OPEN shared dashboard becomes publicly unavailable.

global_time: Option<DashboardGlobalTime>

Object containing the live span selection for the dashboard.

global_time_selectable_enabled: Option<Option<bool>>

Whether to allow viewers to select a different global time setting for the shared dashboard.

invitees: Option<Vec<SharedDashboardInviteesItems>>

The SharedDashboard invitees.

last_accessed: Option<Option<DateTime<Utc>>>

The last time the shared dashboard was accessed. Null if never accessed.

public_url: Option<String>

URL of the shared dashboard.

selectable_template_vars: Option<Option<Vec<SelectableTemplateVariableItems>>>

List of objects representing template variables on the shared dashboard which can have selectable values.

share_list: Option<Option<Vec<String>>>

👎Deprecated

List of email addresses that can receive an invitation to access to the shared dashboard.

share_type: Option<Option<DashboardShareType>>

Type of sharing access (either open to anyone who has the public URL or invite-only).

status: Option<SharedDashboardStatus>

Active means the dashboard is publicly available. Paused means the dashboard is not publicly available.

title: Option<String>

Title of the shared dashboard.

token: Option<String>

A unique token assigned to the shared dashboard.

viewing_preferences: Option<ViewingPreferences>

The viewing preferences for a shared dashboard.

additional_properties: BTreeMap<String, Value>

Implementations

impl SharedDashboard

pub fn new( dashboard_id: String, dashboard_type: DashboardType, ) -> SharedDashboard

Examples found in repository

examples/v1_dashboards_CreatePublicDashboard.rs (line 14)

async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
        .global_time(
            DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
        )
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_public_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v1_dashboards_CreatePublicDashboard_1668947073.rs (line 15)

async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
        .global_time(
            DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
        )
        .selectable_template_vars(Some(vec![SelectableTemplateVariableItems::new()
            .default_value("*".to_string())
            .name("group_by_var".to_string())
            .type_(Some("group".to_string()))
            .visible_tags(Some(vec![
                "selectableValue1".to_string(),
                "selectableValue2".to_string(),
            ]))]))
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_public_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn author(self, value: SharedDashboardAuthor) -> Self

pub fn created(self, value: DateTime<Utc>) -> Self

pub fn embeddable_domains(self, value: Vec<String>) -> Self

pub fn expiration(self, value: Option<DateTime<Utc>>) -> Self

pub fn global_time(self, value: DashboardGlobalTime) -> Self

Examples found in repository

examples/v1_dashboards_CreatePublicDashboard.rs (lines 15-17)

async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
        .global_time(
            DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
        )
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_public_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v1_dashboards_CreatePublicDashboard_1668947073.rs (lines 16-18)

async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
        .global_time(
            DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
        )
        .selectable_template_vars(Some(vec![SelectableTemplateVariableItems::new()
            .default_value("*".to_string())
            .name("group_by_var".to_string())
            .type_(Some("group".to_string()))
            .visible_tags(Some(vec![
                "selectableValue1".to_string(),
                "selectableValue2".to_string(),
            ]))]))
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_public_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn global_time_selectable_enabled(self, value: Option<bool>) -> Self

pub fn invitees(self, value: Vec<SharedDashboardInviteesItems>) -> Self

pub fn last_accessed(self, value: Option<DateTime<Utc>>) -> Self

pub fn public_url(self, value: String) -> Self

pub fn selectable_template_vars( self, value: Option<Vec<SelectableTemplateVariableItems>>, ) -> Self

Examples found in repository

examples/v1_dashboards_CreatePublicDashboard_1668947073.rs (lines 19-26)

async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
        .global_time(
            DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
        )
        .selectable_template_vars(Some(vec![SelectableTemplateVariableItems::new()
            .default_value("*".to_string())
            .name("group_by_var".to_string())
            .type_(Some("group".to_string()))
            .visible_tags(Some(vec![
                "selectableValue1".to_string(),
                "selectableValue2".to_string(),
            ]))]))
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_public_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn share_list(self, value: Option<Vec<String>>) -> Self

pub fn share_type(self, value: Option<DashboardShareType>) -> Self

Examples found in repository

examples/v1_dashboards_CreatePublicDashboard.rs (line 18)

async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
        .global_time(
            DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
        )
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_public_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v1_dashboards_CreatePublicDashboard_1668947073.rs (line 27)

async fn main() {
    // there is a valid "dashboard" in the system
    let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
    let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
        .global_time(
            DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
        )
        .selectable_template_vars(Some(vec![SelectableTemplateVariableItems::new()
            .default_value("*".to_string())
            .name("group_by_var".to_string())
            .type_(Some("group".to_string()))
            .visible_tags(Some(vec![
                "selectableValue1".to_string(),
                "selectableValue2".to_string(),
            ]))]))
        .share_type(Some(DashboardShareType::OPEN));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_public_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn status(self, value: SharedDashboardStatus) -> Self

pub fn title(self, value: String) -> Self

pub fn token(self, value: String) -> Self

pub fn viewing_preferences(self, value: ViewingPreferences) -> Self

pub fn additional_properties(self, value: BTreeMap<String, Value>) -> Self

Trait Implementations

impl Clone for SharedDashboard

fn clone(&self) -> SharedDashboard

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SharedDashboard

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SharedDashboard

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SharedDashboard

fn eq(&self, other: &SharedDashboard) -> 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 Serialize for SharedDashboard

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SharedDashboard