Struct gsuite_api::members::Members

source · [−]

pub struct Members {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl Members

source

pub async fn has(
 &self,
 group_key: &str,
 member_key: &str
) -> Result<MembersHasMember>

This function performs a GET to the /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey} endpoint.

Checks whether the given user is a member of the group. Membership can be direct or nested.

Parameters:

group_key: &str – Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.
member_key: &str – Identifies the user member in the API request. The value can be the user’s primary email address, alias, or unique ID.

source

pub async fn list(
 &self,
 group_key: &str,
 include_derived_membership: bool,
 max_results: i64,
 page_token: &str,
 roles: &str
) -> Result<Vec<Member>>

This function performs a GET to the /admin/directory/v1/groups/{groupKey}/members endpoint.

Retrieves a paginated list of all members in a group.

Parameters:

group_key: &str – Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.
include_derived_membership: bool – A Boolean value to indicate whether payload is wanted. Optional.
max_results: i64 – Maximum number of results to return. Max allowed value is 200.
page_token: &str – Token to specify next page in the list.
roles: &str – The roles query parameter allows you to retrieve group members by role. Allowed values are OWNER, MANAGER, and MEMBER.

source

pub async fn list_all(
 &self,
 group_key: &str,
 include_derived_membership: bool,
 roles: &str
) -> Result<Vec<Member>>

This function performs a GET to the /admin/directory/v1/groups/{groupKey}/members endpoint.

As opposed to list, this function returns all the pages of the request at once.

Retrieves a paginated list of all members in a group.

source

pub async fn insert(&self, group_key: &str, body: &Member) -> Result<Member>

This function performs a POST to the /admin/directory/v1/groups/{groupKey}/members endpoint.

Adds a user to the specified group.

Parameters:

group_key: &str – Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.

source

pub async fn get(&self, group_key: &str, member_key: &str) -> Result<Member>

This function performs a GET to the /admin/directory/v1/groups/{groupKey}/members/{memberKey} endpoint.

Retrieves a group member’s properties.

Parameters:

group_key: &str – Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.
member_key: &str – Identifies the group member in the API request. A group member can be a user or another group. The value can be the member’s (group or user) primary email address, alias, or unique ID.

source

pub async fn update(
 &self,
 group_key: &str,
 member_key: &str,
 body: &Member
) -> Result<Member>

This function performs a PUT to the /admin/directory/v1/groups/{groupKey}/members/{memberKey} endpoint.

Updates the membership of a user in the specified group.

Parameters:

group_key: &str – Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.
member_key: &str – Identifies the group member in the API request. A group member can be a user or another group. The value can be the member’s (group or user) primary email address, alias, or unique ID.

source

pub async fn delete(&self, group_key: &str, member_key: &str) -> Result<()>

This function performs a DELETE to the /admin/directory/v1/groups/{groupKey}/members/{memberKey} endpoint.

Removes a member from a group.

Parameters:

group_key: &str – Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.
member_key: &str – Identifies the group member in the API request. A group member can be a user or another group. The value can be the member’s (group or user) primary email address, alias, or unique ID.

source

pub async fn patch(
 &self,
 group_key: &str,
 member_key: &str,
 body: &Member
) -> Result<Member>

This function performs a PATCH to the /admin/directory/v1/groups/{groupKey}/members/{memberKey} endpoint.

Updates the membership properties of a user in the specified group. This method supports patch semantics.

Parameters:

group_key: &str – Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.
member_key: &str – Identifies the group member in the API request. A group member can be a user or another group. The value can be the member’s (group or user) primary email address, alias, or unique ID.

Auto Trait Implementations

impl !RefUnwindSafe for Members

impl Send for Members

impl Sync for Members

impl Unpin for Members

impl !UnwindSafe for Members

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

source

impl<T> Instrument for T

source

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

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

source

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 for T where
U: From<T>,

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct gsuite_api::members::Members

Fields

Implementations

impl Members

pub async fn has( &self, group_key: &str, member_key: &str) -> Result<MembersHasMember>

pub async fn list( &self, group_key: &str, include_derived_membership: bool, max_results: i64, page_token: &str, roles: &str) -> Result<Vec<Member>>

pub async fn list_all( &self, group_key: &str, include_derived_membership: bool, roles: &str) -> Result<Vec<Member>>

pub async fn insert(&self, group_key: &str, body: &Member) -> Result<Member>

pub async fn get(&self, group_key: &str, member_key: &str) -> Result<Member>

pub async fn update( &self, group_key: &str, member_key: &str, body: &Member) -> Result<Member>

pub async fn delete(&self, group_key: &str, member_key: &str) -> Result<()>

pub async fn patch( &self, group_key: &str, member_key: &str, body: &Member) -> Result<Member>

Auto Trait Implementations

impl !RefUnwindSafe for Members

impl Send for Members

impl Sync for Members

impl Unpin for Members

impl !UnwindSafe for Members

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn has(
&self,
group_key: &str,
member_key: &str
) -> Result<MembersHasMember>

pub async fn list(
&self,
group_key: &str,
include_derived_membership: bool,
max_results: i64,
page_token: &str,
roles: &str
) -> Result<Vec<Member>>

pub async fn list_all(
&self,
group_key: &str,
include_derived_membership: bool,
roles: &str
) -> Result<Vec<Member>>

pub async fn update(
&self,
group_key: &str,
member_key: &str,
body: &Member
) -> Result<Member>

pub async fn patch(
&self,
group_key: &str,
member_key: &str,
body: &Member
) -> Result<Member>

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

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

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

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

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

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

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

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