Package software.amazon.awscdk.services.codebuild

Class GitHubSourceProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codebuild.GitHubSourceProps.Jsii$Proxy

All Implemented Interfaces:

GitHubSourceProps, SourceProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

GitHubSourceProps

@Stability(Stable)
@Internal
public static final class GitHubSourceProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements GitHubSourceProps

An implementation for GitHubSourceProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.GitHubSourceProps

GitHubSourceProps.Builder, GitHubSourceProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(GitHubSourceProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the GitHubSourceProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getBranchOrRef()	The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build.
final String	getBuildStatusContext()	This parameter is used for the context parameter in the GitHub commit status.
final String	getBuildStatusUrl()	The URL that the build will report back to the source provider.
final Number	getCloneDepth()	The depth of history to download.
final Boolean	getFetchSubmodules()	Whether to fetch submodules while cloning git repo.
final String	getIdentifier()	The source identifier.
final String	getOwner()	The GitHub account/user that owns the repo.
final String	getRepo()	The name of the repo (without the username).
final Boolean	getReportBuildStatus()	Whether to send notifications on your build's start and end.
final Boolean	getWebhook()	Whether to create a webhook that will trigger a build every time an event happens in the repository.
final List<FilterGroup>	getWebhookFilters()	A list of webhook filters that can constraint what events in the repository will trigger a build.
final Boolean	getWebhookTriggersBatchBuild()	Trigger a batch build from a webhook instead of a standard one.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(GitHubSourceProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the GitHubSourceProps.Builder.

Method Details

getOwner

public final String getOwner()

Description copied from interface: GitHubSourceProps

The GitHub account/user that owns the repo.

Example:

 "awslabs";
 

Specified by:

getOwner in interface GitHubSourceProps

getRepo

public final String getRepo()

Description copied from interface: GitHubSourceProps

The name of the repo (without the username).

Example:

 "aws-cdk";
 

Specified by:

getRepo in interface GitHubSourceProps

getBranchOrRef

public final String getBranchOrRef()

Description copied from interface: GitHubSourceProps

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build.

Default: the default branch's HEAD commit ID is used

Example:

 "mybranch";
 

Specified by:

getBranchOrRef in interface GitHubSourceProps

getBuildStatusContext

public final String getBuildStatusContext()

Description copied from interface: GitHubSourceProps

This parameter is used for the context parameter in the GitHub commit status.

Can use built-in CodeBuild variables, like $AWS_REGION.

Default: "AWS CodeBuild $AWS_REGION ($PROJECT_NAME)"

Example:

 "My build #$CODEBUILD_BUILD_NUMBER";
 

Specified by:

getBuildStatusContext in interface GitHubSourceProps

See Also:

• https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html

getBuildStatusUrl

public final String getBuildStatusUrl()

Description copied from interface: GitHubSourceProps

The URL that the build will report back to the source provider.

Can use built-in CodeBuild variables, like $AWS_REGION.

Default: - link to the AWS Console for CodeBuild to a particular build execution

Example:

 "$CODEBUILD_PUBLIC_BUILD_URL";
 

Specified by:

getBuildStatusUrl in interface GitHubSourceProps

See Also:

• https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html

getCloneDepth

public final Number getCloneDepth()

Description copied from interface: GitHubSourceProps

The depth of history to download.

Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build of the project.

Specified by:

getCloneDepth in interface GitHubSourceProps

getFetchSubmodules

public final Boolean getFetchSubmodules()

Description copied from interface: GitHubSourceProps

Whether to fetch submodules while cloning git repo.

Default: false

Specified by:

getFetchSubmodules in interface GitHubSourceProps

getReportBuildStatus

public final Boolean getReportBuildStatus()

Description copied from interface: GitHubSourceProps

Whether to send notifications on your build's start and end.

Default: true

Specified by:

getReportBuildStatus in interface GitHubSourceProps

getWebhook

public final Boolean getWebhook()

Description copied from interface: GitHubSourceProps

Whether to create a webhook that will trigger a build every time an event happens in the repository.

Default: true if any `webhookFilters` were provided, false otherwise

Specified by:

getWebhook in interface GitHubSourceProps

getWebhookFilters

public final List<FilterGroup> getWebhookFilters()

Description copied from interface: GitHubSourceProps

A list of webhook filters that can constraint what events in the repository will trigger a build.

A build is triggered if any of the provided filter groups match. Only valid if webhook was not provided as false.

Default: every push and every Pull Request (create or update) triggers a build

Specified by:

getWebhookFilters in interface GitHubSourceProps

getWebhookTriggersBatchBuild

public final Boolean getWebhookTriggersBatchBuild()

Description copied from interface: GitHubSourceProps

Trigger a batch build from a webhook instead of a standard one.

Enabling this will enable batch builds on the CodeBuild project.

Default: false

Specified by:

getWebhookTriggersBatchBuild in interface GitHubSourceProps

getIdentifier

public final String getIdentifier()

Description copied from interface: SourceProps

The source identifier.

This property is required on secondary sources.

Specified by:

getIdentifier in interface SourceProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object