Struct SendSignalRequest 

pub struct SendSignalRequest {
    pub idempotency_id: Option<String>,
    pub key: String,
    pub name: String,
    pub payload: Map<String, Value>,
}

Send signal request body.

JSON schema

{
 "description": "Send signal request body.",
 "type": "object",
 "required": [
   "key",
   "name",
   "payload"
 ],
 "properties": {
   "idempotency_id": {
     "description": "Deduplication ID (1-255 characters): a second signal with the same ID\nis neither stored nor delivered.",
     "type": [
       "string",
       "null"
     ]
   },
   "key": {
     "description": "Occurrence key, e.g. a commit SHA (1-255 characters).",
     "type": "string"
   },
   "name": {
     "description": "Signal name, e.g. `\"ci.pipeline_finished\"` (1-255 characters).",
     "type": "string"
   },
   "payload": {
     "description": "JSON payload, validated against the schema of each waiting step.",
     "type": "object"
   }
 }
}
```ignore
</details>

Fields

idempotency_id: Option<String>

Deduplication ID (1-255 characters): a second signal with the same ID is neither stored nor delivered.

key: String

Occurrence key, e.g. a commit SHA (1-255 characters).

name: String

Signal name, e.g. "ci.pipeline_finished" (1-255 characters).

payload: Map<String, Value>

JSON payload, validated against the schema of each waiting step.

Implementations

impl SendSignalRequest

pub fn builder() -> SendSignalRequest

Trait Implementations

impl Clone for SendSignalRequest

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 SendSignalRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SendSignalRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SendSignalRequest> for SendSignalRequest

fn from(value: SendSignalRequest) -> Self

Converts to this type from the input type.

impl Serialize for SendSignalRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SendSignalRequest> for SendSignalRequest

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.