Struct datadog_api_client::datadogV1::api::api_notebooks::ListNotebooksOptionalParams

#[non_exhaustive]
pub struct ListNotebooksOptionalParams {
    pub author_handle: Option<String>,
    pub exclude_author_handle: Option<String>,
    pub start: Option<i64>,
    pub count: Option<i64>,
    pub sort_field: Option<String>,
    pub sort_dir: Option<String>,
    pub query: Option<String>,
    pub include_cells: Option<bool>,
    pub is_template: Option<bool>,
    pub type_: Option<String>,
}

ListNotebooksOptionalParams is a struct for passing parameters to the method NotebooksAPI::list_notebooks

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_handle: Option<String>

Return notebooks created by the given author_handle.

exclude_author_handle: Option<String>

Return notebooks not created by the given author_handle.

start: Option<i64>

The index of the first notebook you want returned.

count: Option<i64>

The number of notebooks to be returned.

sort_field: Option<String>

Sort by field modified, name, or created.

sort_dir: Option<String>

Sort by direction asc or desc.

query: Option<String>

Return only notebooks with query string in notebook name or author handle.

include_cells: Option<bool>

Value of false excludes the cells and global time for each notebook.

is_template: Option<bool>

True value returns only template notebooks. Default is false (returns only non-template notebooks).

type_: Option<String>

If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.

Implementations

impl ListNotebooksOptionalParams

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

Return notebooks created by the given author_handle.

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

Return notebooks not created by the given author_handle.

pub fn start(self, value: i64) -> Self

The index of the first notebook you want returned.

pub fn count(self, value: i64) -> Self

The number of notebooks to be returned.

Examples found in repository

examples/v1_notebooks_ListNotebooks_788665428.rs (line 13)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = NotebooksAPI::with_config(configuration);
    let response =
        api.list_notebooks_with_pagination(ListNotebooksOptionalParams::default().count(2));
    pin_mut!(response);
    while let Some(resp) = response.next().await {
        if let Ok(value) = resp {
            println!("{:#?}", value);
        } else {
            println!("{:#?}", resp.unwrap_err());
        }
    }
}

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

Sort by field modified, name, or created.

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

Sort by direction asc or desc.

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

Return only notebooks with query string in notebook name or author handle.

pub fn include_cells(self, value: bool) -> Self

Value of false excludes the cells and global time for each notebook.

pub fn is_template(self, value: bool) -> Self

True value returns only template notebooks. Default is false (returns only non-template notebooks).

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

If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.

Trait Implementations

impl Clone for ListNotebooksOptionalParams

fn clone(&self) -> ListNotebooksOptionalParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListNotebooksOptionalParams

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

Formats the value using the given formatter.

impl Default for ListNotebooksOptionalParams

fn default() -> ListNotebooksOptionalParams

Returns the “default value” for a type.