WebhookDefinition (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.codepipeline.model

Class WebhookDefinition

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WebhookDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Represents information about a webhook and its definition.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WebhookDefinition ()

Constructors
Constructor and Description
`WebhookDefinition ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`WebhookDefinition`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getAuthentication ()` Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
`WebhookAuthConfiguration`	`getAuthenticationConfiguration ()` Properties that configure the authentication applied to incoming webhook trigger requests.
`List<WebhookFilterRule>`	`getFilters ()` A list of rules applied to the body/payload sent in the POST request to a webhook URL.
`String`	`getName ()` The name of the webhook.
`String`	`getTargetAction ()` The name of the action in a pipeline you want to connect to the webhook.
`String`	`getTargetPipeline ()` The name of the pipeline you want to connect to the webhook.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAuthentication (String authentication)` Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
`void`	`setAuthenticationConfiguration (WebhookAuthConfiguration authenticationConfiguration)` Properties that configure the authentication applied to incoming webhook trigger requests.
`void`	`setFilters (Collection<WebhookFilterRule> filters)` A list of rules applied to the body/payload sent in the POST request to a webhook URL.
`void`	`setName (String name)` The name of the webhook.
`void`	`setTargetAction (String targetAction)` The name of the action in a pipeline you want to connect to the webhook.
`void`	`setTargetPipeline (String targetPipeline)` The name of the pipeline you want to connect to the webhook.
`String`	`toString ()` Returns a string representation of this object.
`WebhookDefinition`	`withAuthentication (String authentication)` Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
`WebhookDefinition`	`withAuthentication (WebhookAuthenticationType authentication)` Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
`WebhookDefinition`	`withAuthenticationConfiguration (WebhookAuthConfiguration authenticationConfiguration)` Properties that configure the authentication applied to incoming webhook trigger requests.
`WebhookDefinition`	`withFilters (Collection<WebhookFilterRule> filters)` A list of rules applied to the body/payload sent in the POST request to a webhook URL.
`WebhookDefinition`	`withFilters (WebhookFilterRule... filters)` A list of rules applied to the body/payload sent in the POST request to a webhook URL.
`WebhookDefinition`	`withName (String name)` The name of the webhook.
`WebhookDefinition`	`withTargetAction (String targetAction)` The name of the action in a pipeline you want to connect to the webhook.
`WebhookDefinition`	`withTargetPipeline (String targetPipeline)` The name of the pipeline you want to connect to the webhook.

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

- Constructor Detail
  - WebhookDefinition
```
public WebhookDefinition()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the webhook.
    
    Parameters:
    
    name - The name of the webhook.
  - getName
```
public String getName()
```
    The name of the webhook.
    
    Returns:
    
    The name of the webhook.
  - withName
```
public WebhookDefinition withName(String name)
```
    The name of the webhook.
    
    Parameters:
    
    name - The name of the webhook.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetPipeline
```
public void setTargetPipeline(String targetPipeline)
```
    The name of the pipeline you want to connect to the webhook.
    
    Parameters:
    
    targetPipeline - The name of the pipeline you want to connect to the webhook.
  - getTargetPipeline
```
public String getTargetPipeline()
```
    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.
  - withTargetPipeline
```
public WebhookDefinition withTargetPipeline(String targetPipeline)
```
    The name of the pipeline you want to connect to the webhook.
    
    Parameters:
    
    targetPipeline - The name of the pipeline you want to connect to the webhook.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetAction
```
public void setTargetAction(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.
    
    Parameters:
    
    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.
  - getTargetAction
```
public String getTargetAction()
```
    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.
  - withTargetAction
```
public WebhookDefinition withTargetAction(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilters
```
public List<WebhookFilterRule> getFilters()
```
    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.
    
    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.
  - setFilters
```
public void setFilters(Collection<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.
    
    Parameters:
    
    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.
  - withFilters
```
public WebhookDefinition withFilters(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilters
```
public WebhookDefinition withFilters(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthentication
```
public void setAuthentication(String authentication)
```
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    - For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
    - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
    - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
    Parameters:
    authentication - Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    
    For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
    
    IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
    
    UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
    See Also:
    
    WebhookAuthenticationType
  - getAuthentication
```
public String getAuthentication()
```
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    - For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
    - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
    - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
    Returns:
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    
    For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
    
    IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
    
    UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
    See Also:
    
    WebhookAuthenticationType
  - withAuthentication
```
public WebhookDefinition withAuthentication(String authentication)
```
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    - For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
    - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
    - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
    Parameters:
    authentication - Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    
    For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
    
    IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
    
    UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebhookAuthenticationType
  - withAuthentication
```
public WebhookDefinition withAuthentication(WebhookAuthenticationType authentication)
```
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    - For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
    - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
    - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
    Parameters:
    authentication - Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    
    For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
    
    IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
    
    UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebhookAuthenticationType
  - setAuthenticationConfiguration
```
public void setAuthenticationConfiguration(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.
    
    Parameters:
    
    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.
  - getAuthenticationConfiguration
```
public WebhookAuthConfiguration getAuthenticationConfiguration()
```
    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.
  - withAuthenticationConfiguration
```
public WebhookDefinition withAuthenticationConfiguration(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.
    
    Parameters:
    
    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:
    
    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 WebhookDefinition 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class WebhookDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebhookDefinition

Method Detail

setName

getName

withName

setTargetPipeline

getTargetPipeline

withTargetPipeline

setTargetAction

getTargetAction

withTargetAction

getFilters

setFilters

withFilters

withFilters

setAuthentication

getAuthentication

withAuthentication

withAuthentication

setAuthenticationConfiguration

getAuthenticationConfiguration

withAuthenticationConfiguration

toString

equals

hashCode

clone

marshall