Struct gitlab::api::groups::EditGroupBuilder

pub struct EditGroupBuilder<'a> { /* private fields */ }

Builder for EditGroup.

Implementations

impl<'a> EditGroupBuilder<'a>

pub fn group<VALUE: Into<NameOrId<'a>>>(&mut self, value: VALUE) -> &mut Self

The group to edit.

pub fn name<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

The name of the group.

pub fn path<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

The path of the group.

pub fn description<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE ) -> &mut Self

A short description for the group.

pub fn membership_lock(&mut self, value: bool) -> &mut Self

Prevent adding members directly to projects within the group.

pub fn visibility(&mut self, value: VisibilityLevel) -> &mut Self

The visibility of the group.

pub fn share_with_group_lock(&mut self, value: bool) -> &mut Self

Prevent sharing a project in this group with another group.

pub fn require_two_factor_authentication(&mut self, value: bool) -> &mut Self

Require two-factor authentication to be a member of this group.

pub fn two_factor_grace_period(&mut self, value: u64) -> &mut Self

Time (in hours) for users to enable two-factor before enforcing it.

pub fn project_creation_level( &mut self, value: GroupProjectCreationAccessLevel ) -> &mut Self

The access level to the group that is required to create new projects.

pub fn auto_devops_enabled(&mut self, value: bool) -> &mut Self

Default to Auto DevOps for new projects in the group.

pub fn subgroup_creation_level( &mut self, value: SubgroupCreationAccessLevel ) -> &mut Self

The access level to the group that is required to create subgroups.

pub fn emails_disabled(&mut self, value: bool) -> &mut Self

Disable email notifications from the group.

pub fn emails_enabled(&mut self, value: bool) -> &mut Self

Enable email notifications from the group.

pub fn mentions_disabled(&mut self, value: bool) -> &mut Self

Disable group-wide mentions.

pub fn prevent_sharing_groups_outside_hierarchy( &mut self, value: bool ) -> &mut Self

Disable sharing outside of the group hierarchy.

Only available on top-level groups.

pub fn lfs_enabled(&mut self, value: bool) -> &mut Self

Whether git-lfs is enabled by default for projects within the group.

pub fn request_access_enabled(&mut self, value: bool) -> &mut Self

Whether access to the group may be requested.

pub fn parent_id(&mut self, value: u64) -> &mut Self

The parent group ID (for subgroups).

pub fn default_branch_protection( &mut self, value: BranchProtection ) -> &mut Self

The default branch protection for projects within the group.

pub fn default_branch_protection_defaults( &mut self, value: BranchProtectionDefaults ) -> &mut Self

The default branch protection defaults for projects within the group.

pub fn shared_runners_setting( &mut self, value: SharedRunnersSetting ) -> &mut Self

Shared runner settings for the group.

pub fn shared_runners_minutes_limit<VALUE: Into<SharedRunnersMinutesLimit>>( &mut self, value: VALUE ) -> &mut Self

Pipeline quota (in minutes) for the group on shared runners.

pub fn extra_shared_runners_minutes_limit(&mut self, value: u64) -> &mut Self

Pipeline quota excess (in minutes) for the group on shared runners.

pub fn file_template_project_id(&mut self, value: u64) -> &mut Self

The project id to load custom file templates from.

pub fn prevent_forking_outside_group(&mut self, value: bool) -> &mut Self

When enabled, users cannot fork projects from this group to other namespaces.

pub fn wiki_access_level(&mut self, value: FeatureAccessLevel) -> &mut Self

The wiki access level.

pub fn unique_project_download_limit(&mut self, value: u64) -> &mut Self

Maximum number of unique projects a user can download before being banned.

Only supported on top-level groups.

pub fn unique_project_download_limit_interval( &mut self, value: Duration ) -> &mut Self

The window (in seconds) where downloads will be counted.

Only supported on top-level groups.

pub fn auto_ban_user_on_excessive_projects_download( &mut self, value: bool ) -> &mut Self

Ban users from the group when they exceed the download limit.

Only supported on top-level groups.

pub fn build(&self) -> Result<EditGroup<'a>, EditGroupBuilderError>

Builds a new EditGroup.

Errors

If a required field has not been initialized.

impl<'a> EditGroupBuilder<'a>

pub fn ip_restriction_range<R>(&mut self, range: R) -> &mut Self

where R: Into<Cow<'a, str>>,

An IP address or IP range that is allowed to access the group.

pub fn ip_restriction_ranges<I, R>(&mut self, iter: I) -> &mut Self

where I: Iterator<Item = R>, R: Into<Cow<'a, str>>,

A set of IP addresses or IP ranges that are allowed to access the group.

pub fn unique_project_download_limit_allow<A>(&mut self, allow: A) -> &mut Self

where A: Into<Cow<'a, str>>,

A username excluded from the download limit.

pub fn unique_project_download_limit_allow_users<I, A>( &mut self, iter: I ) -> &mut Self

where I: Iterator<Item = A>, A: Into<Cow<'a, str>>,

List of usernames excluded from the download limit.

pub fn unique_project_download_limit_alert(&mut self, alert: u64) -> &mut Self

A user ID that is emailed when a download limit is exceeded.

pub fn unique_project_download_limit_alert_users<I>( &mut self, iter: I ) -> &mut Self

where I: Iterator<Item = u64>,

List of user IDs that are emailed when a download limit is exceeded.

Trait Implementations

impl<'a> Clone for EditGroupBuilder<'a>

fn clone(&self) -> EditGroupBuilder<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Default for EditGroupBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.