Struct taskcluster::Hooks

pub struct Hooks {
    pub client: Client,
}

Hooks Service

The hooks service provides a mechanism for creating tasks in response to events.

Fields

client: Client

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

Implementations

impl Hooks

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

Create a new Hooks 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 listHookGroups(&self) -> Result<Value, Error>

List hook groups

This endpoint will return a list of all hook groups with at least one hook.

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

Generate an unsigned URL for the listHookGroups endpoint

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

Generate a signed URL for the listHookGroups endpoint

pub async fn listHooks(&self, hookGroupId: &str) -> Result<Value, Error>

List hooks in a given group

This endpoint will return a list of all the hook definitions within a given hook group.

pub fn listHooks_url(&self, hookGroupId: &str) -> Result<String, Error>

Generate an unsigned URL for the listHooks endpoint

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

Generate a signed URL for the listHooks endpoint

pub async fn hook(
    &self,
    hookGroupId: &str,
    hookId: &str
) -> Result<Value, Error>

Get hook definition

This endpoint will return the hook definition for the given hookGroupId and hookId.

pub fn hook_url(&self, hookGroupId: &str, hookId: &str) -> Result<String, Error>

Generate an unsigned URL for the hook endpoint

pub fn hook_signed_url(
    &self,
    hookGroupId: &str,
    hookId: &str,
    ttl: Duration
) -> Result<String, Error>

Generate a signed URL for the hook endpoint

pub async fn getHookStatus(
    &self,
    hookGroupId: &str,
    hookId: &str
) -> Result<Value, Error>

Get hook status

This endpoint will return the current status of the hook. This represents a snapshot in time and may vary from one call to the next.

This method is deprecated in favor of listLastFires.

pub fn getHookStatus_url(
    &self,
    hookGroupId: &str,
    hookId: &str
) -> Result<String, Error>

Generate an unsigned URL for the getHookStatus endpoint

pub fn getHookStatus_signed_url(
    &self,
    hookGroupId: &str,
    hookId: &str,
    ttl: Duration
) -> Result<String, Error>

Generate a signed URL for the getHookStatus endpoint

pub async fn createHook(
    &self,
    hookGroupId: &str,
    hookId: &str,
    payload: &Value
) -> Result<Value, Error>

Create a hook

This endpoint will create a new hook.

The caller’s credentials must include the role that will be used to create the task. That role must satisfy task.scopes as well as the necessary scopes to add the task to the queue.

pub async fn updateHook(
    &self,
    hookGroupId: &str,
    hookId: &str,
    payload: &Value
) -> Result<Value, Error>

Update a hook

This endpoint will update an existing hook. All fields except hookGroupId and hookId can be modified.

pub async fn removeHook(
    &self,
    hookGroupId: &str,
    hookId: &str
) -> Result<(), Error>

Delete a hook

This endpoint will remove a hook definition.

pub async fn triggerHook(
    &self,
    hookGroupId: &str,
    hookId: &str,
    payload: &Value
) -> Result<Value, Error>

Trigger a hook

This endpoint will trigger the creation of a task from a hook definition.

The HTTP payload must match the hooks triggerSchema. If it does, it is provided as the payload property of the JSON-e context used to render the task template.

pub async fn getTriggerToken(
    &self,
    hookGroupId: &str,
    hookId: &str
) -> Result<Value, Error>

Get a trigger token

Retrieve a unique secret token for triggering the specified hook. This token can be deactivated with resetTriggerToken.

pub fn getTriggerToken_url(
    &self,
    hookGroupId: &str,
    hookId: &str
) -> Result<String, Error>

Generate an unsigned URL for the getTriggerToken endpoint

pub fn getTriggerToken_signed_url(
    &self,
    hookGroupId: &str,
    hookId: &str,
    ttl: Duration
) -> Result<String, Error>

Generate a signed URL for the getTriggerToken endpoint

pub async fn resetTriggerToken(
    &self,
    hookGroupId: &str,
    hookId: &str
) -> Result<Value, Error>

Reset a trigger token

Reset the token for triggering a given hook. This invalidates token that may have been issued via getTriggerToken with a new token.

pub async fn triggerHookWithToken(
    &self,
    hookGroupId: &str,
    hookId: &str,
    token: &str,
    payload: &Value
) -> Result<Value, Error>

Trigger a hook with a token

This endpoint triggers a defined hook with a valid token.

The HTTP payload must match the hooks triggerSchema. If it does, it is provided as the payload property of the JSON-e context used to render the task template.

pub async fn listLastFires(
    &self,
    hookGroupId: &str,
    hookId: &str
) -> Result<Value, Error>

Get information about recent hook fires

This endpoint will return information about the the last few times this hook has been fired, including whether the hook was fired successfully or not

pub fn listLastFires_url(
    &self,
    hookGroupId: &str,
    hookId: &str
) -> Result<String, Error>

Generate an unsigned URL for the listLastFires endpoint

pub fn listLastFires_signed_url(
    &self,
    hookGroupId: &str,
    hookId: &str,
    ttl: Duration
) -> Result<String, Error>

Generate a signed URL for the listLastFires 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