Package software.amazon.awscdk.services.codebuild

Class GitHubEnterpriseSourceProps.Builder

java.lang.Object

software.amazon.awscdk.services.codebuild.GitHubEnterpriseSourceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubEnterpriseSourceProps>

Enclosing interface:

GitHubEnterpriseSourceProps

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

A builder for GitHubEnterpriseSourceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitHubEnterpriseSourceProps.Builder	branchOrRef(String branchOrRef)	Sets the value of GitHubEnterpriseSourceProps.getBranchOrRef()
GitHubEnterpriseSourceProps	build()	Builds the configured instance.
GitHubEnterpriseSourceProps.Builder	buildStatusContext(String buildStatusContext)	Sets the value of GitHubEnterpriseSourceProps.getBuildStatusContext()
GitHubEnterpriseSourceProps.Builder	buildStatusUrl(String buildStatusUrl)	Sets the value of GitHubEnterpriseSourceProps.getBuildStatusUrl()
GitHubEnterpriseSourceProps.Builder	cloneDepth(Number cloneDepth)	Sets the value of GitHubEnterpriseSourceProps.getCloneDepth()
GitHubEnterpriseSourceProps.Builder	fetchSubmodules(Boolean fetchSubmodules)	Sets the value of GitHubEnterpriseSourceProps.getFetchSubmodules()
GitHubEnterpriseSourceProps.Builder	httpsCloneUrl(String httpsCloneUrl)	Sets the value of GitHubEnterpriseSourceProps.getHttpsCloneUrl()
GitHubEnterpriseSourceProps.Builder	identifier(String identifier)	Sets the value of SourceProps.getIdentifier()
GitHubEnterpriseSourceProps.Builder	ignoreSslErrors(Boolean ignoreSslErrors)	Sets the value of GitHubEnterpriseSourceProps.getIgnoreSslErrors()
GitHubEnterpriseSourceProps.Builder	reportBuildStatus(Boolean reportBuildStatus)	Sets the value of GitHubEnterpriseSourceProps.getReportBuildStatus()
GitHubEnterpriseSourceProps.Builder	webhook(Boolean webhook)	Sets the value of GitHubEnterpriseSourceProps.getWebhook()
GitHubEnterpriseSourceProps.Builder	webhookFilters(List<? extends FilterGroup> webhookFilters)	Sets the value of GitHubEnterpriseSourceProps.getWebhookFilters()
GitHubEnterpriseSourceProps.Builder	webhookTriggersBatchBuild(Boolean webhookTriggersBatchBuild)	Sets the value of GitHubEnterpriseSourceProps.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

httpsCloneUrl

@Stability(Stable)
public GitHubEnterpriseSourceProps.Builder httpsCloneUrl(String httpsCloneUrl)

Sets the value of GitHubEnterpriseSourceProps.getHttpsCloneUrl()

Parameters:

httpsCloneUrl - The HTTPS URL of the repository in your GitHub Enterprise installation. This parameter is required.

Returns:

this

branchOrRef

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

Sets the value of GitHubEnterpriseSourceProps.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 GitHubEnterpriseSourceProps.Builder buildStatusContext(String buildStatusContext)

Sets the value of GitHubEnterpriseSourceProps.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 GitHubEnterpriseSourceProps.Builder buildStatusUrl(String buildStatusUrl)

Sets the value of GitHubEnterpriseSourceProps.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 GitHubEnterpriseSourceProps.Builder cloneDepth(Number cloneDepth)

Sets the value of GitHubEnterpriseSourceProps.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 GitHubEnterpriseSourceProps.Builder fetchSubmodules(Boolean fetchSubmodules)

Sets the value of GitHubEnterpriseSourceProps.getFetchSubmodules()

Parameters:

fetchSubmodules - Whether to fetch submodules while cloning git repo.

Returns:

this

ignoreSslErrors

@Stability(Stable)
public GitHubEnterpriseSourceProps.Builder ignoreSslErrors(Boolean ignoreSslErrors)

Sets the value of GitHubEnterpriseSourceProps.getIgnoreSslErrors()

Parameters:

ignoreSslErrors - Whether to ignore SSL errors when connecting to the repository.

Returns:

this

reportBuildStatus

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

Sets the value of GitHubEnterpriseSourceProps.getReportBuildStatus()

Parameters:

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

Returns:

this

webhook

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

Sets the value of GitHubEnterpriseSourceProps.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 GitHubEnterpriseSourceProps.Builder webhookFilters(List<? extends FilterGroup> webhookFilters)

Sets the value of GitHubEnterpriseSourceProps.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 GitHubEnterpriseSourceProps.Builder webhookTriggersBatchBuild(Boolean webhookTriggersBatchBuild)

Sets the value of GitHubEnterpriseSourceProps.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 GitHubEnterpriseSourceProps.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 GitHubEnterpriseSourceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GitHubEnterpriseSourceProps

Throws:

NullPointerException - if any required attribute was not provided