Class: Aws::CodeBuild::Types::WebhookFilter
- Inherits:
- 
      Struct
      
        - Object
- Struct
- Aws::CodeBuild::Types::WebhookFilter
 
- Defined in:
- gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb
Overview
A filter used to determine which webhooks trigger a build.
Constant Summary collapse
- SENSITIVE =
- [] 
Instance Attribute Summary collapse
- 
  
    
      #exclude_matched_pattern  ⇒ Boolean 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    Used to indicate that the patterndetermines which webhook events do not trigger a build.
- 
  
    
      #pattern  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    For a WebHookFilterthat usesEVENTtype, a comma-separated string that specifies one or more events.
- 
  
    
      #type  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The type of webhook filter. 
Instance Attribute Details
#exclude_matched_pattern ⇒ Boolean
Used to indicate that the pattern determines which webhook events
do not trigger a build. If true, then a webhook event that does not
match the pattern triggers a build. If false, then a webhook event
that matches the pattern triggers a build.
| 8408 8409 8410 8411 8412 8413 8414 | # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 8408 class WebhookFilter < Struct.new( :type, :pattern, :exclude_matched_pattern) SENSITIVE = [] include Aws::Structure end | 
#pattern ⇒ String
For a WebHookFilter that uses EVENT type, a comma-separated
string that specifies one or more events. For example, the webhook
filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all
push, pull request created, and pull request updated events to
trigger a build.
For a WebHookFilter that uses any of the other filter types, a
regular expression pattern. For example, a WebHookFilter that uses
HEAD_REF for its type and the pattern ^refs/heads/ triggers a
build when the head reference is a branch with a reference name
refs/heads/branch-name.
| 8408 8409 8410 8411 8412 8413 8414 | # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 8408 class WebhookFilter < Struct.new( :type, :pattern, :exclude_matched_pattern) SENSITIVE = [] include Aws::Structure end | 
#type ⇒ String
The type of webhook filter. There are 11 webhook filter types:
EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH,
COMMIT_MESSAGE, TAG_NAME, RELEASE_NAME, REPOSITORY_NAME,
ORGANIZATION_NAME, and WORKFLOW_NAME.
- EVENT - A webhook event triggers a build when the provided - patternmatches one of nine event types:- PUSH,- PULL_REQUEST_CREATED,- PULL_REQUEST_UPDATED,- PULL_REQUEST_CLOSED,- PULL_REQUEST_REOPENED,- PULL_REQUEST_MERGED,- RELEASED,- PRERELEASED, and- WORKFLOW_JOB_QUEUED. The- EVENTpatterns are specified as a comma-separated string. For example,- PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATEDfilters all push, pull request created, and pull request updated events.- Types - PULL_REQUEST_REOPENEDand- WORKFLOW_JOB_QUEUEDwork with GitHub and GitHub Enterprise only. Types- RELEASEDand- PRERELEASEDwork with GitHub only.
 
- ACTOR_ACCOUNT_ID - A webhook event triggers a build when a GitHub, GitHub
Enterprise, or Bitbucket account ID matches the regular
expression pattern.
 - ^ 
- A webhook event triggers a build when a GitHub, GitHub
Enterprise, or Bitbucket account ID matches the regular
expression 
- HEAD_REF - A webhook event triggers a build when the head reference matches the regular expression - pattern. For example,- refs/heads/branch-nameand- refs/tags/tag-name.- Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events. 
 
- BASE_REF - A webhook event triggers a build when the base reference matches the regular expression - pattern. For example,- refs/heads/branch-name.- Works with pull request events only. 
 
- FILE_PATH - A webhook triggers a build when the path of a changed file matches the regular expression - pattern.- Works with push and pull request events only. 
 
- COMMIT_MESSAGE - A webhook triggers a build when the head commit message matches the regular expression - pattern.- Works with push and pull request events only. 
 
- TAG_NAME - A webhook triggers a build when the tag name of the release matches the regular expression - pattern.- Works with - RELEASEDand- PRERELEASEDevents only.
 
- RELEASE_NAME - A webhook triggers a build when the release name matches the regular expression - pattern.- Works with - RELEASEDand- PRERELEASEDevents only.
 
- REPOSITORY_NAME - A webhook triggers a build when the repository name matches the regular expression - pattern.- Works with GitHub global or organization webhooks only. 
 
- ORGANIZATION_NAME - A webhook triggers a build when the organization name matches the regular expression - pattern.- Works with GitHub global webhooks only. 
 
- WORKFLOW_NAME - A webhook triggers a build when the workflow name matches the regular expression - pattern.- Works with - WORKFLOW_JOB_QUEUEDevents only.- For CodeBuild-hosted Buildkite runner builds, WORKFLOW_NAME filters will filter by pipeline name. 
 
| 8408 8409 8410 8411 8412 8413 8414 | # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 8408 class WebhookFilter < Struct.new( :type, :pattern, :exclude_matched_pattern) SENSITIVE = [] include Aws::Structure end |