Struct BranchProtectionRuleEdited

pub struct BranchProtectionRuleEdited {
    pub action: BranchProtectionRuleEditedAction,
    pub changes: Option<BranchProtectionRuleEditedChanges>,
    pub installation: Option<InstallationLite>,
    pub organization: Option<Organization>,
    pub repository: Repository,
    pub rule: BranchProtectionRule,
    pub sender: User,
}

Activity related to a branch protection rule. For more information, see “About branch protection rules.”

JSON schema

{
 "title": "branch protection rule edited event",
 "description": "Activity related to a branch protection rule. For more information, see \"[About branch protection rules](https://docs.github.com/en/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-rules).\"",
 "type": "object",
 "required": [
   "action",
   "repository",
   "rule",
   "sender"
 ],
 "properties": {
   "action": {
     "type": "string",
     "enum": [
       "edited"
     ]
   },
   "changes": {
     "description": "If the action was `edited`, the changes to the rule.",
     "type": "object",
     "properties": {
       "admin_enforced": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-boolean"
           }
         },
         "additionalProperties": false
       },
       "allow_deletions_enforcement_level": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "oneOf": [
               {
                 "$ref": "#/definitions/branch-protection-rule-enforcement-level"
               },
               {
                 "type": "null"
               }
             ]
           }
         },
         "additionalProperties": false
       },
       "allow_force_pushes_enforcement_level": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-enforcement-level"
           }
         },
         "additionalProperties": false
       },
       "authorized_actor_names": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-array"
           }
         },
         "additionalProperties": false
       },
       "authorized_actors_only": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-boolean"
           }
         },
         "additionalProperties": false
       },
       "authorized_dismissal_actors_only": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "oneOf": [
               {
                 "$ref": "#/definitions/branch-protection-rule-boolean"
               },
               {
                 "type": "null"
               }
             ]
           }
         },
         "additionalProperties": false
       },
       "dismiss_stale_reviews_on_push": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-boolean"
           }
         },
         "additionalProperties": false
       },
       "linear_history_requirement_enforcement_level": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-enforcement-level"
           }
         },
         "additionalProperties": false
       },
       "pull_request_reviews_enforcement_level": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-enforcement-level"
           }
         },
         "additionalProperties": false
       },
       "require_code_owner_review": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-boolean"
           }
         },
         "additionalProperties": false
       },
       "required_approving_review_count": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-number"
           }
         },
         "additionalProperties": false
       },
       "required_conversation_resolution_level": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-enforcement-level"
           }
         },
         "additionalProperties": false
       },
       "required_deployments_enforcement_level": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-enforcement-level"
           }
         },
         "additionalProperties": false
       },
       "required_status_checks": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-array"
           }
         },
         "additionalProperties": false
       },
       "required_status_checks_enforcement_level": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-enforcement-level"
           }
         },
         "additionalProperties": false
       },
       "signature_requirement_enforcement_level": {
         "type": "object",
         "required": [
           "from"
         ],
         "properties": {
           "from": {
             "$ref": "#/definitions/branch-protection-rule-enforcement-level"
           }
         },
         "additionalProperties": false
       }
     },
     "additionalProperties": false
   },
   "installation": {
     "$ref": "#/definitions/installation-lite"
   },
   "organization": {
     "$ref": "#/definitions/organization"
   },
   "repository": {
     "$ref": "#/definitions/repository"
   },
   "rule": {
     "$ref": "#/definitions/branch-protection-rule"
   },
   "sender": {
     "$ref": "#/definitions/user"
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}

Fields

action: BranchProtectionRuleEditedAction

changes: Option<BranchProtectionRuleEditedChanges>

installation: Option<InstallationLite>

organization: Option<Organization>

repository: Repository

rule: BranchProtectionRule

sender: User

Implementations

impl BranchProtectionRuleEdited

pub fn builder() -> BranchProtectionRuleEdited

Trait Implementations

impl Clone for BranchProtectionRuleEdited

fn clone(&self) -> BranchProtectionRuleEdited

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BranchProtectionRuleEdited

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BranchProtectionRuleEdited

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&BranchProtectionRuleEdited> for BranchProtectionRuleEdited

fn from(value: &BranchProtectionRuleEdited) -> Self

Converts to this type from the input type.

impl From<BranchProtectionRuleEdited> for BranchProtectionRuleEdited

fn from(value: BranchProtectionRuleEdited) -> Self

Converts to this type from the input type.

impl From<BranchProtectionRuleEdited> for BranchProtectionRuleEvent

fn from(value: BranchProtectionRuleEdited) -> Self

Converts to this type from the input type.

impl Serialize for BranchProtectionRuleEdited

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<BranchProtectionRuleEdited> for BranchProtectionRuleEdited

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: BranchProtectionRuleEdited) -> Result<Self, String>

Performs the conversion.