Struct CreateNotebookRequest 

pub struct CreateNotebookRequest { /* private fields */ }

Implementations

impl CreateNotebookRequest

pub fn builder() -> Builder<TitleStage>

Returns a new builder.

impl CreateNotebookRequest

pub fn title(&self) -> &str

pub fn description(&self) -> &str

pub fn notebook_type(&self) -> Option<&NotebookType>

Optional for backcompatibility. Default is a normal workbook.

pub fn is_draft(&self) -> bool

pub fn state_as_json(&self) -> &str

pub fn charts(&self) -> Option<&[ChartWithOverlays]>

👎Deprecated:

charts are now stored in contentV2

pub fn run_rid(&self) -> Option<&RunRid>

deprecated. Use dataScope instead

pub fn data_scope(&self) -> Option<&NotebookDataScope>

Optional for back-compatibility.

pub fn layout(&self) -> &WorkbookLayout

pub fn content(&self) -> Option<&WorkbookContent>

👎Deprecated:

use contentV2 instead

pub fn content_v2(&self) -> Option<&UnifiedWorkbookContent>

Optional for backcompatibility

pub fn event_refs(&self) -> &BTreeSet<EventReference>

Field to pin events to a workbook on creation.

pub fn check_alert_refs(&self) -> Option<&BTreeSet<CheckAlertReference>>

👎Deprecated:

CheckAlerts are no longer supported and will be removed in the future. Use eventRefs to pin events to workbooks instead.

Field to pin check alerts to a workbook on creation. Any specified CheckAlertReference will be added to the workbook along with it’s corresponding EventReference.

pub fn workspace(&self) -> Option<&WorkspaceRid>

The workspace in which to create the workbook. If not provided, the workbook will be created in the default workspace for the user’s organization, if the default workspace for the organization is configured.

pub fn preview_image(&self) -> Option<&ThemeAwareImage>

Theme-aware preview image for the workbook. Falls back to a default illustration if not provided.

Trait Implementations

impl Clone for CreateNotebookRequest

fn clone(&self) -> CreateNotebookRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateNotebookRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateNotebookRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CreateNotebookRequest> for Builder<Complete>

fn from(v: CreateNotebookRequest) -> Self

Converts to this type from the input type.

impl Hash for CreateNotebookRequest

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CreateNotebookRequest

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CreateNotebookRequest

fn eq(&self, other: &Self) -> 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 PartialOrd for CreateNotebookRequest

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CreateNotebookRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CreateNotebookRequest