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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceWebhook.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbranchFilter()A regular expression used to determine which repository branches are built when a webhook is triggered.static Webhook.Builderbuilder()WebhookBuildTypebuildType()Specifies the type of build this webhook will trigger.StringbuildTypeAsString()Specifies the type of build this webhook will trigger.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<List<WebhookFilter>>filterGroups()An array of arrays ofWebhookFilterobjects used to determine which webhooks are triggered.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFilterGroups()For responses, this returns true if the service returned a value for the FilterGroups property.inthashCode()InstantlastModifiedSecret()A timestamp that indicates the last time a repository's secret token was modified.StringpayloadUrl()The CodeBuild endpoint where webhook events are sent.List<SdkField<?>>sdkFields()Stringsecret()The secret token of the associated repository.static Class<? extends Webhook.Builder>serializableBuilderClass()Webhook.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringurl()The URL to the webhook.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
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
branchFilteris empty, then all branches are built.It is recommended that you use
filterGroupsinstead 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
branchFilteris empty, then all branches are built.It is recommended that you use
filterGroupsinstead 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
public final List<List<WebhookFilter>> filterGroups()
An array of arrays of
WebhookFilterobjects used to determine which webhooks are triggered. At least oneWebhookFilterin the array must specifyEVENTas itstype.For a build to be triggered, at least one filter group in the
filterGroupsarray 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
WebhookFilterobjects used to determine which webhooks are triggered. At least oneWebhookFilterin the array must specifyEVENTas itstype.For a build to be triggered, at least one filter group in the
filterGroupsarray 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.
If the service returns an enum value that is not available in the current SDK version,
buildTypewill 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:
WebhookBuildType
-
buildTypeAsString
public final String 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,
buildTypewill 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:
WebhookBuildType
-
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.
-
toBuilder
public Webhook.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Webhook.Builder,Webhook>
-
builder
public static Webhook.Builder builder()
-
serializableBuilderClass
public static Class<? extends Webhook.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-