Class WebhookFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WebhookFilter.Builder,
WebhookFilter>
A filter used to determine which webhooks trigger a build.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic WebhookFilter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Used to indicate that thepattern
determines which webhook events do not trigger a build.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
pattern()
For aWebHookFilter
that usesEVENT
type, a comma-separated string that specifies one or more events.static Class
<? extends WebhookFilter.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final WebhookFilterType
type()
The type of webhook filter.final String
The type of webhook filter.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The type of webhook filter. There are nine webhook filter types:
EVENT
,ACTOR_ACCOUNT_ID
,HEAD_REF
,BASE_REF
,FILE_PATH
,COMMIT_MESSAGE
,TAG_NAME
,RELEASE_NAME
, andWORKFLOW_NAME
.-
EVENT
-
A webhook event triggers a build when the provided
pattern
matches one of nine event types:PUSH
,PULL_REQUEST_CREATED
,PULL_REQUEST_UPDATED
,PULL_REQUEST_CLOSED
,PULL_REQUEST_REOPENED
,PULL_REQUEST_MERGED
,RELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
. TheEVENT
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. TheRELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
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
andrefs/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
andPRERELEASED
events only.
-
-
RELEASE_NAME
-
A webhook triggers a build when the release name matches the regular expression
pattern
.Works with
RELEASED
andPRERELEASED
events only.
-
-
WORKFLOW_NAME
-
A webhook triggers a build when the workflow name matches the regular expression
pattern
.Works with
WORKFLOW_JOB_QUEUED
events only.
-
If the service returns an enum value that is not available in the current SDK version,
type
will returnWebhookFilterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of webhook filter. There are nine webhook filter types:
EVENT
,ACTOR_ACCOUNT_ID
,HEAD_REF
,BASE_REF
,FILE_PATH
,COMMIT_MESSAGE
,TAG_NAME
,RELEASE_NAME
, andWORKFLOW_NAME
.-
EVENT
-
A webhook event triggers a build when the provided
pattern
matches one of nine event types:PUSH
,PULL_REQUEST_CREATED
,PULL_REQUEST_UPDATED
,PULL_REQUEST_CLOSED
,PULL_REQUEST_REOPENED
,PULL_REQUEST_MERGED
,RELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
. TheEVENT
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. TheRELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
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
andrefs/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
andPRERELEASED
events only.
-
-
RELEASE_NAME
-
A webhook triggers a build when the release name matches the regular expression
pattern
.Works with
RELEASED
andPRERELEASED
events only.
-
-
WORKFLOW_NAME
-
A webhook triggers a build when the workflow name matches the regular expression
pattern
.Works with
WORKFLOW_JOB_QUEUED
events only.
-
-
- See Also:
-
-
typeAsString
The type of webhook filter. There are nine webhook filter types:
EVENT
,ACTOR_ACCOUNT_ID
,HEAD_REF
,BASE_REF
,FILE_PATH
,COMMIT_MESSAGE
,TAG_NAME
,RELEASE_NAME
, andWORKFLOW_NAME
.-
EVENT
-
A webhook event triggers a build when the provided
pattern
matches one of nine event types:PUSH
,PULL_REQUEST_CREATED
,PULL_REQUEST_UPDATED
,PULL_REQUEST_CLOSED
,PULL_REQUEST_REOPENED
,PULL_REQUEST_MERGED
,RELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
. TheEVENT
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. TheRELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
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
andrefs/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
andPRERELEASED
events only.
-
-
RELEASE_NAME
-
A webhook triggers a build when the release name matches the regular expression
pattern
.Works with
RELEASED
andPRERELEASED
events only.
-
-
WORKFLOW_NAME
-
A webhook triggers a build when the workflow name matches the regular expression
pattern
.Works with
WORKFLOW_JOB_QUEUED
events only.
-
If the service returns an enum value that is not available in the current SDK version,
type
will returnWebhookFilterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of webhook filter. There are nine webhook filter types:
EVENT
,ACTOR_ACCOUNT_ID
,HEAD_REF
,BASE_REF
,FILE_PATH
,COMMIT_MESSAGE
,TAG_NAME
,RELEASE_NAME
, andWORKFLOW_NAME
.-
EVENT
-
A webhook event triggers a build when the provided
pattern
matches one of nine event types:PUSH
,PULL_REQUEST_CREATED
,PULL_REQUEST_UPDATED
,PULL_REQUEST_CLOSED
,PULL_REQUEST_REOPENED
,PULL_REQUEST_MERGED
,RELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
. TheEVENT
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. TheRELEASED
,PRERELEASED
, andWORKFLOW_JOB_QUEUED
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
andrefs/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
andPRERELEASED
events only.
-
-
RELEASE_NAME
-
A webhook triggers a build when the release name matches the regular expression
pattern
.Works with
RELEASED
andPRERELEASED
events only.
-
-
WORKFLOW_NAME
-
A webhook triggers a build when the workflow name matches the regular expression
pattern
.Works with
WORKFLOW_JOB_QUEUED
events only.
-
-
- See Also:
-
-
pattern
For a
WebHookFilter
that usesEVENT
type, a comma-separated string that specifies one or more events. For example, the webhook filterPUSH, 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, aWebHookFilter
that usesHEAD_REF
for itstype
and the pattern^refs/heads/
triggers a build when the head reference is a branch with a reference namerefs/heads/branch-name
.- Returns:
- For a
WebHookFilter
that usesEVENT
type, a comma-separated string that specifies one or more events. For example, the webhook filterPUSH, 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, aWebHookFilter
that usesHEAD_REF
for itstype
and the pattern^refs/heads/
triggers a build when the head reference is a branch with a reference namerefs/heads/branch-name
.
-
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 thepattern
triggers a build. If false, then a webhook event that matches thepattern
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 thepattern
triggers a build. If false, then a webhook event that matches thepattern
triggers a build.
-
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 interfaceToCopyableBuilder<WebhookFilter.Builder,
WebhookFilter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-