Struct taskcluster::Notify

pub struct Notify {
    pub client: Client,
}

Notification Service

The notification service listens for tasks with associated notifications and handles requests to send emails and post pulse messages.

Fields

client: Client

The underlying client used to make API calls for this service.

Implementations

impl Notify

pub fn new<CB: Into<ClientBuilder>>(client_builder: CB) -> Result<Self, Error>

Create a new Notify instance, based on the given client builder

pub async fn ping(&self) -> Result<(), Error>

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>

Generate an unsigned URL for the ping endpoint

pub fn ping_signed_url(&self, ttl: Duration) -> Result<String, Error>

Generate a signed URL for the ping endpoint

pub async fn lbheartbeat(&self) -> Result<(), Error>

Load Balancer Heartbeat

Respond without doing anything. This endpoint is used to check that the service is up.

pub fn lbheartbeat_url(&self) -> Result<String, Error>

Generate an unsigned URL for the lbheartbeat endpoint

pub fn lbheartbeat_signed_url(&self, ttl: Duration) -> Result<String, Error>

Generate a signed URL for the lbheartbeat endpoint

pub async fn version(&self) -> Result<(), Error>

Taskcluster Version

Respond with the JSON version object. https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md

pub fn version_url(&self) -> Result<String, Error>

Generate an unsigned URL for the version endpoint

pub fn version_signed_url(&self, ttl: Duration) -> Result<String, Error>

Generate a signed URL for the version endpoint

pub async fn email(&self, payload: &Value) -> Result<(), Error>

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>

Publish a Pulse Message

Publish a message on pulse with the given routingKey.

pub async fn matrix(&self, payload: &Value) -> Result<(), Error>

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>

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>

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>

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>

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>

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>

Generate a signed URL for the listDenylist endpoint

pub async fn heartbeat(&self) -> Result<(), Error>

Heartbeat

Respond with a service heartbeat.

This endpoint is used to check on backing services this service depends on.

pub fn heartbeat_url(&self) -> Result<String, Error>

Generate an unsigned URL for the heartbeat endpoint

pub fn heartbeat_signed_url(&self, ttl: Duration) -> Result<String, Error>

Generate a signed URL for the heartbeat endpoint