Struct WorkflowPauseResponse 

pub struct WorkflowPauseResponse {
    pub paused_at: Option<DateTime<Utc>>,
    pub paused_by: Option<Uuid>,
    pub workflow_name: String,
}

Response of POST /api/v1/workflows/:name/pause and POST /api/v1/workflows/:name/resume.

Examples

use ironflow_api::entities::WorkflowPauseResponse;

let response = WorkflowPauseResponse::resumed("deploy");
assert!(response.paused_at.is_none());

JSON schema

{
 "description": "Response of `POST /api/v1/workflows/:name/pause` and\n`POST /api/v1/workflows/:name/resume`.\n\n# Examples\n\n```\nuse ironflow_api::entities::WorkflowPauseResponse;\n\nlet response = WorkflowPauseResponse::resumed(\"deploy\");\nassert!(response.paused_at.is_none());\n```",
 "type": "object",
 "required": [
   "workflow_name"
 ],
 "properties": {
   "paused_at": {
     "description": "When the workflow was paused: its queued runs are not picked up until\nit is resumed. Omitted when the workflow is not paused.",
     "type": [
       "string",
       "null"
     ],
     "format": "date-time"
   },
   "paused_by": {
     "description": "User who paused the workflow, when known.",
     "type": [
       "string",
       "null"
     ],
     "format": "uuid"
   },
   "workflow_name": {
     "description": "Workflow name.",
     "type": "string"
   }
 }
}
```ignore
</details>

Fields

paused_at: Option<DateTime<Utc>>

When the workflow was paused: its queued runs are not picked up until it is resumed. Omitted when the workflow is not paused.

paused_by: Option<Uuid>

User who paused the workflow, when known.

workflow_name: String

Workflow name.

Implementations

impl WorkflowPauseResponse

pub fn builder() -> WorkflowPauseResponse

Trait Implementations

impl Clone for WorkflowPauseResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowPauseResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkflowPauseResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<WorkflowPauseResponse> for WorkflowPauseResponse

fn from(value: WorkflowPauseResponse) -> Self

Converts to this type from the input type.

impl Serialize for WorkflowPauseResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<WorkflowPauseResponse> for WorkflowPauseResponse

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: WorkflowPauseResponse) -> Result<Self, ConversionError>

Performs the conversion.