Struct taskcluster::Notify [−][src]
Notification Service
The notification service listens for tasks with associated notifications and handles requests to send emails and post pulse messages.
Implementations
impl Notify
[src]
pub fn new<CB: Into<ClientBuilder>>(client_builder: CB) -> Result<Self, Error>
[src]
Create a new undefined instance, based on the given client.
pub async fn ping(&self) -> Result<(), Error>
[src]
Ping Server
Respond without doing anything. This endpoint is used to check that the service is up.
pub fn ping_url(&self) -> Result<String, Error>
[src]
Generate an unsigned URL for the ping endpoint
pub fn ping_signed_url(&self, ttl: Duration) -> Result<String, Error>
[src]
Generate a signed URL for the ping endpoint
pub async fn email(&self, payload: &Value) -> Result<(), Error>
[src]
Send an Email
Send an email to address
. The content is markdown and will be rendered
to HTML, but both the HTML and raw markdown text will be sent in the
email. If a link is included, it will be rendered to a nice button in the
HTML version of the email
pub async fn pulse(&self, payload: &Value) -> Result<(), Error>
[src]
Publish a Pulse Message
Publish a message on pulse with the given routingKey
.
pub async fn matrix(&self, payload: &Value) -> Result<(), Error>
[src]
Post Matrix Message
Post a message to a room in Matrix. Optionally includes formatted message.
The roomId
in the scopes is a fully formed roomId
with leading !
such
as !foo:bar.com
.
Note that the matrix client used by taskcluster must be invited to a room before it can post there!
pub async fn slack(&self, payload: &Value) -> Result<(), Error>
[src]
Post Slack Message
Post a message to a Slack channel.
The channelId
in the scopes is a Slack channel ID, starting with a capital C.
The Slack app can post into public channels by default but will need to be added to private channels before it can post messages there.
pub async fn addDenylistAddress(&self, payload: &Value) -> Result<(), Error>
[src]
Denylist Given Address
Add the given address to the notification denylist. Addresses in the denylist will be ignored by the notification service.
pub async fn deleteDenylistAddress(&self, payload: &Value) -> Result<(), Error>
[src]
Delete Denylisted Address
Delete the specified address from the notification denylist.
pub async fn listDenylist(
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<Value, Error>
[src]
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<Value, Error>
List Denylisted Notifications
Lists all the denylisted addresses.
By default this end-point will try to return up to 1000 addresses in one
request. But it may return less, even if more tasks are available.
It may also return a continuationToken
even though there are no more
results. However, you can only be sure to have seen all results if you
keep calling list
with the last continuationToken
until you
get a result without a continuationToken
.
If you are not interested in listing all the members at once, you may
use the query-string option limit
to return fewer.
pub fn listDenylist_url(
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<String, Error>
[src]
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<String, Error>
Generate an unsigned URL for the listDenylist endpoint
pub fn listDenylist_signed_url(
&self,
continuationToken: Option<&str>,
limit: Option<&str>,
ttl: Duration
) -> Result<String, Error>
[src]
&self,
continuationToken: Option<&str>,
limit: Option<&str>,
ttl: Duration
) -> Result<String, Error>
Generate a signed URL for the listDenylist endpoint
Auto Trait Implementations
impl !RefUnwindSafe for Notify
impl Send for Notify
impl Sync for Notify
impl Unpin for Notify
impl !UnwindSafe for Notify
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,