All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateWebhookRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  CreateWebhookRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  CreateWebhookRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  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.
  Boolean	getManualCreation () If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook.
  String	getProjectName () The name of the CodeBuild project.
  ScopeConfiguration	getScopeConfiguration () The scope configuration for global or organization webhooks.
  int	hashCode ()
  Boolean	isManualCreation () If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook.
  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	setManualCreation (Boolean manualCreation) If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook.
  void	setProjectName (String projectName) The name of the CodeBuild project.
  void	setScopeConfiguration (ScopeConfiguration scopeConfiguration) The scope configuration for global or organization webhooks.
  String	toString () Returns a string representation of this object.
  CreateWebhookRequest	withBranchFilter (String branchFilter) A regular expression used to determine which repository branches are built when a webhook is triggered.
  CreateWebhookRequest	withBuildType (String buildType) Specifies the type of build this webhook will trigger.
  CreateWebhookRequest	withBuildType (WebhookBuildType buildType) Specifies the type of build this webhook will trigger.
  CreateWebhookRequest	withFilterGroups (Collection<List<WebhookFilter>> filterGroups) An array of arrays of WebhookFilter objects used to determine which webhooks are triggered.
  CreateWebhookRequest	withFilterGroups (List<WebhookFilter>... filterGroups) An array of arrays of WebhookFilter objects used to determine which webhooks are triggered.
  CreateWebhookRequest	withManualCreation (Boolean manualCreation) If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook.
  CreateWebhookRequest	withProjectName (String projectName) The name of the CodeBuild project.
  CreateWebhookRequest	withScopeConfiguration (ScopeConfiguration scopeConfiguration) The scope configuration for global or organization webhooks.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • CreateWebhookRequest

    public CreateWebhookRequest()

• Method Detail

  • setProjectName

    public void setProjectName(String projectName)

    The name of the CodeBuild project.

    Parameters:

    projectName - The name of the CodeBuild project.

  • getProjectName

    public String getProjectName()

    The name of the CodeBuild project.

    Returns:

    The name of the CodeBuild project.

  • withProjectName

    public CreateWebhookRequest withProjectName(String projectName)

    The name of the CodeBuild project.

    Parameters:

    projectName - The name of the CodeBuild project.

    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 CreateWebhookRequest 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 CreateWebhookRequest 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 CreateWebhookRequest 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 CreateWebhookRequest 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 CreateWebhookRequest 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

  • setManualCreation

    public void setManualCreation(Boolean manualCreation)

    If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

    manualCreation is only available for GitHub webhooks.

    Parameters:

    manualCreation - If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

    manualCreation is only available for GitHub webhooks.

  • getManualCreation

    public Boolean getManualCreation()

    If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

    manualCreation is only available for GitHub webhooks.

    Returns:

    If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

    manualCreation is only available for GitHub webhooks.

  • withManualCreation

    public CreateWebhookRequest withManualCreation(Boolean manualCreation)

    If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

    manualCreation is only available for GitHub webhooks.

    Parameters:

    manualCreation - If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

    manualCreation is only available for GitHub webhooks.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • isManualCreation

    public Boolean isManualCreation()

    If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

    manualCreation is only available for GitHub webhooks.

    Returns:

    If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

    manualCreation is only available for GitHub webhooks.

  • setScopeConfiguration

    public void setScopeConfiguration(ScopeConfiguration scopeConfiguration)

    The scope configuration for global or organization webhooks.

    Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

    Parameters:

    scopeConfiguration - The scope configuration for global or organization webhooks.

    Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

  • getScopeConfiguration

    public ScopeConfiguration getScopeConfiguration()

    The scope configuration for global or organization webhooks.

    Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

    Returns:

    The scope configuration for global or organization webhooks.

    Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

  • withScopeConfiguration

    public CreateWebhookRequest withScopeConfiguration(ScopeConfiguration scopeConfiguration)

    The scope configuration for global or organization webhooks.

    Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

    Parameters:

    scopeConfiguration - The scope configuration for global or organization webhooks.

    Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

    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 CreateWebhookRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()