Package software.amazon.awssdk.services.codebuild.model

Class CreateWebhookRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codebuild.model.CodeBuildRequest

software.amazon.awssdk.services.codebuild.model.CreateWebhookRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWebhookRequest.Builder,CreateWebhookRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateWebhookRequest
extends CodeBuildRequest
implements ToCopyableBuilder<CreateWebhookRequest.Builder,CreateWebhookRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateWebhookRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	branchFilter()	A regular expression used to determine which repository branches are built when a webhook is triggered.
static CreateWebhookRequest.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()	For responses, this returns true if the service returned a value for the FilterGroups property.
int	hashCode()
String	projectName()	The name of the CodeBuild project.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWebhookRequest.Builder>	serializableBuilderClass()
CreateWebhookRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

projectName

public final String projectName()

The name of the CodeBuild project.

Returns:

The name of the CodeBuild project.

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.

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

toBuilder

public CreateWebhookRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWebhookRequest.Builder,CreateWebhookRequest>

Specified by:

toBuilder in class CodeBuildRequest

builder

public static CreateWebhookRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateWebhookRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo