Class BranchProtection
java.lang.Object
build.cursed.genapi.forgejo.model.BranchProtection
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2026-09-28T10:48:29.723777+02:00[Europe/Stockholm]",
comments="Generator version: 7.21.0")
public class BranchProtection
extends Object
BranchProtection represents a branch protection for a repository
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddApprovalsWhitelistTeamsItem(String approvalsWhitelistTeamsItem) addApprovalsWhitelistUsernameItem(String approvalsWhitelistUsernameItem) addMergeWhitelistTeamsItem(String mergeWhitelistTeamsItem) addMergeWhitelistUsernamesItem(String mergeWhitelistUsernamesItem) addPushWhitelistTeamsItem(String pushWhitelistTeamsItem) addPushWhitelistUsernamesItem(String pushWhitelistUsernamesItem) addStatusCheckContextsItem(String statusCheckContextsItem) applyToAdmins(Boolean applyToAdmins) approvalsWhitelistTeams(List<String> approvalsWhitelistTeams) approvalsWhitelistUsername(List<String> approvalsWhitelistUsername) blockOnOfficialReviewRequests(Boolean blockOnOfficialReviewRequests) blockOnOutdatedBranch(Boolean blockOnOutdatedBranch) blockOnRejectedReviews(Boolean blockOnRejectedReviews) branchName(String branchName) createdAt(OffsetDateTime createdAt) dismissStaleApprovals(Boolean dismissStaleApprovals) enableApprovalsWhitelist(Boolean enableApprovalsWhitelist) enableMergeWhitelist(Boolean enableMergeWhitelist) enablePush(Boolean enablePush) enablePushWhitelist(Boolean enablePushWhitelist) enableStatusCheck(Boolean enableStatusCheck) booleanstatic BranchProtectionCreate an instance of BranchProtection given an JSON stringGet applyToAdminsGet approvalsWhitelistTeamsGet approvalsWhitelistUsernameGet blockOnOfficialReviewRequestsGet blockOnOutdatedBranchGet blockOnRejectedReviewsDeprecated: trueGet createdAtGet dismissStaleApprovalsGet enableApprovalsWhitelistGet enableMergeWhitelistGet enablePushGet enablePushWhitelistGet enableStatusCheckGet ignoreStaleApprovalsGet mergeWhitelistTeamsGet mergeWhitelistUsernamesGet protectedFilePatternsGet pushWhitelistDeployKeysGet pushWhitelistTeamsGet pushWhitelistUsernamesGet requiredApprovalsGet requireSignedCommitsGet ruleNameGet statusCheckContextsGet unprotectedFilePatternsGet updatedAtinthashCode()ignoreStaleApprovals(Boolean ignoreStaleApprovals) mergeWhitelistTeams(List<String> mergeWhitelistTeams) mergeWhitelistUsernames(List<String> mergeWhitelistUsernames) protectedFilePatterns(String protectedFilePatterns) pushWhitelistDeployKeys(Boolean pushWhitelistDeployKeys) pushWhitelistTeams(List<String> pushWhitelistTeams) pushWhitelistUsernames(List<String> pushWhitelistUsernames) requiredApprovals(Long requiredApprovals) requireSignedCommits(Boolean requireSignedCommits) voidsetApplyToAdmins(Boolean applyToAdmins) voidsetApprovalsWhitelistTeams(List<String> approvalsWhitelistTeams) voidsetApprovalsWhitelistUsername(List<String> approvalsWhitelistUsername) voidsetBlockOnOfficialReviewRequests(Boolean blockOnOfficialReviewRequests) voidsetBlockOnOutdatedBranch(Boolean blockOnOutdatedBranch) voidsetBlockOnRejectedReviews(Boolean blockOnRejectedReviews) voidsetBranchName(String branchName) voidsetCreatedAt(OffsetDateTime createdAt) voidsetDismissStaleApprovals(Boolean dismissStaleApprovals) voidsetEnableApprovalsWhitelist(Boolean enableApprovalsWhitelist) voidsetEnableMergeWhitelist(Boolean enableMergeWhitelist) voidsetEnablePush(Boolean enablePush) voidsetEnablePushWhitelist(Boolean enablePushWhitelist) voidsetEnableStatusCheck(Boolean enableStatusCheck) voidsetIgnoreStaleApprovals(Boolean ignoreStaleApprovals) voidsetMergeWhitelistTeams(List<String> mergeWhitelistTeams) voidsetMergeWhitelistUsernames(List<String> mergeWhitelistUsernames) voidsetProtectedFilePatterns(String protectedFilePatterns) voidsetPushWhitelistDeployKeys(Boolean pushWhitelistDeployKeys) voidsetPushWhitelistTeams(List<String> pushWhitelistTeams) voidsetPushWhitelistUsernames(List<String> pushWhitelistUsernames) voidsetRequiredApprovals(Long requiredApprovals) voidsetRequireSignedCommits(Boolean requireSignedCommits) voidsetRuleName(String ruleName) voidsetStatusCheckContexts(List<String> statusCheckContexts) voidsetUnprotectedFilePatterns(String unprotectedFilePatterns) voidsetUpdatedAt(OffsetDateTime updatedAt) statusCheckContexts(List<String> statusCheckContexts) toJson()Convert an instance of BranchProtection to an JSON stringtoString()unprotectedFilePatterns(String unprotectedFilePatterns) updatedAt(OffsetDateTime updatedAt) static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found
-
Field Details
-
SERIALIZED_NAME_APPLY_TO_ADMINS
- See Also:
-
SERIALIZED_NAME_APPROVALS_WHITELIST_TEAMS
- See Also:
-
SERIALIZED_NAME_APPROVALS_WHITELIST_USERNAME
- See Also:
-
SERIALIZED_NAME_BLOCK_ON_OFFICIAL_REVIEW_REQUESTS
- See Also:
-
SERIALIZED_NAME_BLOCK_ON_OUTDATED_BRANCH
- See Also:
-
SERIALIZED_NAME_BLOCK_ON_REJECTED_REVIEWS
- See Also:
-
SERIALIZED_NAME_BRANCH_NAME
- See Also:
-
SERIALIZED_NAME_CREATED_AT
- See Also:
-
SERIALIZED_NAME_DISMISS_STALE_APPROVALS
- See Also:
-
SERIALIZED_NAME_ENABLE_APPROVALS_WHITELIST
- See Also:
-
SERIALIZED_NAME_ENABLE_MERGE_WHITELIST
- See Also:
-
SERIALIZED_NAME_ENABLE_PUSH
- See Also:
-
SERIALIZED_NAME_ENABLE_PUSH_WHITELIST
- See Also:
-
SERIALIZED_NAME_ENABLE_STATUS_CHECK
- See Also:
-
SERIALIZED_NAME_IGNORE_STALE_APPROVALS
- See Also:
-
SERIALIZED_NAME_MERGE_WHITELIST_TEAMS
- See Also:
-
SERIALIZED_NAME_MERGE_WHITELIST_USERNAMES
- See Also:
-
SERIALIZED_NAME_PROTECTED_FILE_PATTERNS
- See Also:
-
SERIALIZED_NAME_PUSH_WHITELIST_DEPLOY_KEYS
- See Also:
-
SERIALIZED_NAME_PUSH_WHITELIST_TEAMS
- See Also:
-
SERIALIZED_NAME_PUSH_WHITELIST_USERNAMES
- See Also:
-
SERIALIZED_NAME_REQUIRE_SIGNED_COMMITS
- See Also:
-
SERIALIZED_NAME_REQUIRED_APPROVALS
- See Also:
-
SERIALIZED_NAME_RULE_NAME
- See Also:
-
SERIALIZED_NAME_STATUS_CHECK_CONTEXTS
- See Also:
-
SERIALIZED_NAME_UNPROTECTED_FILE_PATTERNS
- See Also:
-
SERIALIZED_NAME_UPDATED_AT
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
BranchProtection
public BranchProtection()
-
-
Method Details
-
applyToAdmins
-
getApplyToAdmins
Get applyToAdmins- Returns:
- applyToAdmins
-
setApplyToAdmins
-
approvalsWhitelistTeams
-
addApprovalsWhitelistTeamsItem
-
getApprovalsWhitelistTeams
Get approvalsWhitelistTeams- Returns:
- approvalsWhitelistTeams
-
setApprovalsWhitelistTeams
-
approvalsWhitelistUsername
public BranchProtection approvalsWhitelistUsername(@Nullable List<String> approvalsWhitelistUsername) -
addApprovalsWhitelistUsernameItem
-
getApprovalsWhitelistUsername
Get approvalsWhitelistUsername- Returns:
- approvalsWhitelistUsername
-
setApprovalsWhitelistUsername
-
blockOnOfficialReviewRequests
public BranchProtection blockOnOfficialReviewRequests(@Nullable Boolean blockOnOfficialReviewRequests) -
getBlockOnOfficialReviewRequests
Get blockOnOfficialReviewRequests- Returns:
- blockOnOfficialReviewRequests
-
setBlockOnOfficialReviewRequests
-
blockOnOutdatedBranch
-
getBlockOnOutdatedBranch
Get blockOnOutdatedBranch- Returns:
- blockOnOutdatedBranch
-
setBlockOnOutdatedBranch
-
blockOnRejectedReviews
-
getBlockOnRejectedReviews
Get blockOnRejectedReviews- Returns:
- blockOnRejectedReviews
-
setBlockOnRejectedReviews
-
branchName
-
getBranchName
Deprecated: true- Returns:
- branchName
-
setBranchName
-
createdAt
-
getCreatedAt
Get createdAt- Returns:
- createdAt
-
setCreatedAt
-
dismissStaleApprovals
-
getDismissStaleApprovals
Get dismissStaleApprovals- Returns:
- dismissStaleApprovals
-
setDismissStaleApprovals
-
enableApprovalsWhitelist
-
getEnableApprovalsWhitelist
Get enableApprovalsWhitelist- Returns:
- enableApprovalsWhitelist
-
setEnableApprovalsWhitelist
-
enableMergeWhitelist
-
getEnableMergeWhitelist
Get enableMergeWhitelist- Returns:
- enableMergeWhitelist
-
setEnableMergeWhitelist
-
enablePush
-
getEnablePush
Get enablePush- Returns:
- enablePush
-
setEnablePush
-
enablePushWhitelist
-
getEnablePushWhitelist
Get enablePushWhitelist- Returns:
- enablePushWhitelist
-
setEnablePushWhitelist
-
enableStatusCheck
-
getEnableStatusCheck
Get enableStatusCheck- Returns:
- enableStatusCheck
-
setEnableStatusCheck
-
ignoreStaleApprovals
-
getIgnoreStaleApprovals
Get ignoreStaleApprovals- Returns:
- ignoreStaleApprovals
-
setIgnoreStaleApprovals
-
mergeWhitelistTeams
-
addMergeWhitelistTeamsItem
-
getMergeWhitelistTeams
Get mergeWhitelistTeams- Returns:
- mergeWhitelistTeams
-
setMergeWhitelistTeams
-
mergeWhitelistUsernames
-
addMergeWhitelistUsernamesItem
-
getMergeWhitelistUsernames
Get mergeWhitelistUsernames- Returns:
- mergeWhitelistUsernames
-
setMergeWhitelistUsernames
-
protectedFilePatterns
-
getProtectedFilePatterns
Get protectedFilePatterns- Returns:
- protectedFilePatterns
-
setProtectedFilePatterns
-
pushWhitelistDeployKeys
-
getPushWhitelistDeployKeys
Get pushWhitelistDeployKeys- Returns:
- pushWhitelistDeployKeys
-
setPushWhitelistDeployKeys
-
pushWhitelistTeams
-
addPushWhitelistTeamsItem
-
getPushWhitelistTeams
Get pushWhitelistTeams- Returns:
- pushWhitelistTeams
-
setPushWhitelistTeams
-
pushWhitelistUsernames
-
addPushWhitelistUsernamesItem
-
getPushWhitelistUsernames
Get pushWhitelistUsernames- Returns:
- pushWhitelistUsernames
-
setPushWhitelistUsernames
-
requireSignedCommits
-
getRequireSignedCommits
Get requireSignedCommits- Returns:
- requireSignedCommits
-
setRequireSignedCommits
-
requiredApprovals
-
getRequiredApprovals
Get requiredApprovals- Returns:
- requiredApprovals
-
setRequiredApprovals
-
ruleName
-
getRuleName
Get ruleName- Returns:
- ruleName
-
setRuleName
-
statusCheckContexts
-
addStatusCheckContextsItem
-
getStatusCheckContexts
Get statusCheckContexts- Returns:
- statusCheckContexts
-
setStatusCheckContexts
-
unprotectedFilePatterns
-
getUnprotectedFilePatterns
Get unprotectedFilePatterns- Returns:
- unprotectedFilePatterns
-
setUnprotectedFilePatterns
-
updatedAt
-
getUpdatedAt
Get updatedAt- Returns:
- updatedAt
-
setUpdatedAt
-
equals
-
hashCode
public int hashCode() -
toString
-
validateJsonElement
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
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
Convert an instance of BranchProtection to an JSON string- Returns:
- JSON string
-