WebhookDefinition (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.codepipeline.model.WebhookDefinition

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<WebhookDefinition.Builder,WebhookDefinition>

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

Represents information about a webhook and its definition.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WebhookDefinition.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WebhookDefinition.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebhookAuthenticationType`	`authentication()` Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
`String`	`authenticationAsString()` Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
`WebhookAuthConfiguration`	`authenticationConfiguration()` Properties that configure the authentication applied to incoming webhook trigger requests.
`static WebhookDefinition.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`List<WebhookFilterRule>`	`filters()` A list of rules applied to the body/payload sent in the POST request to a webhook URL.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`name()` The name of the webhook.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WebhookDefinition.Builder>`	`serializableBuilderClass()`
`String`	`targetAction()` The name of the action in a pipeline you want to connect to the webhook.
`String`	`targetPipeline()` The name of the pipeline you want to connect to the webhook.
`WebhookDefinition.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public String name()
```
    The name of the webhook.
    
    Returns:
    
    The name of the webhook.
  - targetPipeline
```
public String targetPipeline()
```
    The name of the pipeline you want to connect to the webhook.
    
    Returns:
    
    The name of the pipeline you want to connect to the webhook.
  - targetAction
```
public String targetAction()
```
    The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
    
    Returns:
    
    The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
  - filters
```
public List<WebhookFilterRule> filters()
```
    A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
  - authentication
```
public WebhookAuthenticationType authentication()
```
    Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
    - GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/
    - IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.
    - UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.
    If the service returns an enum value that is not available in the current SDK version, authentication will return WebhookAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationAsString().
    Returns:
    Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
    
    GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/
    
    IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.
    
    UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.
    See Also:
    
    WebhookAuthenticationType
  - authenticationAsString
```
public String authenticationAsString()
```
    Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
    - GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/
    - IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.
    - UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.
    If the service returns an enum value that is not available in the current SDK version, authentication will return WebhookAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationAsString().
    Returns:
    Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
    
    GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/
    
    IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.
    
    UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.
    See Also:
    
    WebhookAuthenticationType
  - authenticationConfiguration
```
public WebhookAuthConfiguration authenticationConfiguration()
```
    Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
    
    Returns:
    
    Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
  - toBuilder
```
public WebhookDefinition.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WebhookDefinition.Builder,WebhookDefinition>
    
    Returns:
    
    a builder for type T
  - builder
```
public static WebhookDefinition.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WebhookDefinition.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class WebhookDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

targetPipeline

targetAction

filters

authentication

authenticationAsString

authenticationConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields