WebhookFilterRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codepipeline.model.WebhookFilterRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WebhookFilterRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The event criteria that specify when a webhook notification is sent to your URL.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WebhookFilterRule()

Constructors
Constructor and Description
`WebhookFilterRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebhookFilterRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getJsonPath()` A JsonPath expression that will be applied to the body/payload of the webhook.
`String`	`getMatchEquals()` The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setJsonPath(String jsonPath)` A JsonPath expression that will be applied to the body/payload of the webhook.
`void`	`setMatchEquals(String matchEquals)` The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored.
`String`	`toString()` Returns a string representation of this object.
`WebhookFilterRule`	`withJsonPath(String jsonPath)` A JsonPath expression that will be applied to the body/payload of the webhook.
`WebhookFilterRule`	`withMatchEquals(String matchEquals)` The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WebhookFilterRule
```
public WebhookFilterRule()
```
- Method Detail
  - setJsonPath
```
public void setJsonPath(String jsonPath)
```
    A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.
    
    Parameters:
    
    jsonPath - A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.
  - getJsonPath
```
public String getJsonPath()
```
    A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.
    
    Returns:
    
    A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.
  - withJsonPath
```
public WebhookFilterRule withJsonPath(String jsonPath)
```
    A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.
    
    Parameters:
    
    jsonPath - A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMatchEquals
```
public void setMatchEquals(String matchEquals)
```
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. 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 "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements.
    
    Parameters:
    
    matchEquals - The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. 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 "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements.
  - getMatchEquals
```
public String getMatchEquals()
```
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. 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 "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: 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 will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. 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 "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements.
  - withMatchEquals
```
public WebhookFilterRule withMatchEquals(String matchEquals)
```
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. 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 "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements.
    
    Parameters:
    
    matchEquals - The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. 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 "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WebhookFilterRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class WebhookFilterRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebhookFilterRule

Method Detail

setJsonPath

getJsonPath

withJsonPath

setMatchEquals

getMatchEquals

withMatchEquals

toString

equals

hashCode

clone

marshall