Struct ReposUpdateBranchProtectionRequest

pub struct ReposUpdateBranchProtectionRequest {
    pub required_status_checks: Option<Box<ReposUpdateBranchProtectionRequestRequiredStatusChecks>>,
    pub enforce_admins: Option<bool>,
    pub required_pull_request_reviews: Option<Box<ReposUpdateBranchProtectionRequestRequiredPullRequestReviews>>,
    pub restrictions: Option<Box<ReposUpdateBranchProtectionRequestRestrictions>>,
    pub required_linear_history: Option<bool>,
    pub allow_force_pushes: Option<Option<bool>>,
    pub allow_deletions: Option<bool>,
    pub block_creations: Option<bool>,
    pub required_conversation_resolution: Option<bool>,
    pub lock_branch: Option<bool>,
    pub allow_fork_syncing: Option<bool>,
}

Fields

required_status_checks: Option<Box<ReposUpdateBranchProtectionRequestRequiredStatusChecks>>

enforce_admins: Option<bool>

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

required_pull_request_reviews: Option<Box<ReposUpdateBranchProtectionRequestRequiredPullRequestReviews>>

restrictions: Option<Box<ReposUpdateBranchProtectionRequestRestrictions>>

required_linear_history: Option<bool>

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see "Requiring a linear commit history" in the GitHub Help documentation.

allow_force_pushes: Option<Option<bool>>

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation."

allow_deletions: Option<bool>

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation.

block_creations: Option<bool>

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

required_conversation_resolution: Option<bool>

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

lock_branch: Option<bool>

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: false.

allow_fork_syncing: Option<bool>

Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing. Default: false.

Implementations

impl ReposUpdateBranchProtectionRequest

pub fn new( required_status_checks: Option<ReposUpdateBranchProtectionRequestRequiredStatusChecks>, enforce_admins: Option<bool>, required_pull_request_reviews: Option<ReposUpdateBranchProtectionRequestRequiredPullRequestReviews>, restrictions: Option<ReposUpdateBranchProtectionRequestRestrictions>, ) -> ReposUpdateBranchProtectionRequest

Trait Implementations

impl Clone for ReposUpdateBranchProtectionRequest

fn clone(&self) -> ReposUpdateBranchProtectionRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReposUpdateBranchProtectionRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReposUpdateBranchProtectionRequest

fn default() -> ReposUpdateBranchProtectionRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReposUpdateBranchProtectionRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReposUpdateBranchProtectionRequest

fn eq(&self, other: &ReposUpdateBranchProtectionRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ReposUpdateBranchProtectionRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReposUpdateBranchProtectionRequest