#[non_exhaustive]pub struct WebhookFilter {
pub type: WebhookFilterType,
pub pattern: String,
pub exclude_matched_pattern: Option<bool>,
}
Expand description
A filter used to determine which webhooks trigger a build.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.type: WebhookFilterType
The type of webhook filter. There are 11 webhook filter types: EVENT
, ACTOR_ACCOUNT_ID
, HEAD_REF
, BASE_REF
, FILE_PATH
, COMMIT_MESSAGE
, TAG_NAME
, RELEASE_NAME
, REPOSITORY_NAME
, ORGANIZATION_NAME
, and WORKFLOW_NAME
.
-
EVENT
-
A webhook event triggers a build when the provided
pattern
matches one of nine event types:PUSH
,PULL_REQUEST_CREATED
,PULL_REQUEST_UPDATED
,PULL_REQUEST_CLOSED
,PULL_REQUEST_REOPENED
,PULL_REQUEST_MERGED
,RELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
. TheEVENT
patterns are specified as a comma-separated string. For example,PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED
filters all push, pull request created, and pull request updated events.Types
PULL_REQUEST_REOPENED
andWORKFLOW_JOB_QUEUED
work with GitHub and GitHub Enterprise only. TypesRELEASED
andPRERELEASED
work with GitHub only.
-
-
ACTOR_ACCOUNT_ID
-
A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression
pattern
.
-
-
HEAD_REF
-
A webhook event triggers a build when the head reference matches the regular expression
pattern
. For example,refs/heads/branch-name
andrefs/tags/tag-name
.Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
-
-
BASE_REF
-
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.
-
-
FILE_PATH
-
A webhook triggers a build when the path of a changed file matches the regular expression
pattern
.Works with push and pull request events only.
-
-
COMMIT_MESSAGE
-
A webhook triggers a build when the head commit message matches the regular expression
pattern
.Works with push and pull request events only.
-
-
TAG_NAME
-
A webhook triggers a build when the tag name of the release matches the regular expression
pattern
.Works with
RELEASED
andPRERELEASED
events only.
-
-
RELEASE_NAME
-
A webhook triggers a build when the release name matches the regular expression
pattern
.Works with
RELEASED
andPRERELEASED
events only.
-
-
REPOSITORY_NAME
-
A webhook triggers a build when the repository name matches the regular expression
pattern
.Works with GitHub global or organization webhooks only.
-
-
ORGANIZATION_NAME
-
A webhook triggers a build when the organization name matches the regular expression
pattern
.Works with GitHub global webhooks only.
-
-
WORKFLOW_NAME
-
A webhook triggers a build when the workflow name matches the regular expression
pattern
.Works with
WORKFLOW_JOB_QUEUED
events only.For CodeBuild-hosted Buildkite runner builds, WORKFLOW_NAME filters will filter by pipeline name.
-
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
.
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.
Implementations§
Source§impl WebhookFilter
impl WebhookFilter
Sourcepub fn type(&self) -> &WebhookFilterType
pub fn type(&self) -> &WebhookFilterType
The type of webhook filter. There are 11 webhook filter types: EVENT
, ACTOR_ACCOUNT_ID
, HEAD_REF
, BASE_REF
, FILE_PATH
, COMMIT_MESSAGE
, TAG_NAME
, RELEASE_NAME
, REPOSITORY_NAME
, ORGANIZATION_NAME
, and WORKFLOW_NAME
.
-
EVENT
-
A webhook event triggers a build when the provided
pattern
matches one of nine event types:PUSH
,PULL_REQUEST_CREATED
,PULL_REQUEST_UPDATED
,PULL_REQUEST_CLOSED
,PULL_REQUEST_REOPENED
,PULL_REQUEST_MERGED
,RELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
. TheEVENT
patterns are specified as a comma-separated string. For example,PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED
filters all push, pull request created, and pull request updated events.Types
PULL_REQUEST_REOPENED
andWORKFLOW_JOB_QUEUED
work with GitHub and GitHub Enterprise only. TypesRELEASED
andPRERELEASED
work with GitHub only.
-
-
ACTOR_ACCOUNT_ID
-
A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression
pattern
.
-
-
HEAD_REF
-
A webhook event triggers a build when the head reference matches the regular expression
pattern
. For example,refs/heads/branch-name
andrefs/tags/tag-name
.Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
-
-
BASE_REF
-
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.
-
-
FILE_PATH
-
A webhook triggers a build when the path of a changed file matches the regular expression
pattern
.Works with push and pull request events only.
-
-
COMMIT_MESSAGE
-
A webhook triggers a build when the head commit message matches the regular expression
pattern
.Works with push and pull request events only.
-
-
TAG_NAME
-
A webhook triggers a build when the tag name of the release matches the regular expression
pattern
.Works with
RELEASED
andPRERELEASED
events only.
-
-
RELEASE_NAME
-
A webhook triggers a build when the release name matches the regular expression
pattern
.Works with
RELEASED
andPRERELEASED
events only.
-
-
REPOSITORY_NAME
-
A webhook triggers a build when the repository name matches the regular expression
pattern
.Works with GitHub global or organization webhooks only.
-
-
ORGANIZATION_NAME
-
A webhook triggers a build when the organization name matches the regular expression
pattern
.Works with GitHub global webhooks only.
-
-
WORKFLOW_NAME
-
A webhook triggers a build when the workflow name matches the regular expression
pattern
.Works with
WORKFLOW_JOB_QUEUED
events only.For CodeBuild-hosted Buildkite runner builds, WORKFLOW_NAME filters will filter by pipeline name.
-
Sourcepub fn pattern(&self) -> &str
pub fn pattern(&self) -> &str
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
.
Sourcepub fn exclude_matched_pattern(&self) -> Option<bool>
pub fn exclude_matched_pattern(&self) -> 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.
Source§impl WebhookFilter
impl WebhookFilter
Sourcepub fn builder() -> WebhookFilterBuilder
pub fn builder() -> WebhookFilterBuilder
Creates a new builder-style object to manufacture WebhookFilter
.
Trait Implementations§
Source§impl Clone for WebhookFilter
impl Clone for WebhookFilter
Source§fn clone(&self) -> WebhookFilter
fn clone(&self) -> WebhookFilter
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for WebhookFilter
impl Debug for WebhookFilter
Source§impl PartialEq for WebhookFilter
impl PartialEq for WebhookFilter
impl StructuralPartialEq for WebhookFilter
Auto Trait Implementations§
impl Freeze for WebhookFilter
impl RefUnwindSafe for WebhookFilter
impl Send for WebhookFilter
impl Sync for WebhookFilter
impl Unpin for WebhookFilter
impl UnwindSafe for WebhookFilter
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);