Class: AWSCDK::Codepipeline::GitPullRequestFilter

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
codepipeline/git_pull_request_filter.rb

Overview

Git pull request filter for trigger.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(branches_excludes: nil, branches_includes: nil, events: nil, file_paths_excludes: nil, file_paths_includes: nil) ⇒ GitPullRequestFilter

Returns a new instance of GitPullRequestFilter.

Parameters:

  • branches_excludes (Array<String>, nil) (defaults to: nil) —

    The list of patterns of Git branches that, when pull request events occurs, are to be excluded from starting the pipeline.

  • branches_includes (Array<String>, nil) (defaults to: nil) —

    The list of patterns of Git branches that, when pull request events occurs, are to be included as criteria that starts the pipeline.

  • events (Array<AWSCDK::Codepipeline::GitPullRequestEvent>, nil) (defaults to: nil) —

    The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.

  • file_paths_excludes (Array<String>, nil) (defaults to: nil) —

    The list of patterns of Git repository file paths that, when pull request events occurs, are to be excluded from starting the pipeline.

  • file_paths_includes (Array<String>, nil) (defaults to: nil) —

    The list of patterns of Git repository file paths that, when pull request events occurs, are to be included as criteria that starts the pipeline.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'codepipeline/git_pull_request_filter.rb', line 12

def initialize(branches_excludes: nil, branches_includes: nil, events: nil, file_paths_excludes: nil, file_paths_includes: nil)
  @branches_excludes = branches_excludes
  Jsii::Type.check_type(@branches_excludes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "branchesExcludes") unless @branches_excludes.nil?
  @branches_includes = branches_includes
  Jsii::Type.check_type(@branches_includes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "branchesIncludes") unless @branches_includes.nil?
  @events = events
  Jsii::Type.check_type(@events, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuR2l0UHVsbFJlcXVlc3RFdmVudCJ9LCJraW5kIjoiYXJyYXkifX0=")), "events") unless @events.nil?
  @file_paths_excludes = file_paths_excludes
  Jsii::Type.check_type(@file_paths_excludes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "filePathsExcludes") unless @file_paths_excludes.nil?
  @file_paths_includes = file_paths_includes
  Jsii::Type.check_type(@file_paths_includes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "filePathsIncludes") unless @file_paths_includes.nil?
end

Instance Attribute Details

#branches_excludes ⇒ Array<String>? (readonly)

Note:

Default: - no branches.

The list of patterns of Git branches that, when pull request events occurs, are to be excluded from starting the pipeline.

You can filter with glob patterns. The branches_excludes takes priority over the branches_includes.

Maximum length of this array is 8.

Returns:

  • (Array<String>, nil) 


34
35
36
 
# File 'codepipeline/git_pull_request_filter.rb', line 34

def branches_excludes
  @branches_excludes
end

#branches_includes ⇒ Array<String>? (readonly)

Note:

Default: - no branches.

The list of patterns of Git branches that, when pull request events occurs, are to be included as criteria that starts the pipeline.

You can filter with glob patterns. The branches_excludes takes priority over the branches_includes.

Maximum length of this array is 8.

Returns:

  • (Array<String>, nil) 


44
45
46
 
# File 'codepipeline/git_pull_request_filter.rb', line 44

def branches_includes
  @branches_includes
end

#events ⇒ Array<AWSCDK::Codepipeline::GitPullRequestEvent>? (readonly)

Note:

Default: - all events.

The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.

Returns:



49
50
51
 
# File 'codepipeline/git_pull_request_filter.rb', line 49

def events
  @events
end

#file_paths_excludes ⇒ Array<String>? (readonly)

Note:

Default: - no filePaths.

The list of patterns of Git repository file paths that, when pull request events occurs, are to be excluded from starting the pipeline.

You can filter with glob patterns. The file_paths_excludes takes priority over the file_paths_includes.

Maximum length of this array is 8.

Returns:

  • (Array<String>, nil) 


59
60
61
 
# File 'codepipeline/git_pull_request_filter.rb', line 59

def file_paths_excludes
  @file_paths_excludes
end

#file_paths_includes ⇒ Array<String>? (readonly)

Note:

Default: - no filePaths.

The list of patterns of Git repository file paths that, when pull request events occurs, are to be included as criteria that starts the pipeline.

You can filter with glob patterns. The file_paths_excludes takes priority over the file_paths_includes.

Maximum length of this array is 8.

Returns:

  • (Array<String>, nil) 


69
70
71
 
# File 'codepipeline/git_pull_request_filter.rb', line 69

def file_paths_includes
  @file_paths_includes
end

Class Method Details

.jsii_properties ⇒ Object 



71
72
73
74
75
76
77
78
79
 
# File 'codepipeline/git_pull_request_filter.rb', line 71

def self.jsii_properties
  {
    :branches_excludes => "branchesExcludes",
    :branches_includes => "branchesIncludes",
    :events => "events",
    :file_paths_excludes => "filePathsExcludes",
    :file_paths_includes => "filePathsIncludes",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
 
# File 'codepipeline/git_pull_request_filter.rb', line 81

def to_jsii
  result = {}
  result.merge!({
    "branchesExcludes" => @branches_excludes,
    "branchesIncludes" => @branches_includes,
    "events" => @events,
    "filePathsExcludes" => @file_paths_excludes,
    "filePathsIncludes" => @file_paths_includes,
  })
  result.compact
end