Struct WorkflowDispatchEvent

pub struct WorkflowDispatchEvent {
    pub inputs: Option<Map<String, Value>>,
    pub installation: Option<InstallationLite>,
    pub organization: Option<Organization>,
    pub ref_: String,
    pub repository: Repository,
    pub sender: User,
    pub workflow: String,
}

WorkflowDispatchEvent

JSON schema

{
 "title": "workflow_dispatch event",
 "type": "object",
 "required": [
   "inputs",
   "ref",
   "repository",
   "sender",
   "workflow"
 ],
 "properties": {
   "inputs": {
     "description": "Inputs to the workflow. Each key represents the name of the input while it's value represents the value of that input.",
     "oneOf": [
       {
         "type": "object",
         "additionalProperties": true
       },
       {
         "type": "null"
       }
     ]
   },
   "installation": {
     "$ref": "#/definitions/installation-lite"
   },
   "organization": {
     "$ref": "#/definitions/organization"
   },
   "ref": {
     "description": "The branch ref from which the workflow was run.",
     "type": "string"
   },
   "repository": {
     "$ref": "#/definitions/repository"
   },
   "sender": {
     "$ref": "#/definitions/user"
   },
   "workflow": {
     "description": "Relative path to the workflow file which contains the workflow.",
     "type": "string"
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}

Fields

inputs: Option<Map<String, Value>>

Inputs to the workflow. Each key represents the name of the input while it’s value represents the value of that input.

installation: Option<InstallationLite>

organization: Option<Organization>

ref_: String

The branch ref from which the workflow was run.

repository: Repository

sender: User

workflow: String

Relative path to the workflow file which contains the workflow.

Implementations

impl WorkflowDispatchEvent

pub fn builder() -> WorkflowDispatchEvent

Trait Implementations

impl Clone for WorkflowDispatchEvent

fn clone(&self) -> WorkflowDispatchEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowDispatchEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkflowDispatchEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&WorkflowDispatchEvent> for WorkflowDispatchEvent

fn from(value: &WorkflowDispatchEvent) -> Self

Converts to this type from the input type.

impl From<WorkflowDispatchEvent> for WorkflowDispatchEvent

fn from(value: WorkflowDispatchEvent) -> Self

Converts to this type from the input type.

impl Serialize for WorkflowDispatchEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<WorkflowDispatchEvent> for WorkflowDispatchEvent

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.