Struct CreateEvent

pub struct CreateEvent {
    pub description: Option<String>,
    pub installation: Option<InstallationLite>,
    pub master_branch: String,
    pub organization: Option<Organization>,
    pub pusher_type: String,
    pub ref_: String,
    pub ref_type: CreateEventRefType,
    pub repository: Repository,
    pub sender: User,
}

A Git branch or tag is created.

JSON schema

{
 "title": "create event",
 "description": "A Git branch or tag is created.",
 "type": "object",
 "required": [
   "description",
   "master_branch",
   "pusher_type",
   "ref",
   "ref_type",
   "repository",
   "sender"
 ],
 "properties": {
   "description": {
     "description": "The repository's current description.",
     "type": [
       "string",
       "null"
     ]
   },
   "installation": {
     "$ref": "#/definitions/installation-lite"
   },
   "master_branch": {
     "description": "The name of the repository's default branch (usually `main`).",
     "type": "string"
   },
   "organization": {
     "$ref": "#/definitions/organization"
   },
   "pusher_type": {
     "description": "The pusher type for the event. Can be either `user` or a deploy key.",
     "type": "string"
   },
   "ref": {
     "description": "The [`git ref`](https://docs.github.com/en/rest/reference/git#get-a-reference) resource.",
     "type": "string"
   },
   "ref_type": {
     "description": "The type of Git ref object created in the repository. Can be either `branch` or `tag`.",
     "type": "string",
     "enum": [
       "tag",
       "branch"
     ]
   },
   "repository": {
     "$ref": "#/definitions/repository"
   },
   "sender": {
     "$ref": "#/definitions/user"
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}

Fields

description: Option<String>

The repository’s current description.

installation: Option<InstallationLite>

master_branch: String

The name of the repository’s default branch (usually main).

organization: Option<Organization>

pusher_type: String

The pusher type for the event. Can be either user or a deploy key.

ref_: String

The git ref resource.

ref_type: CreateEventRefType

The type of Git ref object created in the repository. Can be either branch or tag.

repository: Repository

sender: User

Implementations

impl CreateEvent

pub fn builder() -> CreateEvent

Trait Implementations

impl Clone for CreateEvent

fn clone(&self) -> CreateEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CreateEvent> for CreateEvent

fn from(value: &CreateEvent) -> Self

Converts to this type from the input type.

impl From<CreateEvent> for CreateEvent

fn from(value: CreateEvent) -> Self

Converts to this type from the input type.

impl Serialize for CreateEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateEvent> for CreateEvent

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.