Class CreateBranchProtectionOption
java.lang.Object
build.cursed.genapi.forgejo.model.CreateBranchProtectionOption
@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 CreateBranchProtectionOption
extends Object
CreateBranchProtectionOption options for creating a branch protection
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class -
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 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) dismissStaleApprovals(Boolean dismissStaleApprovals) enableApprovalsWhitelist(Boolean enableApprovalsWhitelist) enableMergeWhitelist(Boolean enableMergeWhitelist) enablePush(Boolean enablePush) enablePushWhitelist(Boolean enablePushWhitelist) enableStatusCheck(Boolean enableStatusCheck) booleanstatic CreateBranchProtectionOptionCreate an instance of CreateBranchProtectionOption given an JSON stringGet applyToAdminsGet approvalsWhitelistTeamsGet approvalsWhitelistUsernameGet blockOnOfficialReviewRequestsGet blockOnOutdatedBranchGet blockOnRejectedReviewsDeprecated: trueGet dismissStaleApprovalsGet enableApprovalsWhitelistGet enableMergeWhitelistGet enablePushGet enablePushWhitelistGet enableStatusCheckGet ignoreStaleApprovalsGet mergeWhitelistTeamsGet mergeWhitelistUsernamesGet protectedFilePatternsGet pushWhitelistDeployKeysGet pushWhitelistTeamsGet pushWhitelistUsernamesGet requiredApprovalsGet requireSignedCommitsGet ruleNameGet statusCheckContextsGet unprotectedFilePatternsinthashCode()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) 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) statusCheckContexts(List<String> statusCheckContexts) toJson()Convert an instance of CreateBranchProtectionOption to an JSON stringtoString()unprotectedFilePatterns(String unprotectedFilePatterns) 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_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:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
CreateBranchProtectionOption
public CreateBranchProtectionOption()
-
-
Method Details
-
applyToAdmins
-
getApplyToAdmins
Get applyToAdmins- Returns:
- applyToAdmins
-
setApplyToAdmins
-
approvalsWhitelistTeams
public CreateBranchProtectionOption approvalsWhitelistTeams(@Nullable List<String> approvalsWhitelistTeams) -
addApprovalsWhitelistTeamsItem
public CreateBranchProtectionOption addApprovalsWhitelistTeamsItem(String approvalsWhitelistTeamsItem) -
getApprovalsWhitelistTeams
Get approvalsWhitelistTeams- Returns:
- approvalsWhitelistTeams
-
setApprovalsWhitelistTeams
-
approvalsWhitelistUsername
public CreateBranchProtectionOption approvalsWhitelistUsername(@Nullable List<String> approvalsWhitelistUsername) -
addApprovalsWhitelistUsernameItem
public CreateBranchProtectionOption addApprovalsWhitelistUsernameItem(String approvalsWhitelistUsernameItem) -
getApprovalsWhitelistUsername
Get approvalsWhitelistUsername- Returns:
- approvalsWhitelistUsername
-
setApprovalsWhitelistUsername
-
blockOnOfficialReviewRequests
public CreateBranchProtectionOption blockOnOfficialReviewRequests(@Nullable Boolean blockOnOfficialReviewRequests) -
getBlockOnOfficialReviewRequests
Get blockOnOfficialReviewRequests- Returns:
- blockOnOfficialReviewRequests
-
setBlockOnOfficialReviewRequests
-
blockOnOutdatedBranch
-
getBlockOnOutdatedBranch
Get blockOnOutdatedBranch- Returns:
- blockOnOutdatedBranch
-
setBlockOnOutdatedBranch
-
blockOnRejectedReviews
public CreateBranchProtectionOption blockOnRejectedReviews(@Nullable Boolean blockOnRejectedReviews) -
getBlockOnRejectedReviews
Get blockOnRejectedReviews- Returns:
- blockOnRejectedReviews
-
setBlockOnRejectedReviews
-
branchName
-
getBranchName
Deprecated: true- Returns:
- branchName
-
setBranchName
-
dismissStaleApprovals
-
getDismissStaleApprovals
Get dismissStaleApprovals- Returns:
- dismissStaleApprovals
-
setDismissStaleApprovals
-
enableApprovalsWhitelist
public CreateBranchProtectionOption enableApprovalsWhitelist(@Nullable Boolean 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
public CreateBranchProtectionOption mergeWhitelistUsernames(@Nullable List<String> mergeWhitelistUsernames) -
addMergeWhitelistUsernamesItem
public CreateBranchProtectionOption addMergeWhitelistUsernamesItem(String mergeWhitelistUsernamesItem) -
getMergeWhitelistUsernames
Get mergeWhitelistUsernames- Returns:
- mergeWhitelistUsernames
-
setMergeWhitelistUsernames
-
protectedFilePatterns
-
getProtectedFilePatterns
Get protectedFilePatterns- Returns:
- protectedFilePatterns
-
setProtectedFilePatterns
-
pushWhitelistDeployKeys
public CreateBranchProtectionOption pushWhitelistDeployKeys(@Nullable Boolean pushWhitelistDeployKeys) -
getPushWhitelistDeployKeys
Get pushWhitelistDeployKeys- Returns:
- pushWhitelistDeployKeys
-
setPushWhitelistDeployKeys
-
pushWhitelistTeams
-
addPushWhitelistTeamsItem
-
getPushWhitelistTeams
Get pushWhitelistTeams- Returns:
- pushWhitelistTeams
-
setPushWhitelistTeams
-
pushWhitelistUsernames
public CreateBranchProtectionOption pushWhitelistUsernames(@Nullable List<String> pushWhitelistUsernames) -
addPushWhitelistUsernamesItem
public CreateBranchProtectionOption addPushWhitelistUsernamesItem(String pushWhitelistUsernamesItem) -
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
public CreateBranchProtectionOption unprotectedFilePatterns(@Nullable String unprotectedFilePatterns) -
getUnprotectedFilePatterns
Get unprotectedFilePatterns- Returns:
- unprotectedFilePatterns
-
setUnprotectedFilePatterns
-
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 CreateBranchProtectionOption
-
fromJson
Create an instance of CreateBranchProtectionOption given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of CreateBranchProtectionOption
- Throws:
IOException- if the JSON string is invalid with respect to CreateBranchProtectionOption
-
toJson
Convert an instance of CreateBranchProtectionOption to an JSON string- Returns:
- JSON string
-