Struct DatasetClient 

pub struct DatasetClient { /* private fields */ }

👎Deprecated:

This API will change significantly under a new name.

The Custom Enrichments API client. Read more at https://coralogix.com/docs/custom-enrichment-api/

Implementations

impl DatasetClient

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

Creates a new client for the Custom Enrichments API.

Arguments

• auth_context - The AuthContext to use for authentication.
• region - The CoralogixRegion to connect to.

pub async fn create( &self, name: String, description: Option<String>, data: Vec<u8>, ) -> Result<CreateCustomEnrichmentResponse>

Creates a new dataset.

Arguments

• name - The name of the Custom Enrichment.
• description - The description of the Custom Enrichment.
• data - The data of the Custom Enrichment.

pub async fn replace( &self, id: u32, name: String, description: Option<String>, data: Vec<u8>, ) -> Result<UpdateCustomEnrichmentResponse>

Replaces the existing dataset identified by its id.

Arguments

• id - The id of the Custom Enrichment.
• name - The name of the Custom Enrichment.
• description - The description of the Custom Enrichment.
• data - The data of the Custom Enrichment.

Note that the existing dataset will be replaced with a new version of the data.

pub async fn delete( &self, custom_enrichment_id: u32, ) -> Result<DeleteCustomEnrichmentResponse>

Deletes the dataset identified by its id.

Arguments

• custom_enrichment_id - The id of the Custom Enrichment.

pub async fn get(&self, id: u32) -> Result<GetCustomEnrichmentResponse>

Retrieves the dataset by id.

Arguments

• id - The id of the Custom Enrichment.

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

Retrieves all datasets.

Returns

A list of all Custom Enrichments.