Class Webhook

    • Method Detail

      • 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.

      • 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.
      • 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
      • 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)