Package software.amazon.awssdk.services.codepipeline.model

Class WebhookFilterRule

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.WebhookFilterRule

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class WebhookFilterRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WebhookFilterRule.Builder,WebhookFilterRule>

The event criteria that specify when a webhook notification is sent to your URL.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebhookFilterRule.Builder

Method Summary

Modifier and Type	Method	Description
static WebhookFilterRule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jsonPath()	A JsonPath expression that is applied to the body/payload of the webhook.
String	matchEquals()	The value selected by the JsonPath expression must match what is supplied in the MatchEquals field.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WebhookFilterRule.Builder>	serializableBuilderClass()
WebhookFilterRule.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

jsonPath

public final String jsonPath()

A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.

Returns:

A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.

matchEquals

public final String matchEquals()

The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

Returns:

The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

toBuilder

public WebhookFilterRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WebhookFilterRule.Builder,WebhookFilterRule>

builder

public static WebhookFilterRule.Builder builder()

serializableBuilderClass

public static Class<? extends WebhookFilterRule.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo