Class: AWSCDK::CodePipelineActions::GitHubSourceVariables

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
code_pipeline_actions/git_hub_source_variables.rb

Overview

The CodePipeline variables emitted by GitHub source Action.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(author_date:, branch_name:, commit_id:, commit_message:, committer_date:, commit_url:, repository_name:) ⇒ GitHubSourceVariables

Returns a new instance of GitHubSourceVariables.

Parameters:

  • author_date (String) —

    The date the currently last commit on the tracked branch was authored, in ISO-8601 format.

  • branch_name (String) —

    The name of the branch this action tracks.

  • commit_id (String) —

    The SHA1 hash of the currently last commit on the tracked branch.

  • commit_message (String) —

    The message of the currently last commit on the tracked branch.

  • committer_date (String) —

    The date the currently last commit on the tracked branch was committed, in ISO-8601 format.

  • commit_url (String) —

    The GitHub API URL of the currently last commit on the tracked branch.

  • repository_name (String) —

    The name of the repository this action points to.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 14

def initialize(author_date:, branch_name:, commit_id:, commit_message:, committer_date:, commit_url:, repository_name:)
  @author_date = author_date
  Jsii::Type.check_type(@author_date, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorDate")
  @branch_name = branch_name
  Jsii::Type.check_type(@branch_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "branchName")
  @commit_id = commit_id
  Jsii::Type.check_type(@commit_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "commitId")
  @commit_message = commit_message
  Jsii::Type.check_type(@commit_message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "commitMessage")
  @committer_date = committer_date
  Jsii::Type.check_type(@committer_date, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "committerDate")
  @commit_url = commit_url
  Jsii::Type.check_type(@commit_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "commitUrl")
  @repository_name = repository_name
  Jsii::Type.check_type(@repository_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "repositoryName")
end

Instance Attribute Details

#author_date ⇒ String (readonly)

The date the currently last commit on the tracked branch was authored, in ISO-8601 format.

Returns:

  • (String) 


34
35
36
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 34

def author_date
  @author_date
end

#branch_name ⇒ String (readonly)

The name of the branch this action tracks.

Returns:

  • (String) 


38
39
40
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 38

def branch_name
  @branch_name
end

#commit_id ⇒ String (readonly)

The SHA1 hash of the currently last commit on the tracked branch.

Returns:

  • (String) 


42
43
44
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 42

def commit_id
  @commit_id
end

#commit_message ⇒ String (readonly)

The message of the currently last commit on the tracked branch.

Returns:

  • (String) 


46
47
48
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 46

def commit_message
  @commit_message
end

#commit_url ⇒ String (readonly)

The GitHub API URL of the currently last commit on the tracked branch.

Returns:

  • (String) 


54
55
56
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 54

def commit_url
  @commit_url
end

#committer_date ⇒ String (readonly)

The date the currently last commit on the tracked branch was committed, in ISO-8601 format.

Returns:

  • (String) 


50
51
52
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 50

def committer_date
  @committer_date
end

#repository_name ⇒ String (readonly)

The name of the repository this action points to.

Returns:

  • (String) 


58
59
60
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 58

def repository_name
  @repository_name
end

Class Method Details

.jsii_properties ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 60

def self.jsii_properties
  {
    :author_date => "authorDate",
    :branch_name => "branchName",
    :commit_id => "commitId",
    :commit_message => "commitMessage",
    :committer_date => "committerDate",
    :commit_url => "commitUrl",
    :repository_name => "repositoryName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'code_pipeline_actions/git_hub_source_variables.rb', line 72

def to_jsii
  result = {}
  result.merge!({
    "authorDate" => @author_date,
    "branchName" => @branch_name,
    "commitId" => @commit_id,
    "commitMessage" => @commit_message,
    "committerDate" => @committer_date,
    "commitUrl" => @commit_url,
    "repositoryName" => @repository_name,
  })
  result.compact
end