cx_sdk::client::notifications

Struct NotificationsClient

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

A client for interacting with the Coralogix Notification Center APIs.

Implementations§

source§

impl NotificationsClient

source

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

Creates a new client for the Notification Center.

§Arguments
source

pub async fn get_connector( &self, connector_id: String, ) -> Result<GetConnectorResponse>

Get a connector by ID.

§Arguments
  • connector_id - The ID of the connector to get.
source

pub async fn list_connectors( &self, connector_type: ConnectorType, order_bys: Vec<OrderBy>, entity_type: String, ) -> Result<ListConnectorsResponse>

List all connectors.

§Arguments
  • connector_type - The ConnectorType to filter by.
  • order_bys - The OrderBys to use for sorting.
  • entity_type - The entity type to filter by.
source

pub async fn create_connector( &self, connector: Connector, ) -> Result<CreateConnectorResponse>

Create a new connector.

§Arguments
source

pub async fn replace_connector( &self, connector: Connector, ) -> Result<ReplaceConnectorResponse>

Replace an existing connector.

§Arguments
source

pub async fn delete_connector( &self, connector_id: String, ) -> Result<DeleteConnectorResponse>

Delete a connector by ID.

§Arguments
  • connector_id - The ID of the connector to delete.
source

pub async fn batch_get_connectors( &self, connector_ids: Vec<String>, ) -> Result<BatchGetConnectorsResponse>

Batch get connectors by ID.

§Arguments
  • connector_ids - The IDs of the connectors to get.
source

pub async fn get_connector_type_summaries( &self, ) -> Result<GetConnectorTypeSummariesResponse>

Get summaries of connector types.

source

pub async fn create_custom_preset( &self, preset: Preset, ) -> Result<CreateCustomPresetResponse>

Create a new custom preset.

§Arguments
  • preset - The Preset to create.
source

pub async fn replace_custom_preset( &self, preset: Preset, ) -> Result<ReplaceCustomPresetResponse>

Replace an existing custom preset.

§Arguments
  • preset - The Preset to replace.
source

pub async fn delete_custom_preset( &self, preset_id: String, ) -> Result<DeleteCustomPresetResponse>

Delete a custom preset by ID.

§Arguments
  • preset_id - The ID of the preset to delete.
source

pub async fn set_custom_preset_as_default( &self, preset_id: String, ) -> Result<SetCustomPresetAsDefaultResponse>

Set a custom preset as the default.

§Arguments
  • preset_id - The ID of the preset to set as the default.
source

pub async fn get_preset(&self, preset_id: String) -> Result<GetPresetResponse>

Get a preset by ID.

§Arguments
  • preset_id - The ID of the preset to get.
source

pub async fn list_preset_summaries( &self, connector_type: ConnectorType, entity_type: String, order_bys: Vec<OrderBy>, ) -> Result<ListPresetSummariesResponse>

List summaries of presets.

§Arguments
  • connector_type - The ConnectorType to list presets for.
  • entity_type - The entity type to list presets for.
  • order_bys - The OrderBys to use for sorting.
source

pub async fn batch_get_presets( &self, preset_ids: Vec<String>, ) -> Result<BatchGetPresetsResponse>

Batch get presets by ID.

§Arguments
  • preset_ids - The IDs of the presets to get.
source

pub async fn get_default_preset_summary( &self, connector_type: ConnectorType, entity_type: String, ) -> Result<GetDefaultPresetSummaryResponse>

Get the default preset summary.

§Arguments
  • connector_type - The ConnectorType to get the default preset summary for.
  • entity_type - The entity type to get the default preset summary for.
source

pub async fn get_system_default_preset_summary( &self, connector_type: ConnectorType, entity_type: String, ) -> Result<GetSystemDefaultPresetSummaryResponse>

Get the system default preset summary.

§Arguments
  • connector_type - The ConnectorType to get the system default preset summary for.
  • entity_type - The entity type to get the system default preset summary for.
source

pub async fn test_connector_config( &self, connector_type: ConnectorType, output_schema_id: String, connector_config_fields: Vec<ConnectorConfigField>, entity_type: String, ) -> Result<TestConnectorConfigResponse>

Test a connector configuration.

§Arguments
  • connector_type - The ConnectorType to test.
  • output_schema_id - The ID of the output schema to test with.
  • connector_config_fields - The ConnectorConfigFields to test with.
  • entity_type - The entity type to test with.
source

pub async fn test_existing_connector( &self, connector_id: String, output_schema_id: String, ) -> Result<TestExistingConnectorResponse>

Test an existing connector.

§Arguments
  • connector_id - The ID of the connector to test.
  • output_schema_id - The ID of the output schema to test with.
source

pub async fn test_preset_config( &self, params: TestPresetConfigParams, ) -> Result<TestPresetConfigResponse>

Test a preset configuration.

§Arguments
  • params - The parameters for testing the preset configuration.
source

pub async fn test_template_render( &self, entity_type: String, entity_sub_type: Option<String>, template: String, ) -> Result<TestTemplateRenderResponse>

Test rendering a template.

§Arguments
  • entity_type - The entity type to test with.
  • entity_sub_type - The entity sub type to test with.
  • template - The template to render.

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