Struct aws_sdk_codebuild::operation::create_webhook::builders::CreateWebhookFluentBuilder

pub struct CreateWebhookFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateWebhook.

For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.

If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.

Implementations

impl CreateWebhookFluentBuilder

pub fn as_input(&self) -> &CreateWebhookInputBuilder

Access the CreateWebhook as a reference.

pub async fn send( self, ) -> Result<CreateWebhookOutput, SdkError<CreateWebhookError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<CreateWebhookOutput, CreateWebhookError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn project_name(self, input: impl Into<String>) -> Self

The name of the CodeBuild project.

pub fn set_project_name(self, input: Option<String>) -> Self

The name of the CodeBuild project.

pub fn get_project_name(&self) -> &Option<String>

The name of the CodeBuild project.

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.

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.

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.

pub fn filter_groups(self, input: Vec<WebhookFilter>) -> Self

Appends an item to filterGroups.

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.

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.

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.

pub fn build_type(self, input: WebhookBuildType) -> Self

Specifies the type of build this webhook will trigger.

pub fn set_build_type(self, input: Option<WebhookBuildType>) -> Self

Specifies the type of build this webhook will trigger.

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

Specifies the type of build this webhook will trigger.

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.

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.

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.

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.

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.

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.

Trait Implementations

impl Clone for CreateWebhookFluentBuilder

fn clone(&self) -> CreateWebhookFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateWebhookFluentBuilder

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

Formats the value using the given formatter.