Package software.amazon.awssdk.services.codebuild.model

Interface CreateWebhookRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodeBuildRequest.Builder, CopyableBuilder<CreateWebhookRequest.Builder,CreateWebhookRequest>, SdkBuilder<CreateWebhookRequest.Builder,CreateWebhookRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateWebhookRequest
public static interface CreateWebhookRequest.Builder extends CodeBuildRequest.Builder, SdkPojo, CopyableBuilder<CreateWebhookRequest.Builder,CreateWebhookRequest>

  • Method Details

    • projectName

      CreateWebhookRequest.Builder projectName(String projectName)

      The name of the CodeBuild project.

      Parameters:
      projectName - The name of the CodeBuild project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • branchFilter

      CreateWebhookRequest.Builder branchFilter(String branchFilter)

      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.

      Parameters:
      branchFilter - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterGroups

      CreateWebhookRequest.Builder filterGroups(Collection<? extends Collection<WebhookFilter>> filterGroups)

      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.

      Parameters:
      filterGroups - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterGroups

      CreateWebhookRequest.Builder filterGroups(Collection<WebhookFilter>... filterGroups)

      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.

      Parameters:
      filterGroups - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • buildType

      CreateWebhookRequest.Builder buildType(String buildType)

      Specifies the type of build this webhook will trigger.

      Parameters:
      buildType - Specifies the type of build this webhook will trigger.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • buildType

      CreateWebhookRequest.Builder buildType(WebhookBuildType buildType)

      Specifies the type of build this webhook will trigger.

      Parameters:
      buildType - Specifies the type of build this webhook will trigger.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • manualCreation

      CreateWebhookRequest.Builder manualCreation(Boolean manualCreation)

      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.

      Parameters:
      manualCreation - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeConfiguration

      CreateWebhookRequest.Builder scopeConfiguration(ScopeConfiguration scopeConfiguration)

      The scope configuration for global or organization webhooks.

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

      Parameters:
      scopeConfiguration - The scope configuration for global or organization webhooks.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeConfiguration

      default CreateWebhookRequest.Builder scopeConfiguration(Consumer<ScopeConfiguration.Builder> scopeConfiguration)

      The scope configuration for global or organization webhooks.

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

      This is a convenience method that creates an instance of the ScopeConfiguration.Builder avoiding the need to create one manually via ScopeConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scopeConfiguration(ScopeConfiguration).

      Parameters:
      scopeConfiguration - a consumer that will call methods on ScopeConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateWebhookRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateWebhookRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.