Struct aws_sdk_codebuild::types::Webhook

#[non_exhaustive]
pub struct Webhook {
    pub url: Option<String>,
    pub payload_url: Option<String>,
    pub secret: Option<String>,
    pub branch_filter: Option<String>,
    pub filter_groups: Option<Vec<Vec<WebhookFilter>>>,
    pub build_type: Option<WebhookBuildType>,
    pub manual_creation: Option<bool>,
    pub last_modified_secret: Option<DateTime>,
    pub scope_configuration: Option<ScopeConfiguration>,
}

Information about a webhook that connects repository events to a build project in CodeBuild.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

url: Option<String>

The URL to the webhook.

payload_url: Option<String>

The CodeBuild endpoint where webhook events are sent.

secret: Option<String>

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

branch_filter: 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.

filter_groups: 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.

build_type: Option<WebhookBuildType>

Specifies the type of build this webhook will trigger.

manual_creation: 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.

last_modified_secret: Option<DateTime>

A timestamp that indicates the last time a repository's secret token was modified.

scope_configuration: Option<ScopeConfiguration>

The scope configuration for global or organization webhooks.

Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

Implementations

impl Webhook

pub fn url(&self) -> Option<&str>

The URL to the webhook.

pub fn payload_url(&self) -> Option<&str>

The CodeBuild endpoint where webhook events are sent.

pub fn secret(&self) -> Option<&str>

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

pub fn branch_filter(&self) -> Option<&str>

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.

pub fn filter_groups(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filter_groups.is_none().

pub fn build_type(&self) -> Option<&WebhookBuildType>

Specifies the type of build this webhook will trigger.

pub fn 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.

pub fn last_modified_secret(&self) -> Option<&DateTime>

A timestamp that indicates the last time a repository's secret token was modified.

pub fn 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.

impl Webhook

pub fn builder() -> WebhookBuilder

Creates a new builder-style object to manufacture Webhook.

Trait Implementations

impl Clone for Webhook

fn clone(&self) -> Webhook

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Webhook

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

Formats the value using the given formatter.

impl PartialEq for Webhook

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Webhook