Package 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.

  • Constructor Details

    • GroupParams

      public GroupParams()

  • Method Details

    • withParentId

      public GroupParams withParentId(Long 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(Long 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)

    • withDefaultBranchProtection

      public GroupParams withDefaultBranchProtection(GroupParams.DefaultBranchProtectionLevel defaultBranchProtection)

    • 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