Webhook (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codebuild.model.Webhook

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Webhook
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about a webhook that connects repository events to a build project in AWS CodeBuild.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Webhook()

Constructors
Constructor and Description
`Webhook()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Webhook`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBranchFilter()` A regular expression used to determine which repository branches are built when a webhook is triggered.
`String`	`getBuildType()` Specifies the type of build this webhook will trigger.
`List<List<WebhookFilter>>`	`getFilterGroups()` An array of arrays of `WebhookFilter` objects used to determine which webhooks are triggered.
`Date`	`getLastModifiedSecret()` A timestamp that indicates the last time a repository's secret token was modified.
`String`	`getPayloadUrl()` The AWS CodeBuild endpoint where webhook events are sent.
`String`	`getSecret()` The secret token of the associated repository.
`String`	`getUrl()` The URL to the webhook.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBranchFilter(String branchFilter)` A regular expression used to determine which repository branches are built when a webhook is triggered.
`void`	`setBuildType(String buildType)` Specifies the type of build this webhook will trigger.
`void`	`setFilterGroups(Collection<List<WebhookFilter>> filterGroups)` An array of arrays of `WebhookFilter` objects used to determine which webhooks are triggered.
`void`	`setLastModifiedSecret(Date lastModifiedSecret)` A timestamp that indicates the last time a repository's secret token was modified.
`void`	`setPayloadUrl(String payloadUrl)` The AWS CodeBuild endpoint where webhook events are sent.
`void`	`setSecret(String secret)` The secret token of the associated repository.
`void`	`setUrl(String url)` The URL to the webhook.
`String`	`toString()` Returns a string representation of this object.
`Webhook`	`withBranchFilter(String branchFilter)` A regular expression used to determine which repository branches are built when a webhook is triggered.
`Webhook`	`withBuildType(String buildType)` Specifies the type of build this webhook will trigger.
`Webhook`	`withBuildType(WebhookBuildType buildType)` Specifies the type of build this webhook will trigger.
`Webhook`	`withFilterGroups(Collection<List<WebhookFilter>> filterGroups)` An array of arrays of `WebhookFilter` objects used to determine which webhooks are triggered.
`Webhook`	`withFilterGroups(List<WebhookFilter>... filterGroups)` An array of arrays of `WebhookFilter` objects used to determine which webhooks are triggered.
`Webhook`	`withLastModifiedSecret(Date lastModifiedSecret)` A timestamp that indicates the last time a repository's secret token was modified.
`Webhook`	`withPayloadUrl(String payloadUrl)` The AWS CodeBuild endpoint where webhook events are sent.
`Webhook`	`withSecret(String secret)` The secret token of the associated repository.
`Webhook`	`withUrl(String url)` The URL to the webhook.

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

- Constructor Detail
  - Webhook
```
public Webhook()
```
- Method Detail
  - setUrl
```
public void setUrl(String url)
```
    The URL to the webhook.
    
    Parameters:
    
    url - The URL to the webhook.
  - getUrl
```
public String getUrl()
```
    The URL to the webhook.
    
    Returns:
    
    The URL to the webhook.
  - withUrl
```
public Webhook withUrl(String url)
```
    The URL to the webhook.
    
    Parameters:
    
    url - The URL to the webhook.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPayloadUrl
```
public void setPayloadUrl(String payloadUrl)
```
    The AWS CodeBuild endpoint where webhook events are sent.
    
    Parameters:
    
    payloadUrl - The AWS CodeBuild endpoint where webhook events are sent.
  - getPayloadUrl
```
public String getPayloadUrl()
```
    The AWS CodeBuild endpoint where webhook events are sent.
    
    Returns:
    
    The AWS CodeBuild endpoint where webhook events are sent.
  - withPayloadUrl
```
public Webhook withPayloadUrl(String payloadUrl)
```
    The AWS CodeBuild endpoint where webhook events are sent.
    
    Parameters:
    
    payloadUrl - The AWS CodeBuild endpoint where webhook events are sent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecret
```
public void setSecret(String secret)
```
    The secret token of the associated repository.
    
    A Bitbucket webhook does not support secret.
    
    Parameters:
    
    secret - The secret token of the associated repository.
    
    A Bitbucket webhook does not support secret.
  - getSecret
```
public String getSecret()
```
    The secret token of the associated repository.
    
    A Bitbucket webhook does not support secret.
    
    Returns:
    
    The secret token of the associated repository.
    
    A Bitbucket webhook does not support secret.
  - withSecret
```
public Webhook withSecret(String secret)
```
    The secret token of the associated repository.
    
    A Bitbucket webhook does not support secret.
    
    Parameters:
    
    secret - The secret token of the associated repository.
    
    A Bitbucket webhook does not support secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBranchFilter
```
public void setBranchFilter(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.
    
    Parameters:
    
    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.
  - getBranchFilter
```
public String getBranchFilter()
```
    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.
  - withBranchFilter
```
public Webhook withBranchFilter(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilterGroups
```
public List<List<WebhookFilter>> getFilterGroups()
```
    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.
    
    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.
  - setFilterGroups
```
public void setFilterGroups(Collection<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.
    
    Parameters:
    
    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.
  - withFilterGroups
```
public Webhook withFilterGroups(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setFilterGroups(java.util.Collection) or withFilterGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilterGroups
```
public Webhook withFilterGroups(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBuildType
```
public void setBuildType(String buildType)
```
    Specifies the type of build this webhook will trigger.
    
    Parameters:
    
    buildType - Specifies the type of build this webhook will trigger.
    
    See Also:
    
    WebhookBuildType
  - getBuildType
```
public String getBuildType()
```
    Specifies the type of build this webhook will trigger.
    
    Returns:
    
    Specifies the type of build this webhook will trigger.
    
    See Also:
    
    WebhookBuildType
  - withBuildType
```
public Webhook withBuildType(String buildType)
```
    Specifies the type of build this webhook will trigger.
    
    Parameters:
    
    buildType - Specifies the type of build this webhook will trigger.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebhookBuildType
  - withBuildType
```
public Webhook withBuildType(WebhookBuildType buildType)
```
    Specifies the type of build this webhook will trigger.
    
    Parameters:
    
    buildType - Specifies the type of build this webhook will trigger.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebhookBuildType
  - setLastModifiedSecret
```
public void setLastModifiedSecret(Date lastModifiedSecret)
```
    A timestamp that indicates the last time a repository's secret token was modified.
    
    Parameters:
    
    lastModifiedSecret - A timestamp that indicates the last time a repository's secret token was modified.
  - getLastModifiedSecret
```
public Date getLastModifiedSecret()
```
    A timestamp that indicates the last time a repository's secret token was modified.
    
    Returns:
    
    A timestamp that indicates the last time a repository's secret token was modified.
  - withLastModifiedSecret
```
public Webhook withLastModifiedSecret(Date lastModifiedSecret)
```
    A timestamp that indicates the last time a repository's secret token was modified.
    
    Parameters:
    
    lastModifiedSecret - A timestamp that indicates the last time a repository's secret token was modified.
    
    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 Webhook 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 Webhook

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Webhook

Method Detail

setUrl

getUrl

withUrl

setPayloadUrl

getPayloadUrl

withPayloadUrl

setSecret

getSecret

withSecret

setBranchFilter

getBranchFilter

withBranchFilter

getFilterGroups

setFilterGroups

withFilterGroups

withFilterGroups

setBuildType

getBuildType

withBuildType

withBuildType

setLastModifiedSecret

getLastModifiedSecret

withLastModifiedSecret

toString

equals

hashCode

clone

marshall