Skip to main content

TaskPushNotificationConfig

Struct TaskPushNotificationConfig 

Source
pub struct TaskPushNotificationConfig {
    pub id: String,
    pub task_id: String,
    pub url: String,
    pub token: Option<String>,
    pub authentication: Option<PushNotificationAuthenticationInfo>,
    pub metadata: BTreeMap<String, Value>,
}
Expand description

A registered push-notification configuration for a task.

Wire form:

{
  "id": "config-1",
  "taskId": "task-1",
  "url": "https://example.com/webhook",
  "token": "auth-token",
  "authentication": { "scheme": "Bearer", "credentials": "..." }
}

All fields are required except token and authentication. The spec lets a client register a config with no token (a webhook the agent POSTs to without authentication) and no authentication block (a webhook that uses a header the agent does not need to know about, or an unauthenticated webhook).

Fields§

§id: String

The configuration’s id. Required — the spec uses it to address a config within a task.

§task_id: String

The task’s id. Required — a config is scoped to one task.

§url: String

The webhook the server POSTs to. The URL is the SSRF surface the SSRF denylist filters on the server side. Required.

§token: Option<String>

An optional token the server includes in the X-A2A-Notification-Token header. A receiver without a token is a receiver that does not need to authenticate the delivery.

§authentication: Option<PushNotificationAuthenticationInfo>

Optional authentication info. A webhook that needs a Bearer token (or Basic, or Digest) sets this; a webhook that does not leaves it off the wire.

§metadata: BTreeMap<String, Value>

Per-config metadata.

Implementations§

Source§

impl TaskPushNotificationConfig

Source

pub fn new( id: impl Into<String>, task_id: impl Into<String>, url: impl Into<String>, ) -> Self

Starts a new config with id, task_id, and url. Use with_token and with_authentication to set the optional fields.

Source

pub fn with_token(self, token: impl Into<String>) -> Self

Sets the token.

Source

pub fn with_authentication( self, authentication: PushNotificationAuthenticationInfo, ) -> Self

Sets the authentication info.

Trait Implementations§

Source§

impl Clone for TaskPushNotificationConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TaskPushNotificationConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TaskPushNotificationConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for TaskPushNotificationConfig

Source§

impl From<TaskPushNotificationConfig> for CreateTaskPushNotificationConfigRequest

Source§

fn from(config: TaskPushNotificationConfig) -> Self

Converts to this type from the input type.
Source§

impl From<TaskPushNotificationConfig> for CreateTaskPushNotificationConfigResponse

Source§

fn from(config: TaskPushNotificationConfig) -> Self

Converts to this type from the input type.
Source§

impl From<TaskPushNotificationConfig> for GetTaskPushNotificationConfigResponse

Source§

fn from(config: TaskPushNotificationConfig) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TaskPushNotificationConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for TaskPushNotificationConfig

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TaskPushNotificationConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more