Package software.amazon.awssdk.services.codebuild.model

Interface BuildBatch.Builder

    • Method Detail

      • id

        BuildBatch.Builder id​(String id)

        The identifier of the batch build.

        Parameters:
        id - The identifier of the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • arn

        BuildBatch.Builder arn​(String arn)

        The ARN of the batch build.

        Parameters:
        arn - The ARN of the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        BuildBatch.Builder startTime​(Instant startTime)

        The date and time that the batch build started.

        Parameters:
        startTime - The date and time that the batch build started.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endTime

        BuildBatch.Builder endTime​(Instant endTime)

        The date and time that the batch build ended.

        Parameters:
        endTime - The date and time that the batch build ended.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • currentPhase

        BuildBatch.Builder currentPhase​(String currentPhase)

        The current phase of the batch build.

        Parameters:
        currentPhase - The current phase of the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildBatchStatus

        BuildBatch.Builder buildBatchStatus​(String buildBatchStatus)

        The status of the batch build.

        Parameters:
        buildBatchStatus - The status of the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StatusType, StatusType

      • buildBatchStatus

        BuildBatch.Builder buildBatchStatus​(StatusType buildBatchStatus)

        The status of the batch build.

        Parameters:
        buildBatchStatus - The status of the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StatusType, StatusType

      • sourceVersion

        BuildBatch.Builder sourceVersion​(String sourceVersion)

        The identifier of the version of the source code to be built.

        Parameters:
        sourceVersion - The identifier of the version of the source code to be built.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resolvedSourceVersion

        BuildBatch.Builder resolvedSourceVersion​(String resolvedSourceVersion)

        The identifier of the resolved version of this batch build's source code.

        • For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

        • For CodePipeline, the source revision provided by CodePipeline.

        • For Amazon S3, this does not apply.

        Parameters:
        resolvedSourceVersion - The identifier of the resolved version of this batch build's source code.

        • For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

        • For CodePipeline, the source revision provided by CodePipeline.

        • For Amazon S3, this does not apply.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • projectName

        BuildBatch.Builder projectName​(String projectName)

        The name of the batch build project.

        Parameters:
        projectName - The name of the batch build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phases

        BuildBatch.Builder phases​(Collection<BuildBatchPhase> phases)

        An array of BuildBatchPhase objects the specify the phases of the batch build.

        Parameters:
        phases - An array of BuildBatchPhase objects the specify the phases of the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phases

        BuildBatch.Builder phases​(BuildBatchPhase... phases)

        An array of BuildBatchPhase objects the specify the phases of the batch build.

        Parameters:
        phases - An array of BuildBatchPhase objects the specify the phases of the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • source

        BuildBatch.Builder source​(ProjectSource source)
        Sets the value of the Source property for this object.
        Parameters:
        source - The new value for the Source property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondarySources

        BuildBatch.Builder secondarySources​(Collection<ProjectSource> secondarySources)

        An array of ProjectSource objects that define the sources for the batch build.

        Parameters:
        secondarySources - An array of ProjectSource objects that define the sources for the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondarySources

        BuildBatch.Builder secondarySources​(ProjectSource... secondarySources)

        An array of ProjectSource objects that define the sources for the batch build.

        Parameters:
        secondarySources - An array of ProjectSource objects that define the sources for the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondarySources

        BuildBatch.Builder secondarySources​(Consumer<ProjectSource.Builder>... secondarySources)

        An array of ProjectSource objects that define the sources for the batch build.

        This is a convenience method that creates an instance of the ProjectSource.Builder avoiding the need to create one manually via ProjectSource.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #secondarySources(List).

        Parameters:
        secondarySources - a consumer that will call methods on ProjectSource.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #secondarySources(java.util.Collection)

      • secondarySourceVersions

        BuildBatch.Builder secondarySourceVersions​(Collection<ProjectSourceVersion> secondarySourceVersions)

        An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

        • For CodeCommit: the commit ID, branch, or Git tag to use.

        • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

        Parameters:
        secondarySourceVersions - An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

        • For CodeCommit: the commit ID, branch, or Git tag to use.

        • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondarySourceVersions

        BuildBatch.Builder secondarySourceVersions​(ProjectSourceVersion... secondarySourceVersions)

        An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

        • For CodeCommit: the commit ID, branch, or Git tag to use.

        • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

        Parameters:
        secondarySourceVersions - An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

        • For CodeCommit: the commit ID, branch, or Git tag to use.

        • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondarySourceVersions

        BuildBatch.Builder secondarySourceVersions​(Consumer<ProjectSourceVersion.Builder>... secondarySourceVersions)

        An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

        • For CodeCommit: the commit ID, branch, or Git tag to use.

        • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

        • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

        This is a convenience method that creates an instance of the ProjectSourceVersion.Builder avoiding the need to create one manually via ProjectSourceVersion.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #secondarySourceVersions(List).

        Parameters:
        secondarySourceVersions - a consumer that will call methods on ProjectSourceVersion.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #secondarySourceVersions(java.util.Collection)

      • artifacts

        BuildBatch.Builder artifacts​(BuildArtifacts artifacts)

        A BuildArtifacts object the defines the build artifacts for this batch build.

        Parameters:
        artifacts - A BuildArtifacts object the defines the build artifacts for this batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondaryArtifacts

        BuildBatch.Builder secondaryArtifacts​(Collection<BuildArtifacts> secondaryArtifacts)

        An array of BuildArtifacts objects the define the build artifacts for this batch build.

        Parameters:
        secondaryArtifacts - An array of BuildArtifacts objects the define the build artifacts for this batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondaryArtifacts

        BuildBatch.Builder secondaryArtifacts​(BuildArtifacts... secondaryArtifacts)

        An array of BuildArtifacts objects the define the build artifacts for this batch build.

        Parameters:
        secondaryArtifacts - An array of BuildArtifacts objects the define the build artifacts for this batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondaryArtifacts

        BuildBatch.Builder secondaryArtifacts​(Consumer<BuildArtifacts.Builder>... secondaryArtifacts)

        An array of BuildArtifacts objects the define the build artifacts for this batch build.

        This is a convenience method that creates an instance of the BuildArtifacts.Builder avoiding the need to create one manually via BuildArtifacts.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #secondaryArtifacts(List).

        Parameters:
        secondaryArtifacts - a consumer that will call methods on BuildArtifacts.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #secondaryArtifacts(java.util.Collection)

      • cache

        BuildBatch.Builder cache​(ProjectCache cache)
        Sets the value of the Cache property for this object.
        Parameters:
        cache - The new value for the Cache property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environment

        BuildBatch.Builder environment​(ProjectEnvironment environment)
        Sets the value of the Environment property for this object.
        Parameters:
        environment - The new value for the Environment property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceRole

        BuildBatch.Builder serviceRole​(String serviceRole)

        The name of a service role used for builds in the batch.

        Parameters:
        serviceRole - The name of a service role used for builds in the batch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logConfig

        BuildBatch.Builder logConfig​(LogsConfig logConfig)
        Sets the value of the LogConfig property for this object.
        Parameters:
        logConfig - The new value for the LogConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildTimeoutInMinutes

        BuildBatch.Builder buildTimeoutInMinutes​(Integer buildTimeoutInMinutes)

        Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

        Parameters:
        buildTimeoutInMinutes - Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queuedTimeoutInMinutes

        BuildBatch.Builder queuedTimeoutInMinutes​(Integer queuedTimeoutInMinutes)

        Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

        Parameters:
        queuedTimeoutInMinutes - Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • complete

        BuildBatch.Builder complete​(Boolean complete)

        Indicates if the batch build is complete.

        Parameters:
        complete - Indicates if the batch build is complete.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • initiator

        BuildBatch.Builder initiator​(String initiator)

        The entity that started the batch build. Valid values include:

        • If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

        • If a user started the build, the user's name.

        • If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

        Parameters:
        initiator - The entity that started the batch build. Valid values include:

        • If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

        • If a user started the build, the user's name.

        • If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcConfig

        BuildBatch.Builder vpcConfig​(VpcConfig vpcConfig)
        Sets the value of the VpcConfig property for this object.
        Parameters:
        vpcConfig - The new value for the VpcConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encryptionKey

        BuildBatch.Builder encryptionKey​(String encryptionKey)

        The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.

        You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

        You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

        Parameters:
        encryptionKey - The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.

        You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

        You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildBatchNumber

        BuildBatch.Builder buildBatchNumber​(Long buildBatchNumber)

        The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.

        Parameters:
        buildBatchNumber - The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fileSystemLocations

        BuildBatch.Builder fileSystemLocations​(Collection<ProjectFileSystemLocation> fileSystemLocations)

        An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

        Parameters:
        fileSystemLocations - An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fileSystemLocations

        BuildBatch.Builder fileSystemLocations​(ProjectFileSystemLocation... fileSystemLocations)

        An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

        Parameters:
        fileSystemLocations - An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildBatchConfig

        BuildBatch.Builder buildBatchConfig​(ProjectBuildBatchConfig buildBatchConfig)
        Sets the value of the BuildBatchConfig property for this object.
        Parameters:
        buildBatchConfig - The new value for the BuildBatchConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildGroups

        BuildBatch.Builder buildGroups​(Collection<BuildGroup> buildGroups)

        An array of BuildGroup objects that define the build groups for the batch build.

        Parameters:
        buildGroups - An array of BuildGroup objects that define the build groups for the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildGroups

        BuildBatch.Builder buildGroups​(BuildGroup... buildGroups)

        An array of BuildGroup objects that define the build groups for the batch build.

        Parameters:
        buildGroups - An array of BuildGroup objects that define the build groups for the batch build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildGroups

        BuildBatch.Builder buildGroups​(Consumer<BuildGroup.Builder>... buildGroups)

        An array of BuildGroup objects that define the build groups for the batch build.

        This is a convenience method that creates an instance of the BuildGroup.Builder avoiding the need to create one manually via BuildGroup.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #buildGroups(List).

        Parameters:
        buildGroups - a consumer that will call methods on BuildGroup.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #buildGroups(java.util.Collection)

      • debugSessionEnabled

        BuildBatch.Builder debugSessionEnabled​(Boolean debugSessionEnabled)

        Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

        Parameters:
        debugSessionEnabled - Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.