cx_sdk::client::dashboards

Struct DashboardsClient

source 
pub struct DashboardsClient { /* private fields */ }
Expand description

The Dashboards API client. Read more at https://coralogix.com/docs/custom-dashboards/

Implementations§

source§

impl DashboardsClient

source

pub fn new(auth_context: AuthContext, region: CoralogixRegion) -> Result<Self>

Creates a new client for the Dashboards API.

§Arguments
source

pub async fn create( &self, dashboard: Dashboard, ) -> Result<CreateDashboardResponse>

Creates a new dashboard.

§Arguments
  • dashboard - The dashboard to create.
source

pub async fn replace( &self, dashboard: Dashboard, ) -> Result<ReplaceDashboardResponse>

Replaces a dashboard.

§Arguments
source

pub async fn get(&self, dashboard_id: String) -> Result<GetDashboardResponse>

Gets a dashboard by its ID.

§Arguments
  • dashboard_id - The ID of the dashboard to get.
source

pub async fn list(&self) -> Result<GetDashboardCatalogResponse>

Lists all dashboards.

source

pub async fn delete( &self, dashboard_id: String, ) -> Result<DeleteDashboardResponse>

Deletes a dashboard by its ID.

§Arguments
  • dashboard_id - The ID of the dashboard to delete.
source

pub async fn pin(&self, dashboard_id: String) -> Result<PinDashboardResponse>

Pins a dashboard by its ID.

§Arguments
  • dashboard_id - The ID of the dashboard to pin.
source

pub async fn unpin( &self, dashboard_id: String, ) -> Result<UnpinDashboardResponse>

Unpins a dashboard by its ID.

§Arguments
  • dashboard_id - The ID of the dashboard to unpin.
source

pub async fn assign_to_folder( &self, dashboard_id: String, folder_id: String, ) -> Result<AssignDashboardFolderResponse>

Assigns a dashboard to a folder.

§Arguments
  • dashboard_id - The ID of the dashboard to assign.
  • folder_id - The ID of the folder to assign the dashboard to.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T