Struct CIAppPipelineEventStep

#[non_exhaustive]
pub struct CIAppPipelineEventStep {

    pub end: DateTime<Utc>,
    pub error: Option<Option<CIAppCIError>>,
    pub git: Option<Option<CIAppGitInfo>>,
    pub id: String,
    pub job_id: Option<Option<String>>,
    pub job_name: Option<Option<String>>,
    pub level: CIAppPipelineEventStepLevel,
    pub metrics: Option<Option<Vec<String>>>,
    pub name: String,
    pub node: Option<Option<CIAppHostInfo>>,
    pub parameters: Option<Option<BTreeMap<String, String>>>,
    pub pipeline_name: String,
    pub pipeline_unique_id: String,
    pub stage_id: Option<Option<String>>,
    pub stage_name: Option<Option<String>>,
    pub start: DateTime<Utc>,
    pub status: CIAppPipelineEventStepStatus,
    pub tags: Option<Option<Vec<String>>>,
    pub url: Option<Option<String>>,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

Details of a CI step.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

end: DateTime<Utc>

Time when the step run finished. The time format must be RFC3339.

error: Option<Option<CIAppCIError>>

Contains information of the CI error.

git: Option<Option<CIAppGitInfo>>

If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.

id: String

UUID for the step. It has to be unique within each pipeline execution.

job_id: Option<Option<String>>

The parent job UUID (if applicable).

job_name: Option<Option<String>>

The parent job name (if applicable).

level: CIAppPipelineEventStepLevel

Used to distinguish between pipelines, stages, jobs and steps.

metrics: Option<Option<Vec<String>>>

A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.

name: String

The name for the step.

node: Option<Option<CIAppHostInfo>>

Contains information of the host running the pipeline, stage, job, or step.

parameters: Option<Option<BTreeMap<String, String>>>

A map of key-value parameters or environment variables that were defined for the pipeline.

pipeline_name: String

The parent pipeline name.

pipeline_unique_id: String

The parent pipeline UUID.

stage_id: Option<Option<String>>

The parent stage UUID (if applicable).

stage_name: Option<Option<String>>

The parent stage name (if applicable).

start: DateTime<Utc>

Time when the step run started. The time format must be RFC3339.

status: CIAppPipelineEventStepStatus

The final status of the step.

tags: Option<Option<Vec<String>>>

A list of user-defined tags. The tags must follow the key:value pattern.

url: Option<Option<String>>

The URL to look at the step in the CI provider UI.

additional_properties: BTreeMap<String, Value>

Implementations

impl CIAppPipelineEventStep

pub fn new( end: DateTime<Utc>, id: String, level: CIAppPipelineEventStepLevel, name: String, pipeline_name: String, pipeline_unique_id: String, start: DateTime<Utc>, status: CIAppPipelineEventStepStatus, ) -> CIAppPipelineEventStep

pub fn error(self, value: Option<CIAppCIError>) -> Self

pub fn git(self, value: Option<CIAppGitInfo>) -> Self

pub fn job_id(self, value: Option<String>) -> Self

pub fn job_name(self, value: Option<String>) -> Self

pub fn metrics(self, value: Option<Vec<String>>) -> Self

pub fn node(self, value: Option<CIAppHostInfo>) -> Self

pub fn parameters(self, value: Option<BTreeMap<String, String>>) -> Self

pub fn stage_id(self, value: Option<String>) -> Self

pub fn stage_name(self, value: Option<String>) -> Self

pub fn tags(self, value: Option<Vec<String>>) -> Self

pub fn url(self, value: Option<String>) -> Self

pub fn additional_properties(self, value: BTreeMap<String, Value>) -> Self

Trait Implementations

impl Clone for CIAppPipelineEventStep

fn clone(&self) -> CIAppPipelineEventStep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CIAppPipelineEventStep

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CIAppPipelineEventStep

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CIAppPipelineEventStep

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

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 CIAppPipelineEventStep