Struct WebhookFilter

pub struct WebhookFilter {
    pub exclude_matched_pattern: Option<bool>,
    pub pattern: String,
    pub type_: String,
}

A filter used to determine which webhooks trigger a build.

Fields

exclude_matched_pattern: Option<bool>

Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build.

pattern: String

For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.

For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name.

type_: String

The type of webhook filter. There are six webhook filter types: EVENT, ACTORACCOUNTID, HEADREF, BASEREF, FILEPATH, and COMMITMESSAGE.

EVENT

A webhook event triggers a build when the provided pattern matches one of five event types: PUSH, PULLREQUESTCREATED, PULLREQUESTUPDATED, PULLREQUESTREOPENED, and PULLREQUESTMERGED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULLREQUESTCREATED, PULLREQUESTUPDATED filters all push, pull request created, and pull request updated events.

The PULLREQUESTREOPENED works with GitHub and GitHub Enterprise only.

ACTORACCOUNTID

A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.

HEADREF

A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.

Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.

BASEREF

A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.

Works with pull request events only.

FILEPATH

A webhook triggers a build when the path of a changed file matches the regular expression pattern.

Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

COMMITMESSAGE

A webhook triggers a build when the head commit message matches the regular expression pattern.

Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

Trait Implementations

impl Clone for WebhookFilter

fn clone(&self) -> WebhookFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebhookFilter

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

Formats the value using the given formatter.

impl Default for WebhookFilter

fn default() -> WebhookFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebhookFilter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebhookFilter

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WebhookFilter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WebhookFilter