Package software.amazon.awscdk.services.codebuild

Class GitHubSourceProps.Builder

java.lang.Object

software.amazon.awscdk.services.codebuild.GitHubSourceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubSourceProps>

Enclosing interface:

GitHubSourceProps

@Stability(Stable)
public static final class GitHubSourceProps.Builder
extends Object
implements software.amazon.jsii.Builder<GitHubSourceProps>

A builder for GitHubSourceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitHubSourceProps.Builder	branchOrRef(String branchOrRef)	Sets the value of GitHubSourceProps.getBranchOrRef()
GitHubSourceProps	build()	Builds the configured instance.
GitHubSourceProps.Builder	buildStatusContext(String buildStatusContext)	Sets the value of GitHubSourceProps.getBuildStatusContext()
GitHubSourceProps.Builder	buildStatusUrl(String buildStatusUrl)	Sets the value of GitHubSourceProps.getBuildStatusUrl()
GitHubSourceProps.Builder	cloneDepth(Number cloneDepth)	Sets the value of GitHubSourceProps.getCloneDepth()
GitHubSourceProps.Builder	fetchSubmodules(Boolean fetchSubmodules)	Sets the value of GitHubSourceProps.getFetchSubmodules()
GitHubSourceProps.Builder	identifier(String identifier)	Sets the value of SourceProps.getIdentifier()
GitHubSourceProps.Builder	owner(String owner)	Sets the value of GitHubSourceProps.getOwner()
GitHubSourceProps.Builder	repo(String repo)	Sets the value of GitHubSourceProps.getRepo()
GitHubSourceProps.Builder	reportBuildStatus(Boolean reportBuildStatus)	Sets the value of GitHubSourceProps.getReportBuildStatus()
GitHubSourceProps.Builder	webhook(Boolean webhook)	Sets the value of GitHubSourceProps.getWebhook()
GitHubSourceProps.Builder	webhookFilters(List<? extends FilterGroup> webhookFilters)	Sets the value of GitHubSourceProps.getWebhookFilters()
GitHubSourceProps.Builder	webhookTriggersBatchBuild(Boolean webhookTriggersBatchBuild)	Sets the value of GitHubSourceProps.getWebhookTriggersBatchBuild()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

owner

@Stability(Stable)
public GitHubSourceProps.Builder owner(String owner)

Sets the value of GitHubSourceProps.getOwner()

Parameters:

owner - The GitHub Organization/user that owns the repo. This parameter is required.

Returns:

this

branchOrRef

@Stability(Stable)
public GitHubSourceProps.Builder branchOrRef(String branchOrRef)

Sets the value of GitHubSourceProps.getBranchOrRef()

Parameters:

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

Returns:

this

buildStatusContext

@Stability(Stable)
public GitHubSourceProps.Builder buildStatusContext(String buildStatusContext)

Sets the value of GitHubSourceProps.getBuildStatusContext()

Parameters:

buildStatusContext - This parameter is used for the context parameter in the GitHub commit status. Can use built-in CodeBuild variables, like $AWS_REGION.

Returns:

this

buildStatusUrl

@Stability(Stable)
public GitHubSourceProps.Builder buildStatusUrl(String buildStatusUrl)

Sets the value of GitHubSourceProps.getBuildStatusUrl()

Parameters:

buildStatusUrl - The URL that the build will report back to the source provider. Can use built-in CodeBuild variables, like $AWS_REGION.

Returns:

this

cloneDepth

@Stability(Stable)
public GitHubSourceProps.Builder cloneDepth(Number cloneDepth)

Sets the value of GitHubSourceProps.getCloneDepth()

Parameters:

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

Returns:

this

fetchSubmodules

@Stability(Stable)
public GitHubSourceProps.Builder fetchSubmodules(Boolean fetchSubmodules)

Sets the value of GitHubSourceProps.getFetchSubmodules()

Parameters:

fetchSubmodules - Whether to fetch submodules while cloning git repo.

Returns:

this

repo

@Stability(Stable)
public GitHubSourceProps.Builder repo(String repo)

Sets the value of GitHubSourceProps.getRepo()

Parameters:

repo - The name of the repo (without the username).

Returns:

this

reportBuildStatus

@Stability(Stable)
public GitHubSourceProps.Builder reportBuildStatus(Boolean reportBuildStatus)

Sets the value of GitHubSourceProps.getReportBuildStatus()

Parameters:

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

Returns:

this

webhook

@Stability(Stable)
public GitHubSourceProps.Builder webhook(Boolean webhook)

Sets the value of GitHubSourceProps.getWebhook()

Parameters:

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

Returns:

this

webhookFilters

@Stability(Stable)
public GitHubSourceProps.Builder webhookFilters(List<? extends FilterGroup> webhookFilters)

Sets the value of GitHubSourceProps.getWebhookFilters()

Parameters:

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

Returns:

this

webhookTriggersBatchBuild

@Stability(Stable)
public GitHubSourceProps.Builder webhookTriggersBatchBuild(Boolean webhookTriggersBatchBuild)

Sets the value of GitHubSourceProps.getWebhookTriggersBatchBuild()

Parameters:

webhookTriggersBatchBuild - Trigger a batch build from a webhook instead of a standard one. Enabling this will enable batch builds on the CodeBuild project.

Returns:

this

identifier

@Stability(Stable)
public GitHubSourceProps.Builder identifier(String identifier)

Sets the value of SourceProps.getIdentifier()

Parameters:

identifier - The source identifier. This property is required on secondary sources.

Returns:

this

build

@Stability(Stable)
public GitHubSourceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GitHubSourceProps>

Returns:

a new instance of GitHubSourceProps

Throws:

NullPointerException - if any required attribute was not provided