java.lang.Object
software.amazon.awssdk.services.codebuild.model.WebhookFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WebhookFilter.Builder,WebhookFilter>

@Generated("software.amazon.awssdk:codegen") public final class WebhookFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WebhookFilter.Builder,WebhookFilter>

A filter used to determine which webhooks trigger a build.

See Also:
  • Method Details

    • type

      public final WebhookFilterType type()

      The type of webhook filter. There are eight webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, COMMIT_MESSAGE, TAG_NAME, and RELEASE_NAME.

      • EVENT

        • A webhook event triggers a build when the provided pattern matches one of eight event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED, RELEASED, and PRERELEASED. The EVENT 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.

          The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only. The RELEASED and PRERELEASED 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 and refs/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 GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

      • COMMIT_MESSAGE

        • A webhook triggers a build when the head commit message matches the regular expression pattern.

          Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

      • TAG_NAME

        • A webhook triggers a build when the tag name of the release matches the regular expression pattern.

          Works with RELEASED and PRERELEASED events only.

      • RELEASE_NAME

        • A webhook triggers a build when the release name matches the regular expression pattern.

          Works with RELEASED and PRERELEASED events only.

      If the service returns an enum value that is not available in the current SDK version, type will return WebhookFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of webhook filter. There are eight webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, COMMIT_MESSAGE, TAG_NAME, and RELEASE_NAME.

      • EVENT

        • A webhook event triggers a build when the provided pattern matches one of eight event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED, RELEASED, and PRERELEASED. The EVENT 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.

          The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only. The RELEASED and PRERELEASED 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 and refs/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 GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

      • COMMIT_MESSAGE

        • A webhook triggers a build when the head commit message matches the regular expression pattern.

          Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

      • TAG_NAME

        • A webhook triggers a build when the tag name of the release matches the regular expression pattern.

          Works with RELEASED and PRERELEASED events only.

      • RELEASE_NAME

        • A webhook triggers a build when the release name matches the regular expression pattern.

          Works with RELEASED and PRERELEASED events only.

      See Also:
    • typeAsString

      public final String typeAsString()

      The type of webhook filter. There are eight webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, COMMIT_MESSAGE, TAG_NAME, and RELEASE_NAME.

      • EVENT

        • A webhook event triggers a build when the provided pattern matches one of eight event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED, RELEASED, and PRERELEASED. The EVENT 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.

          The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only. The RELEASED and PRERELEASED 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 and refs/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 GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

      • COMMIT_MESSAGE

        • A webhook triggers a build when the head commit message matches the regular expression pattern.

          Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

      • TAG_NAME

        • A webhook triggers a build when the tag name of the release matches the regular expression pattern.

          Works with RELEASED and PRERELEASED events only.

      • RELEASE_NAME

        • A webhook triggers a build when the release name matches the regular expression pattern.

          Works with RELEASED and PRERELEASED events only.

      If the service returns an enum value that is not available in the current SDK version, type will return WebhookFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of webhook filter. There are eight webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, COMMIT_MESSAGE, TAG_NAME, and RELEASE_NAME.

      • EVENT

        • A webhook event triggers a build when the provided pattern matches one of eight event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED, RELEASED, and PRERELEASED. The EVENT 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.

          The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only. The RELEASED and PRERELEASED 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 and refs/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 GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

      • COMMIT_MESSAGE

        • A webhook triggers a build when the head commit message matches the regular expression pattern.

          Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

      • TAG_NAME

        • A webhook triggers a build when the tag name of the release matches the regular expression pattern.

          Works with RELEASED and PRERELEASED events only.

      • RELEASE_NAME

        • A webhook triggers a build when the release name matches the regular expression pattern.

          Works with RELEASED and PRERELEASED events only.

      See Also:
    • pattern

      public final String pattern()

      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.

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

    • excludeMatchedPattern

      public final Boolean excludeMatchedPattern()

      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.

      Returns:
      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.
    • toBuilder

      public WebhookFilter.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WebhookFilter.Builder,WebhookFilter>
      Returns:
      a builder for type T
    • builder

      public static WebhookFilter.Builder builder()
    • serializableBuilderClass

      public static Class<? extends WebhookFilter.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.