Class Webhook
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Webhook.Builder,
Webhook>
Information about a webhook that connects repository events to a build project in CodeBuild.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
A regular expression used to determine which repository branches are built when a webhook is triggered.static Webhook.Builder
builder()
final WebhookBuildType
Specifies the type of build this webhook will trigger.final String
Specifies the type of build this webhook will trigger.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<List<WebhookFilter>> An array of arrays ofWebhookFilter
objects used to determine which webhooks are triggered.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FilterGroups property.final int
hashCode()
final Instant
A timestamp that indicates the last time a repository's secret token was modified.final String
The CodeBuild endpoint where webhook events are sent.final String
secret()
The secret token of the associated repository.static Class
<? extends Webhook.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 String
url()
The URL to the webhook.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
url
The URL to the webhook.
- Returns:
- The URL to the webhook.
-
payloadUrl
The CodeBuild endpoint where webhook events are sent.
- Returns:
- The CodeBuild endpoint where webhook events are sent.
-
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
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 ofbranchFilter
.- 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 ofbranchFilter
.
-
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 theisEmpty()
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
An array of arrays of
WebhookFilter
objects used to determine which webhooks are triggered. At least oneWebhookFilter
in the array must specifyEVENT
as itstype
.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 oneWebhookFilter
in the array must specifyEVENT
as itstype
.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
Specifies the type of build this webhook will trigger.
If the service returns an enum value that is not available in the current SDK version,
buildType
will returnWebhookBuildType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombuildTypeAsString()
.- Returns:
- Specifies the type of build this webhook will trigger.
- See Also:
-
buildTypeAsString
Specifies the type of build this webhook will trigger.
If the service returns an enum value that is not available in the current SDK version,
buildType
will returnWebhookBuildType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombuildTypeAsString()
.- Returns:
- Specifies the type of build this webhook will trigger.
- See Also:
-
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.
-
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<Webhook.Builder,
Webhook> - 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
-