Struct ChecksCreateRequest

pub struct ChecksCreateRequest {
    pub name: String,
    pub head_sha: String,
    pub details_url: Option<String>,
    pub external_id: Option<String>,
    pub status: Option<Status>,
    pub started_at: Option<String>,
    pub conclusion: Option<Conclusion>,
    pub completed_at: Option<String>,
    pub output: Option<Box<ChecksCreateRequestOutput>>,
    pub actions: Option<Vec<ChecksCreateRequestActionsInner>>,
}

Fields

name: String

The name of the check. For example, "code-coverage".

head_sha: String

The SHA of the commit.

details_url: Option<String>

The URL of the integrator’s site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

external_id: Option<String>

A reference for the run on the integrator’s system.

status: Option<Status>

The current status.

started_at: Option<String>

The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

conclusion: Option<Conclusion>

Required if you provide completed_at or a status of completed. The final conclusion of the check. Note: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

completed_at: Option<String>

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

output: Option<Box<ChecksCreateRequestOutput>>

actions: Option<Vec<ChecksCreateRequestActionsInner>>

Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "Check runs and requested actions."

Implementations

impl ChecksCreateRequest

pub fn new(name: String, head_sha: String) -> ChecksCreateRequest

Trait Implementations

impl Clone for ChecksCreateRequest

fn clone(&self) -> ChecksCreateRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChecksCreateRequest

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

Formats the value using the given formatter.

impl Default for ChecksCreateRequest

fn default() -> ChecksCreateRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChecksCreateRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChecksCreateRequest

fn eq(&self, other: &ChecksCreateRequest) -> 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 ChecksCreateRequest

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 ChecksCreateRequest