Class: AWSCDK::Codepipeline::GitPushFilter

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

Overview

Git push filter for trigger.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(branches_excludes: nil, branches_includes: nil, file_paths_excludes: nil, file_paths_includes: nil, tags_excludes: nil, tags_includes: nil) ⇒ GitPushFilter

Returns a new instance of GitPushFilter.

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.

  • 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.

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

    The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.

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

    The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'codepipeline/git_push_filter.rb', line 13

def initialize(branches_excludes: nil, branches_includes: nil, file_paths_excludes: nil, file_paths_includes: nil, tags_excludes: nil, tags_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?
  @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?
  @tags_excludes = tags_excludes
  Jsii::Type.check_type(@tags_excludes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsExcludes") unless @tags_excludes.nil?
  @tags_includes = tags_includes
  Jsii::Type.check_type(@tags_includes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsIncludes") unless @tags_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) 


37
38
39
 
# File 'codepipeline/git_push_filter.rb', line 37

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) 


47
48
49
 
# File 'codepipeline/git_push_filter.rb', line 47

def branches_includes
  @branches_includes
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) 


57
58
59
 
# File 'codepipeline/git_push_filter.rb', line 57

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) 


67
68
69
 
# File 'codepipeline/git_push_filter.rb', line 67

def file_paths_includes
  @file_paths_includes
end

#tags_excludes ⇒ Array<String>? (readonly)

Note:

Default: - no tags.

The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.

You can filter with glob patterns. The tags_excludes takes priority over the tags_includes.

Maximum length of this array is 8.

Returns:

  • (Array<String>, nil) 


77
78
79
 
# File 'codepipeline/git_push_filter.rb', line 77

def tags_excludes
  @tags_excludes
end

#tags_includes ⇒ Array<String>? (readonly)

Note:

Default: - no tags.

The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.

You can filter with glob patterns. The tags_excludes takes priority over the tags_includes.

Maximum length of this array is 8.

Returns:

  • (Array<String>, nil) 


87
88
89
 
# File 'codepipeline/git_push_filter.rb', line 87

def tags_includes
  @tags_includes
end

Class Method Details

.jsii_properties ⇒ Object 



89
90
91
92
93
94
95
96
97
98
 
# File 'codepipeline/git_push_filter.rb', line 89

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

Instance Method Details

#to_jsii ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'codepipeline/git_push_filter.rb', line 100

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