Class BranchProtection

java.lang.Object
build.cursed.genapi.forgejo.model.BranchProtection

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-09-28T16:24:31.414706+02:00[Europe/Stockholm]", comments="Generator version: 7.21.0") public class BranchProtection extends Object
BranchProtection represents a branch protection for a repository
  • Field Details

    • SERIALIZED_NAME_APPLY_TO_ADMINS

      public static final String SERIALIZED_NAME_APPLY_TO_ADMINS
      See Also:
    • SERIALIZED_NAME_APPROVALS_WHITELIST_TEAMS

      public static final String SERIALIZED_NAME_APPROVALS_WHITELIST_TEAMS
      See Also:
    • SERIALIZED_NAME_APPROVALS_WHITELIST_USERNAME

      public static final String SERIALIZED_NAME_APPROVALS_WHITELIST_USERNAME
      See Also:
    • SERIALIZED_NAME_BLOCK_ON_OFFICIAL_REVIEW_REQUESTS

      public static final String SERIALIZED_NAME_BLOCK_ON_OFFICIAL_REVIEW_REQUESTS
      See Also:
    • SERIALIZED_NAME_BLOCK_ON_OUTDATED_BRANCH

      public static final String SERIALIZED_NAME_BLOCK_ON_OUTDATED_BRANCH
      See Also:
    • SERIALIZED_NAME_BLOCK_ON_REJECTED_REVIEWS

      public static final String SERIALIZED_NAME_BLOCK_ON_REJECTED_REVIEWS
      See Also:
    • SERIALIZED_NAME_BRANCH_NAME

      public static final String SERIALIZED_NAME_BRANCH_NAME
      See Also:
    • SERIALIZED_NAME_CREATED_AT

      public static final String SERIALIZED_NAME_CREATED_AT
      See Also:
    • SERIALIZED_NAME_DISMISS_STALE_APPROVALS

      public static final String SERIALIZED_NAME_DISMISS_STALE_APPROVALS
      See Also:
    • SERIALIZED_NAME_ENABLE_APPROVALS_WHITELIST

      public static final String SERIALIZED_NAME_ENABLE_APPROVALS_WHITELIST
      See Also:
    • SERIALIZED_NAME_ENABLE_MERGE_WHITELIST

      public static final String SERIALIZED_NAME_ENABLE_MERGE_WHITELIST
      See Also:
    • SERIALIZED_NAME_ENABLE_PUSH

      public static final String SERIALIZED_NAME_ENABLE_PUSH
      See Also:
    • SERIALIZED_NAME_ENABLE_PUSH_WHITELIST

      public static final String SERIALIZED_NAME_ENABLE_PUSH_WHITELIST
      See Also:
    • SERIALIZED_NAME_ENABLE_STATUS_CHECK

      public static final String SERIALIZED_NAME_ENABLE_STATUS_CHECK
      See Also:
    • SERIALIZED_NAME_IGNORE_STALE_APPROVALS

      public static final String SERIALIZED_NAME_IGNORE_STALE_APPROVALS
      See Also:
    • SERIALIZED_NAME_MERGE_WHITELIST_TEAMS

      public static final String SERIALIZED_NAME_MERGE_WHITELIST_TEAMS
      See Also:
    • SERIALIZED_NAME_MERGE_WHITELIST_USERNAMES

      public static final String SERIALIZED_NAME_MERGE_WHITELIST_USERNAMES
      See Also:
    • SERIALIZED_NAME_PROTECTED_FILE_PATTERNS

      public static final String SERIALIZED_NAME_PROTECTED_FILE_PATTERNS
      See Also:
    • SERIALIZED_NAME_PUSH_WHITELIST_DEPLOY_KEYS

      public static final String SERIALIZED_NAME_PUSH_WHITELIST_DEPLOY_KEYS
      See Also:
    • SERIALIZED_NAME_PUSH_WHITELIST_TEAMS

      public static final String SERIALIZED_NAME_PUSH_WHITELIST_TEAMS
      See Also:
    • SERIALIZED_NAME_PUSH_WHITELIST_USERNAMES

      public static final String SERIALIZED_NAME_PUSH_WHITELIST_USERNAMES
      See Also:
    • SERIALIZED_NAME_REQUIRE_SIGNED_COMMITS

      public static final String SERIALIZED_NAME_REQUIRE_SIGNED_COMMITS
      See Also:
    • SERIALIZED_NAME_REQUIRED_APPROVALS

      public static final String SERIALIZED_NAME_REQUIRED_APPROVALS
      See Also:
    • SERIALIZED_NAME_RULE_NAME

      public static final String SERIALIZED_NAME_RULE_NAME
      See Also:
    • SERIALIZED_NAME_STATUS_CHECK_CONTEXTS

      public static final String SERIALIZED_NAME_STATUS_CHECK_CONTEXTS
      See Also:
    • SERIALIZED_NAME_UNPROTECTED_FILE_PATTERNS

      public static final String SERIALIZED_NAME_UNPROTECTED_FILE_PATTERNS
      See Also:
    • SERIALIZED_NAME_UPDATED_AT

      public static final String SERIALIZED_NAME_UPDATED_AT
      See Also:
    • openapiFields

      public static HashSet<String> openapiFields
    • openapiRequiredFields

      public static HashSet<String> openapiRequiredFields
  • Constructor Details

    • BranchProtection

      public BranchProtection()
  • Method Details

    • applyToAdmins

      public BranchProtection applyToAdmins(@Nullable Boolean applyToAdmins)
    • getApplyToAdmins

      @Nullable public Boolean getApplyToAdmins()
      Get applyToAdmins
      Returns:
      applyToAdmins
    • setApplyToAdmins

      public void setApplyToAdmins(@Nullable Boolean applyToAdmins)
    • approvalsWhitelistTeams

      public BranchProtection approvalsWhitelistTeams(@Nullable List<String> approvalsWhitelistTeams)
    • addApprovalsWhitelistTeamsItem

      public BranchProtection addApprovalsWhitelistTeamsItem(String approvalsWhitelistTeamsItem)
    • getApprovalsWhitelistTeams

      @Nullable public List<String> getApprovalsWhitelistTeams()
      Get approvalsWhitelistTeams
      Returns:
      approvalsWhitelistTeams
    • setApprovalsWhitelistTeams

      public void setApprovalsWhitelistTeams(@Nullable List<String> approvalsWhitelistTeams)
    • approvalsWhitelistUsername

      public BranchProtection approvalsWhitelistUsername(@Nullable List<String> approvalsWhitelistUsername)
    • addApprovalsWhitelistUsernameItem

      public BranchProtection addApprovalsWhitelistUsernameItem(String approvalsWhitelistUsernameItem)
    • getApprovalsWhitelistUsername

      @Nullable public List<String> getApprovalsWhitelistUsername()
      Get approvalsWhitelistUsername
      Returns:
      approvalsWhitelistUsername
    • setApprovalsWhitelistUsername

      public void setApprovalsWhitelistUsername(@Nullable List<String> approvalsWhitelistUsername)
    • blockOnOfficialReviewRequests

      public BranchProtection blockOnOfficialReviewRequests(@Nullable Boolean blockOnOfficialReviewRequests)
    • getBlockOnOfficialReviewRequests

      @Nullable public Boolean getBlockOnOfficialReviewRequests()
      Get blockOnOfficialReviewRequests
      Returns:
      blockOnOfficialReviewRequests
    • setBlockOnOfficialReviewRequests

      public void setBlockOnOfficialReviewRequests(@Nullable Boolean blockOnOfficialReviewRequests)
    • blockOnOutdatedBranch

      public BranchProtection blockOnOutdatedBranch(@Nullable Boolean blockOnOutdatedBranch)
    • getBlockOnOutdatedBranch

      @Nullable public Boolean getBlockOnOutdatedBranch()
      Get blockOnOutdatedBranch
      Returns:
      blockOnOutdatedBranch
    • setBlockOnOutdatedBranch

      public void setBlockOnOutdatedBranch(@Nullable Boolean blockOnOutdatedBranch)
    • blockOnRejectedReviews

      public BranchProtection blockOnRejectedReviews(@Nullable Boolean blockOnRejectedReviews)
    • getBlockOnRejectedReviews

      @Nullable public Boolean getBlockOnRejectedReviews()
      Get blockOnRejectedReviews
      Returns:
      blockOnRejectedReviews
    • setBlockOnRejectedReviews

      public void setBlockOnRejectedReviews(@Nullable Boolean blockOnRejectedReviews)
    • branchName

      public BranchProtection branchName(@Nullable String branchName)
    • getBranchName

      @Nullable public String getBranchName()
      Deprecated: true
      Returns:
      branchName
    • setBranchName

      public void setBranchName(@Nullable String branchName)
    • createdAt

      public BranchProtection createdAt(@Nullable OffsetDateTime createdAt)
    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Get createdAt
      Returns:
      createdAt
    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)
    • dismissStaleApprovals

      public BranchProtection dismissStaleApprovals(@Nullable Boolean dismissStaleApprovals)
    • getDismissStaleApprovals

      @Nullable public Boolean getDismissStaleApprovals()
      Get dismissStaleApprovals
      Returns:
      dismissStaleApprovals
    • setDismissStaleApprovals

      public void setDismissStaleApprovals(@Nullable Boolean dismissStaleApprovals)
    • enableApprovalsWhitelist

      public BranchProtection enableApprovalsWhitelist(@Nullable Boolean enableApprovalsWhitelist)
    • getEnableApprovalsWhitelist

      @Nullable public Boolean getEnableApprovalsWhitelist()
      Get enableApprovalsWhitelist
      Returns:
      enableApprovalsWhitelist
    • setEnableApprovalsWhitelist

      public void setEnableApprovalsWhitelist(@Nullable Boolean enableApprovalsWhitelist)
    • enableMergeWhitelist

      public BranchProtection enableMergeWhitelist(@Nullable Boolean enableMergeWhitelist)
    • getEnableMergeWhitelist

      @Nullable public Boolean getEnableMergeWhitelist()
      Get enableMergeWhitelist
      Returns:
      enableMergeWhitelist
    • setEnableMergeWhitelist

      public void setEnableMergeWhitelist(@Nullable Boolean enableMergeWhitelist)
    • enablePush

      public BranchProtection enablePush(@Nullable Boolean enablePush)
    • getEnablePush

      @Nullable public Boolean getEnablePush()
      Get enablePush
      Returns:
      enablePush
    • setEnablePush

      public void setEnablePush(@Nullable Boolean enablePush)
    • enablePushWhitelist

      public BranchProtection enablePushWhitelist(@Nullable Boolean enablePushWhitelist)
    • getEnablePushWhitelist

      @Nullable public Boolean getEnablePushWhitelist()
      Get enablePushWhitelist
      Returns:
      enablePushWhitelist
    • setEnablePushWhitelist

      public void setEnablePushWhitelist(@Nullable Boolean enablePushWhitelist)
    • enableStatusCheck

      public BranchProtection enableStatusCheck(@Nullable Boolean enableStatusCheck)
    • getEnableStatusCheck

      @Nullable public Boolean getEnableStatusCheck()
      Get enableStatusCheck
      Returns:
      enableStatusCheck
    • setEnableStatusCheck

      public void setEnableStatusCheck(@Nullable Boolean enableStatusCheck)
    • ignoreStaleApprovals

      public BranchProtection ignoreStaleApprovals(@Nullable Boolean ignoreStaleApprovals)
    • getIgnoreStaleApprovals

      @Nullable public Boolean getIgnoreStaleApprovals()
      Get ignoreStaleApprovals
      Returns:
      ignoreStaleApprovals
    • setIgnoreStaleApprovals

      public void setIgnoreStaleApprovals(@Nullable Boolean ignoreStaleApprovals)
    • mergeWhitelistTeams

      public BranchProtection mergeWhitelistTeams(@Nullable List<String> mergeWhitelistTeams)
    • addMergeWhitelistTeamsItem

      public BranchProtection addMergeWhitelistTeamsItem(String mergeWhitelistTeamsItem)
    • getMergeWhitelistTeams

      @Nullable public List<String> getMergeWhitelistTeams()
      Get mergeWhitelistTeams
      Returns:
      mergeWhitelistTeams
    • setMergeWhitelistTeams

      public void setMergeWhitelistTeams(@Nullable List<String> mergeWhitelistTeams)
    • mergeWhitelistUsernames

      public BranchProtection mergeWhitelistUsernames(@Nullable List<String> mergeWhitelistUsernames)
    • addMergeWhitelistUsernamesItem

      public BranchProtection addMergeWhitelistUsernamesItem(String mergeWhitelistUsernamesItem)
    • getMergeWhitelistUsernames

      @Nullable public List<String> getMergeWhitelistUsernames()
      Get mergeWhitelistUsernames
      Returns:
      mergeWhitelistUsernames
    • setMergeWhitelistUsernames

      public void setMergeWhitelistUsernames(@Nullable List<String> mergeWhitelistUsernames)
    • protectedFilePatterns

      public BranchProtection protectedFilePatterns(@Nullable String protectedFilePatterns)
    • getProtectedFilePatterns

      @Nullable public String getProtectedFilePatterns()
      Get protectedFilePatterns
      Returns:
      protectedFilePatterns
    • setProtectedFilePatterns

      public void setProtectedFilePatterns(@Nullable String protectedFilePatterns)
    • pushWhitelistDeployKeys

      public BranchProtection pushWhitelistDeployKeys(@Nullable Boolean pushWhitelistDeployKeys)
    • getPushWhitelistDeployKeys

      @Nullable public Boolean getPushWhitelistDeployKeys()
      Get pushWhitelistDeployKeys
      Returns:
      pushWhitelistDeployKeys
    • setPushWhitelistDeployKeys

      public void setPushWhitelistDeployKeys(@Nullable Boolean pushWhitelistDeployKeys)
    • pushWhitelistTeams

      public BranchProtection pushWhitelistTeams(@Nullable List<String> pushWhitelistTeams)
    • addPushWhitelistTeamsItem

      public BranchProtection addPushWhitelistTeamsItem(String pushWhitelistTeamsItem)
    • getPushWhitelistTeams

      @Nullable public List<String> getPushWhitelistTeams()
      Get pushWhitelistTeams
      Returns:
      pushWhitelistTeams
    • setPushWhitelistTeams

      public void setPushWhitelistTeams(@Nullable List<String> pushWhitelistTeams)
    • pushWhitelistUsernames

      public BranchProtection pushWhitelistUsernames(@Nullable List<String> pushWhitelistUsernames)
    • addPushWhitelistUsernamesItem

      public BranchProtection addPushWhitelistUsernamesItem(String pushWhitelistUsernamesItem)
    • getPushWhitelistUsernames

      @Nullable public List<String> getPushWhitelistUsernames()
      Get pushWhitelistUsernames
      Returns:
      pushWhitelistUsernames
    • setPushWhitelistUsernames

      public void setPushWhitelistUsernames(@Nullable List<String> pushWhitelistUsernames)
    • requireSignedCommits

      public BranchProtection requireSignedCommits(@Nullable Boolean requireSignedCommits)
    • getRequireSignedCommits

      @Nullable public Boolean getRequireSignedCommits()
      Get requireSignedCommits
      Returns:
      requireSignedCommits
    • setRequireSignedCommits

      public void setRequireSignedCommits(@Nullable Boolean requireSignedCommits)
    • requiredApprovals

      public BranchProtection requiredApprovals(@Nullable Long requiredApprovals)
    • getRequiredApprovals

      @Nullable public Long getRequiredApprovals()
      Get requiredApprovals
      Returns:
      requiredApprovals
    • setRequiredApprovals

      public void setRequiredApprovals(@Nullable Long requiredApprovals)
    • ruleName

      public BranchProtection ruleName(@Nullable String ruleName)
    • getRuleName

      @Nullable public String getRuleName()
      Get ruleName
      Returns:
      ruleName
    • setRuleName

      public void setRuleName(@Nullable String ruleName)
    • statusCheckContexts

      public BranchProtection statusCheckContexts(@Nullable List<String> statusCheckContexts)
    • addStatusCheckContextsItem

      public BranchProtection addStatusCheckContextsItem(String statusCheckContextsItem)
    • getStatusCheckContexts

      @Nullable public List<String> getStatusCheckContexts()
      Get statusCheckContexts
      Returns:
      statusCheckContexts
    • setStatusCheckContexts

      public void setStatusCheckContexts(@Nullable List<String> statusCheckContexts)
    • unprotectedFilePatterns

      public BranchProtection unprotectedFilePatterns(@Nullable String unprotectedFilePatterns)
    • getUnprotectedFilePatterns

      @Nullable public String getUnprotectedFilePatterns()
      Get unprotectedFilePatterns
      Returns:
      unprotectedFilePatterns
    • setUnprotectedFilePatterns

      public void setUnprotectedFilePatterns(@Nullable String unprotectedFilePatterns)
    • updatedAt

      public BranchProtection updatedAt(@Nullable OffsetDateTime updatedAt)
    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Get updatedAt
      Returns:
      updatedAt
    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to BranchProtection
    • fromJson

      public static BranchProtection fromJson(String jsonString) throws IOException
      Create an instance of BranchProtection given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of BranchProtection
      Throws:
      IOException - if the JSON string is invalid with respect to BranchProtection
    • toJson

      public String toJson()
      Convert an instance of BranchProtection to an JSON string
      Returns:
      JSON string