org.gitlab4j.api.models

Class GroupParams

java.lang.Object

org.gitlab4j.api.models.GroupParams

public class GroupParams
extends Object

This class is utilized by the GroupApi.createGroup(GroupParams) and GroupApi.updateGroup(Object, GroupParams) methods to set the parameters for the call to the GitLab API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupParams.ProjectCreationLevel Constant to specify the project_creation_level for the group.
static class	GroupParams.SubgroupCreationLevel Constant to specify the subgroup_creation_level for the group.

Constructor Summary

Constructors

Constructor and Description
GroupParams()

Method Summary

Modifier and Type	Method and Description
GitLabApiForm	getForm(boolean isCreate) Get the form params for a group create oir update call.
GroupParams	withAutoDevopsEnabled(Boolean autoDevopsEnabled)
GroupParams	withDescription(String description)
GroupParams	withEmailsDisabled(Boolean emailsDisabled)
GroupParams	withExtraSharedRunnersMinutesLimit(Integer extraSharedRunnersMinutesLimit)
GroupParams	withFileTemplateProjectId(Integer fileTemplateProjectId) The ID of a project to load custom file templates from.
GroupParams	withLfsEnabled(Boolean lfsEnabled)
GroupParams	withMembershipLock(Boolean membershipLock) Prevent adding new members to project membership within this group.
GroupParams	withName(String name)
GroupParams	withParentId(Integer parentId) The parent group ID for creating nested group.
GroupParams	withPath(String path)
GroupParams	withProjectCreationLevel(GroupParams.ProjectCreationLevel projectCreationLevel)
GroupParams	withRequestAccessEnabled(Boolean requestAccessEnabled)
GroupParams	withRequireTwoFactorAuthentication(Boolean requireTwoFactorAuthentication)
GroupParams	withSharedRunnersMinutesLimit(Integer sharedRunnersMinutesLimit)
GroupParams	withShareWithGroupLock(Boolean shareWithGroupLock)
GroupParams	withSubgroupCreationLevel(GroupParams.SubgroupCreationLevel subgroupCreationLevel)
GroupParams	withTwoFactorGracePeriod(Integer twoFactorGracePeriod)
GroupParams	withVisibility(String visibility)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupParams

public GroupParams()

Method Detail

withParentId

public GroupParams withParentId(Integer parentId)

The parent group ID for creating nested group. For create only.

Parameters:

parentId - the parent group ID for creating nested group

Returns:

this GroupParms instance

withMembershipLock

public GroupParams withMembershipLock(Boolean membershipLock)

Prevent adding new members to project membership within this group. For update only.

Parameters:

membershipLock - if true, prevent adding new members to project membership within this group

Returns:

this GroupParms instance

withFileTemplateProjectId

public GroupParams withFileTemplateProjectId(Integer fileTemplateProjectId)

The ID of a project to load custom file templates from. For update only.

Parameters:

fileTemplateProjectId - the ID of a project to load custom file templates from

Returns:

this GroupParms instance

withName

public GroupParams withName(String name)

withPath

public GroupParams withPath(String path)

withDescription

public GroupParams withDescription(String description)

withVisibility

public GroupParams withVisibility(String visibility)

withShareWithGroupLock

public GroupParams withShareWithGroupLock(Boolean shareWithGroupLock)

withRequireTwoFactorAuthentication

public GroupParams withRequireTwoFactorAuthentication(Boolean requireTwoFactorAuthentication)

withTwoFactorGracePeriod

public GroupParams withTwoFactorGracePeriod(Integer twoFactorGracePeriod)

withProjectCreationLevel

public GroupParams withProjectCreationLevel(GroupParams.ProjectCreationLevel projectCreationLevel)

withAutoDevopsEnabled

public GroupParams withAutoDevopsEnabled(Boolean autoDevopsEnabled)

withSubgroupCreationLevel

public GroupParams withSubgroupCreationLevel(GroupParams.SubgroupCreationLevel subgroupCreationLevel)

withEmailsDisabled

public GroupParams withEmailsDisabled(Boolean emailsDisabled)

withLfsEnabled

public GroupParams withLfsEnabled(Boolean lfsEnabled)

withRequestAccessEnabled

public GroupParams withRequestAccessEnabled(Boolean requestAccessEnabled)

withSharedRunnersMinutesLimit

public GroupParams withSharedRunnersMinutesLimit(Integer sharedRunnersMinutesLimit)

withExtraSharedRunnersMinutesLimit

public GroupParams withExtraSharedRunnersMinutesLimit(Integer extraSharedRunnersMinutesLimit)

getForm

public GitLabApiForm getForm(boolean isCreate)

Get the form params for a group create oir update call.

Parameters:

isCreate - set to true for a create group call, false for update

Returns:

a GitLabApiForm instance holding the parameters for the group create or update operation

Throws:

RuntimeException - if required parameters are missing