Struct IncidentsClient

pub struct IncidentsClient { /* private fields */ }

IncidentsClient is a client for the Incidents API.

Implementations

impl IncidentsClient

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

Creates a new IncidentsClient.

Arguments

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

pub async fn get_incident( &self, id: &str, ) -> Result<GetIncidentResponse, Box<dyn Error>>

Gets an incident by its ID.

Arguments

• id - The ID of the incident to get.

pub async fn batch_get_incident( &self, ids: Vec<String>, ) -> Result<BatchGetIncidentResponse, Box<dyn Error>>

Batch gets incidents by their IDs.

Arguments

• ids - The IDs of the incidents to get.

pub async fn list_incidents( &self, filter: Option<IncidentQueryFilter>, pagination: Option<PaginationRequest>, order_bys: Vec<OrderBy>, ) -> Result<ListIncidentsResponse, Box<dyn Error>>

Lists incidents.

Arguments

• filter - The IncidentQueryFilter to filter the incidents by.
• pagination - The PaginationRequest to paginate the incidents.
• order_bys - The OrderBys to order the incidents by.

pub async fn list_incident_aggregations( &self, filter: Option<IncidentQueryFilter>, group_bys: Vec<GroupBy>, pagination: Option<PaginationRequest>, ) -> Result<ListIncidentAggregationsResponse, Box<dyn Error>>

Lists incident aggregations.

Arguments

• request - The ListIncidentAggregationsRequest to list the incident aggregations.

pub async fn get_filter_values( &self, filter: IncidentQueryFilter, ) -> Result<GetFilterValuesResponse, Box<dyn Error>>

Gets the filter values for a given filter.

Arguments

• filter - The IncidentQueryFilter to get the filter values for.

pub async fn assign_incidents( &self, incident_ids: Vec<String>, assigned_to: Option<UserDetails>, ) -> Result<AssignIncidentsResponse, Box<dyn Error>>

Assigns incidents to a user.

Arguments

• incident_ids - The IDs of the incidents to assign.
• assigned_to - The UserDetails to assign the incidents to.

pub async fn unassign_incidents( &self, incident_ids: Vec<String>, ) -> Result<UnassignIncidentsResponse, Box<dyn Error>>

Unassigns incidents from a user.

Arguments

• incident_ids - The IDs of the incidents to unassign.

pub async fn acknowledge_incidents( &self, incident_ids: Vec<String>, ) -> Result<AcknowledgeIncidentsResponse, Box<dyn Error>>

Acknowledges incidents.

Arguments

• incident_ids - The IDs of the incidents to acknowledge.

pub async fn close_incidents( &self, incident_ids: Vec<String>, ) -> Result<CloseIncidentsResponse, Box<dyn Error>>

Closes incidents.

Arguments

• incident_ids - The IDs of the incidents to close.

pub async fn get_incident_events( &self, incident_id: Option<String>, ) -> Result<GetIncidentEventsResponse, Box<dyn Error>>

Gets the events for an incident.

Arguments

• incident_id - The ID of the incident to get the events for.

pub async fn resolve_incidents( &self, incident_ids: Vec<String>, ) -> Result<ResolveIncidentsResponse, Box<dyn Error>>

Resolves incidents.

Arguments

• incident_ids - The IDs of the incidents to resolve.

pub async fn get_incident_using_correlation_key( &self, correlation_key: String, timestamp: OffsetDateTime, ) -> Result<GetIncidentUsingCorrelationKeyResponse, Box<dyn Error>>

Gets an incident by its correlation key and specific point in time.

Arguments

• correlation_key - The correlation key of the incident to get.
• timestamp - The timestamp to get the incident at.

pub async fn list_incident_events( &self, filter: Option<IncidentEventQueryFilter>, pagination: Option<PaginationRequest>, order_by: Option<ListIncidentEventRequestOrderBy>, ) -> Result<ListIncidentEventsResponse, Box<dyn Error>>

Lists the events for an incident.

Arguments

• incident_id - The ID of the incident to get the events for.

pub async fn list_incident_events_total_count( &self, filter: Option<IncidentEventQueryFilter>, ) -> Result<ListIncidentEventsTotalCountResponse, Box<dyn Error>>

Lists the total count of events for an incident.

Arguments

• incident_id - The ID of the incident to get the total count of events for.

pub async fn list_incident_events_filter_values( &self, filter: Option<IncidentEventQueryFilter>, ) -> Result<ListIncidentEventsFilterValuesResponse, Box<dyn Error>>

Lists the filter values for an incident event.

Arguments

• filter - The IncidentEventQueryFilter to get the filter values for.