Skip to main content

TeamsClient

cx_sdk::client::teams

Struct TeamsClient 

Source 
pub struct TeamsClient { /* private fields */ }
Expand description

The Team API client. Read more at https://coralogix.com/docs/user-team-management/ and https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/

Implementations§

Source§

impl TeamsClient

Source

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

Creates a new client for the Teams API.

§Arguments
Source

pub async fn create( &self, team_name: String, team_admins_email: Vec<String>, daily_quota: Option<f64>, ) -> Result<CreateTeamInOrgResponse>

Creates a new Team in the organization.

§Arguments
  • team_name - The name of the team.
  • team_admins_email - The email addresses of the team admins.
  • daily_quota - The daily quota for the team.
Source

pub async fn replace( &self, team_id: u32, team_name: Option<String>, daily_quota: Option<f64>, ) -> Result<UpdateTeamResponse>

Update the Team identified by its id.

§Arguments
  • team_id - The id of the team to replace.
  • team_name - The name of the team.
  • daily_quota - The daily quota for the team.
Source

pub async fn delete(&self, team_id: u32) -> Result<DeleteTeamResponse>

Deletes the Team identified by its id.

§Arguments
  • team_id - The id of the team to delete.
Source

pub async fn get(&self, team_id: u32) -> Result<GetTeamResponse>

Retrieves the Team metadata.

§Arguments
  • team_id - The id of the team to retrieve.
Source

pub async fn get_quota(&self, team_id: u32) -> Result<GetTeamQuotaResponse>

Retrieves the Team quota.

§Arguments
  • team_id - The id of the team to retrieve.
Source

pub async fn set_daily_quota( &self, team_id: u32, target_daily_quota: f32, ) -> Result<SetDailyQuotaResponse>

Sets the daily Team quota.

§Arguments
  • team_id - The id of the team to retrieve.
  • target_daily_quota - The new daily quota for the team.
Source

pub async fn move_quota( &self, source_team_id: u32, destination_team_id: u32, units_to_move: f64, ) -> Result<MoveQuotaResponse>

Moves the quota units from one team to the other.

§Arguments
  • source_team_id - The id of the team to move the quota from.
  • destination_team_id - The id of the team to move the quota to.
  • units_to_move - The number of units to move.
Source

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

Retrieves a list of all [TeamInfo]s.

§Returns

A list of all teams.

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
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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