Package software.amazon.awscdk.services.codepipeline.actions

Interface GitHubSourceVariables

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitHubSourceVariables.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-24T10:56:29.333Z")
@Stability(Stable)
public interface GitHubSourceVariables
extends software.amazon.jsii.JsiiSerializable

The CodePipeline variables emitted by GitHub source Action.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.actions.*;
 GitHubSourceVariables gitHubSourceVariables = GitHubSourceVariables.builder()
         .authorDate("authorDate")
         .branchName("branchName")
         .commitId("commitId")
         .commitMessage("commitMessage")
         .committerDate("committerDate")
         .commitUrl("commitUrl")
         .repositoryName("repositoryName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GitHubSourceVariables.Builder	A builder for GitHubSourceVariables
static final class	GitHubSourceVariables.Jsii$Proxy	An implementation for GitHubSourceVariables

Method Summary

Modifier and Type	Method	Description
static GitHubSourceVariables.Builder	builder()
String	getAuthorDate()	The date the currently last commit on the tracked branch was authored, in ISO-8601 format.
String	getBranchName()	The name of the branch this action tracks.
String	getCommitId()	The SHA1 hash of the currently last commit on the tracked branch.
String	getCommitMessage()	The message of the currently last commit on the tracked branch.
String	getCommitterDate()	The date the currently last commit on the tracked branch was committed, in ISO-8601 format.
String	getCommitUrl()	The GitHub API URL of the currently last commit on the tracked branch.
String	getRepositoryName()	The name of the repository this action points to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorDate

@Stability(Stable)
@NotNull
String getAuthorDate()

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

getBranchName

@Stability(Stable)
@NotNull
String getBranchName()

The name of the branch this action tracks.

getCommitId

@Stability(Stable)
@NotNull
String getCommitId()

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

getCommitMessage

@Stability(Stable)
@NotNull
String getCommitMessage()

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

getCommitterDate

@Stability(Stable)
@NotNull
String getCommitterDate()

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

getCommitUrl

@Stability(Stable)
@NotNull
String getCommitUrl()

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

getRepositoryName

@Stability(Stable)
@NotNull
String getRepositoryName()

The name of the repository this action points to.

builder

@Stability(Stable)
static GitHubSourceVariables.Builder builder()

Returns:

a GitHubSourceVariables.Builder of GitHubSourceVariables