#[non_exhaustive]pub struct WebhookBuilder { /* private fields */ }
Expand description
A builder for Webhook
.
Implementations§
Source§impl WebhookBuilder
impl WebhookBuilder
Sourcepub fn payload_url(self, input: impl Into<String>) -> Self
pub fn payload_url(self, input: impl Into<String>) -> Self
The CodeBuild endpoint where webhook events are sent.
Sourcepub fn set_payload_url(self, input: Option<String>) -> Self
pub fn set_payload_url(self, input: Option<String>) -> Self
The CodeBuild endpoint where webhook events are sent.
Sourcepub fn get_payload_url(&self) -> &Option<String>
pub fn get_payload_url(&self) -> &Option<String>
The CodeBuild endpoint where webhook events are sent.
Sourcepub fn secret(self, input: impl Into<String>) -> Self
pub fn secret(self, input: impl Into<String>) -> Self
The secret token of the associated repository.
A Bitbucket webhook does not support secret
.
Sourcepub fn set_secret(self, input: Option<String>) -> Self
pub fn set_secret(self, input: Option<String>) -> Self
The secret token of the associated repository.
A Bitbucket webhook does not support secret
.
Sourcepub fn get_secret(&self) -> &Option<String>
pub fn get_secret(&self) -> &Option<String>
The secret token of the associated repository.
A Bitbucket webhook does not support secret
.
Sourcepub fn branch_filter(self, input: impl Into<String>) -> Self
pub fn branch_filter(self, input: impl Into<String>) -> Self
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter
is empty, then all branches are built.
It is recommended that you use filterGroups
instead of branchFilter
.
Sourcepub fn set_branch_filter(self, input: Option<String>) -> Self
pub fn set_branch_filter(self, input: Option<String>) -> Self
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter
is empty, then all branches are built.
It is recommended that you use filterGroups
instead of branchFilter
.
Sourcepub fn get_branch_filter(&self) -> &Option<String>
pub fn get_branch_filter(&self) -> &Option<String>
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter
is empty, then all branches are built.
It is recommended that you use filterGroups
instead of branchFilter
.
Sourcepub fn filter_groups(self, input: Vec<WebhookFilter>) -> Self
pub fn filter_groups(self, input: Vec<WebhookFilter>) -> Self
Appends an item to filter_groups
.
To override the contents of this collection use set_filter_groups
.
An array of arrays of WebhookFilter
objects used to determine which webhooks are triggered. At least one WebhookFilter
in the array must specify EVENT
as its type
.
For a build to be triggered, at least one filter group in the filterGroups
array must pass. For a filter group to pass, each of its filters must pass.
Sourcepub fn set_filter_groups(self, input: Option<Vec<Vec<WebhookFilter>>>) -> Self
pub fn set_filter_groups(self, input: Option<Vec<Vec<WebhookFilter>>>) -> Self
An array of arrays of WebhookFilter
objects used to determine which webhooks are triggered. At least one WebhookFilter
in the array must specify EVENT
as its type
.
For a build to be triggered, at least one filter group in the filterGroups
array must pass. For a filter group to pass, each of its filters must pass.
Sourcepub fn get_filter_groups(&self) -> &Option<Vec<Vec<WebhookFilter>>>
pub fn get_filter_groups(&self) -> &Option<Vec<Vec<WebhookFilter>>>
An array of arrays of WebhookFilter
objects used to determine which webhooks are triggered. At least one WebhookFilter
in the array must specify EVENT
as its type
.
For a build to be triggered, at least one filter group in the filterGroups
array must pass. For a filter group to pass, each of its filters must pass.
Sourcepub fn build_type(self, input: WebhookBuildType) -> Self
pub fn build_type(self, input: WebhookBuildType) -> Self
Specifies the type of build this webhook will trigger.
RUNNER_BUILDKITE_BUILD
is only available for NO_SOURCE
source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.
Sourcepub fn set_build_type(self, input: Option<WebhookBuildType>) -> Self
pub fn set_build_type(self, input: Option<WebhookBuildType>) -> Self
Specifies the type of build this webhook will trigger.
RUNNER_BUILDKITE_BUILD
is only available for NO_SOURCE
source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.
Sourcepub fn get_build_type(&self) -> &Option<WebhookBuildType>
pub fn get_build_type(&self) -> &Option<WebhookBuildType>
Specifies the type of build this webhook will trigger.
RUNNER_BUILDKITE_BUILD
is only available for NO_SOURCE
source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.
Sourcepub fn manual_creation(self, input: bool) -> Self
pub fn manual_creation(self, input: bool) -> Self
If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl
and secret
values for the webhook. The payloadUrl
and secret
values in the output can be used to manually create a webhook within GitHub.
manualCreation is only available for GitHub webhooks.
Sourcepub fn set_manual_creation(self, input: Option<bool>) -> Self
pub fn set_manual_creation(self, input: Option<bool>) -> Self
If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl
and secret
values for the webhook. The payloadUrl
and secret
values in the output can be used to manually create a webhook within GitHub.
manualCreation is only available for GitHub webhooks.
Sourcepub fn get_manual_creation(&self) -> &Option<bool>
pub fn get_manual_creation(&self) -> &Option<bool>
If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl
and secret
values for the webhook. The payloadUrl
and secret
values in the output can be used to manually create a webhook within GitHub.
manualCreation is only available for GitHub webhooks.
Sourcepub fn last_modified_secret(self, input: DateTime) -> Self
pub fn last_modified_secret(self, input: DateTime) -> Self
A timestamp that indicates the last time a repository's secret token was modified.
Sourcepub fn set_last_modified_secret(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_secret(self, input: Option<DateTime>) -> Self
A timestamp that indicates the last time a repository's secret token was modified.
Sourcepub fn get_last_modified_secret(&self) -> &Option<DateTime>
pub fn get_last_modified_secret(&self) -> &Option<DateTime>
A timestamp that indicates the last time a repository's secret token was modified.
Sourcepub fn scope_configuration(self, input: ScopeConfiguration) -> Self
pub fn scope_configuration(self, input: ScopeConfiguration) -> Self
The scope configuration for global or organization webhooks.
Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.
Sourcepub fn set_scope_configuration(self, input: Option<ScopeConfiguration>) -> Self
pub fn set_scope_configuration(self, input: Option<ScopeConfiguration>) -> Self
The scope configuration for global or organization webhooks.
Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.
Sourcepub fn get_scope_configuration(&self) -> &Option<ScopeConfiguration>
pub fn get_scope_configuration(&self) -> &Option<ScopeConfiguration>
The scope configuration for global or organization webhooks.
Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.
Sourcepub fn status(self, input: WebhookStatus) -> Self
pub fn status(self, input: WebhookStatus) -> Self
The status of the webhook. Valid values include:
-
CREATING
: The webhook is being created. -
CREATE_FAILED
: The webhook has failed to create. -
ACTIVE
: The webhook has succeeded and is active. -
DELETING
: The webhook is being deleted.
Sourcepub fn set_status(self, input: Option<WebhookStatus>) -> Self
pub fn set_status(self, input: Option<WebhookStatus>) -> Self
The status of the webhook. Valid values include:
-
CREATING
: The webhook is being created. -
CREATE_FAILED
: The webhook has failed to create. -
ACTIVE
: The webhook has succeeded and is active. -
DELETING
: The webhook is being deleted.
Sourcepub fn get_status(&self) -> &Option<WebhookStatus>
pub fn get_status(&self) -> &Option<WebhookStatus>
The status of the webhook. Valid values include:
-
CREATING
: The webhook is being created. -
CREATE_FAILED
: The webhook has failed to create. -
ACTIVE
: The webhook has succeeded and is active. -
DELETING
: The webhook is being deleted.
Sourcepub fn status_message(self, input: impl Into<String>) -> Self
pub fn status_message(self, input: impl Into<String>) -> Self
A message associated with the status of a webhook.
Sourcepub fn set_status_message(self, input: Option<String>) -> Self
pub fn set_status_message(self, input: Option<String>) -> Self
A message associated with the status of a webhook.
Sourcepub fn get_status_message(&self) -> &Option<String>
pub fn get_status_message(&self) -> &Option<String>
A message associated with the status of a webhook.
Trait Implementations§
Source§impl Clone for WebhookBuilder
impl Clone for WebhookBuilder
Source§fn clone(&self) -> WebhookBuilder
fn clone(&self) -> WebhookBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for WebhookBuilder
impl Debug for WebhookBuilder
Source§impl Default for WebhookBuilder
impl Default for WebhookBuilder
Source§fn default() -> WebhookBuilder
fn default() -> WebhookBuilder
Source§impl PartialEq for WebhookBuilder
impl PartialEq for WebhookBuilder
impl StructuralPartialEq for WebhookBuilder
Auto Trait Implementations§
impl Freeze for WebhookBuilder
impl RefUnwindSafe for WebhookBuilder
impl Send for WebhookBuilder
impl Sync for WebhookBuilder
impl Unpin for WebhookBuilder
impl UnwindSafe for WebhookBuilder
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);