Class Webhook

java.lang.Object
software.amazon.awssdk.services.codebuild.model.Webhook
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Webhook.Builder,Webhook>
@Generated("software.amazon.awssdk:codegen") public final class Webhook extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Webhook.Builder,Webhook>

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

See Also:

  • Method Details

    • url

      public final String url()

      The URL to the webhook.

      Returns:
      The URL to the webhook.

    • payloadUrl

      public final String payloadUrl()

      The CodeBuild endpoint where webhook events are sent.

      Returns:
      The CodeBuild endpoint where webhook events are sent.

    • secret

      public final String secret()

      The secret token of the associated repository.

      A Bitbucket webhook does not support secret.

      Returns:
      The secret token of the associated repository.

      A Bitbucket webhook does not support secret.

    • branchFilter

      public final 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.

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

    • hasFilterGroups

      public final boolean hasFilterGroups()
      For responses, this returns true if the service returned a value for the FilterGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • filterGroups

      public final List<List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilterGroups() method.

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

    • buildType

      public final WebhookBuildType buildType()

      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.

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

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

      See Also:

    • buildTypeAsString

      public final String buildTypeAsString()

      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.

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

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

      See Also:

    • manualCreation

      public final 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.

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

    • lastModifiedSecret

      public final Instant lastModifiedSecret()

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

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

    • scopeConfiguration

      public final ScopeConfiguration scopeConfiguration()

      The scope configuration for global or organization webhooks.

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

      Returns:
      The scope configuration for global or organization webhooks.

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

    • status

      public final WebhookStatus status()

      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.

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

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

      See Also:

    • statusAsString

      public final String statusAsString()

      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.

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

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

      See Also:

    • statusMessage

      public final String statusMessage()

      A message associated with the status of a webhook.

      Returns:
      A message associated with the status of a webhook.

    • toBuilder

      public Webhook.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<Webhook.Builder,Webhook>
      Returns:
      a builder for type T

    • builder

      public static Webhook.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Webhook.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.