Struct CheckSuiteCompletedCheckSuite

pub struct CheckSuiteCompletedCheckSuite {

    pub after: Option<String>,
    pub app: App,
    pub before: Option<String>,
    pub check_runs_url: String,
    pub conclusion: Option<CheckSuiteCompletedCheckSuiteConclusion>,
    pub created_at: DateTime<Utc>,
    pub head_branch: Option<String>,
    pub head_commit: CommitSimple,
    pub head_sha: String,
    pub id: i64,
    pub latest_check_runs_count: i64,
    pub node_id: String,
    pub pull_requests: Vec<CheckRunPullRequest>,
    pub rerequestable: Option<bool>,
    pub runs_rerequestable: Option<bool>,
    pub status: Option<CheckSuiteCompletedCheckSuiteStatus>,
    pub updated_at: DateTime<Utc>,
    pub url: String,
}

The check_suite.

JSON schema

{
 "description": "The [check_suite](https://docs.github.com/en/rest/reference/checks#suites).",
 "type": "object",
 "required": [
   "after",
   "app",
   "before",
   "check_runs_url",
   "conclusion",
   "created_at",
   "head_branch",
   "head_commit",
   "head_sha",
   "id",
   "latest_check_runs_count",
   "node_id",
   "pull_requests",
   "status",
   "updated_at",
   "url"
 ],
 "properties": {
   "after": {
     "type": [
       "string",
       "null"
     ]
   },
   "app": {
     "$ref": "#/definitions/app"
   },
   "before": {
     "type": [
       "string",
       "null"
     ]
   },
   "check_runs_url": {
     "type": "string",
     "format": "uri"
   },
   "conclusion": {
     "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.",
     "type": [
       "string",
       "null"
     ],
     "enum": [
       "success",
       "failure",
       "neutral",
       "cancelled",
       "timed_out",
       "action_required",
       "stale",
       null
     ]
   },
   "created_at": {
     "type": "string",
     "format": "date-time"
   },
   "head_branch": {
     "description": "The head branch name the changes are on.",
     "type": [
       "string",
       "null"
     ]
   },
   "head_commit": {
     "$ref": "#/definitions/commit-simple"
   },
   "head_sha": {
     "description": "The SHA of the head commit that is being checked.",
     "type": "string"
   },
   "id": {
     "type": "integer"
   },
   "latest_check_runs_count": {
     "type": "integer"
   },
   "node_id": {
     "type": "string"
   },
   "pull_requests": {
     "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
     "type": "array",
     "items": {
       "$ref": "#/definitions/check-run-pull-request"
     }
   },
   "rerequestable": {
     "type": "boolean"
   },
   "runs_rerequestable": {
     "type": "boolean"
   },
   "status": {
     "description": "The summary status for all check runs that are part of the check suite. Can be `queued`, `requested`, `in_progress`, or `completed`.",
     "type": [
       "string",
       "null"
     ],
     "enum": [
       "requested",
       "in_progress",
       "completed",
       "queued",
       null
     ]
   },
   "updated_at": {
     "type": "string",
     "format": "date-time"
   },
   "url": {
     "description": "URL that points to the check suite API resource.",
     "type": "string",
     "format": "uri"
   }
 },
 "additionalProperties": false
}

Fields

after: Option<String>

app: App

before: Option<String>

check_runs_url: String

conclusion: Option<CheckSuiteCompletedCheckSuiteConclusion>

The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.

created_at: DateTime<Utc>

head_branch: Option<String>

The head branch name the changes are on.

head_commit: CommitSimple

head_sha: String

The SHA of the head commit that is being checked.

id: i64

latest_check_runs_count: i64

node_id: String

pull_requests: Vec<CheckRunPullRequest>

An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_sha and head_branch. When the check suite’s head_branch is in a forked repository it will be null and the pull_requests array will be empty.

rerequestable: Option<bool>

runs_rerequestable: Option<bool>

status: Option<CheckSuiteCompletedCheckSuiteStatus>

The summary status for all check runs that are part of the check suite. Can be queued, requested, in_progress, or completed.

updated_at: DateTime<Utc>

url: String

URL that points to the check suite API resource.

Implementations

impl CheckSuiteCompletedCheckSuite

pub fn builder() -> CheckSuiteCompletedCheckSuite

Trait Implementations

impl Clone for CheckSuiteCompletedCheckSuite

fn clone(&self) -> CheckSuiteCompletedCheckSuite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckSuiteCompletedCheckSuite

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CheckSuiteCompletedCheckSuite

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CheckSuiteCompletedCheckSuite> for CheckSuiteCompletedCheckSuite

fn from(value: &CheckSuiteCompletedCheckSuite) -> Self

Converts to this type from the input type.

impl From<CheckSuiteCompletedCheckSuite> for CheckSuiteCompletedCheckSuite

fn from(value: CheckSuiteCompletedCheckSuite) -> Self

Converts to this type from the input type.

impl Serialize for CheckSuiteCompletedCheckSuite

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CheckSuiteCompletedCheckSuite> for CheckSuiteCompletedCheckSuite

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.