software.amazon.awssdk.services.codebuild.model

Class Webhook

java.lang.Object

software.amazon.awssdk.services.codebuild.model.Webhook

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Webhook.Builder,Webhook>

@Generated(value="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 AWS CodeBuild.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Webhook.Builder

Method Summary

Modifier and Type	Method and Description
String	branchFilter() A regular expression used to determine which repository branches are built when a webhook is triggered.
static Webhook.Builder	builder()
WebhookBuildType	buildType() Specifies the type of build this webhook will trigger.
String	buildTypeAsString() Specifies the type of build this webhook will trigger.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<List<WebhookFilter>>	filterGroups() An array of arrays of WebhookFilter objects used to determine which webhooks are triggered.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilterGroups() Returns true if the FilterGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Instant	lastModifiedSecret() A timestamp that indicates the last time a repository's secret token was modified.
String	payloadUrl() The AWS CodeBuild endpoint where webhook events are sent.
List<SdkField<?>>	sdkFields()
String	secret() The secret token of the associated repository.
static Class<? extends Webhook.Builder>	serializableBuilderClass()
Webhook.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() 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 AWS CodeBuild endpoint where webhook events are sent.

Returns:

The AWS 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()

Returns true if the FilterGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasFilterGroups() to see if a value was sent in this field.

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.

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.

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

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:

toBuilder in interface ToCopyableBuilder<Webhook.Builder,Webhook>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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