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

Interface ProjectArtifacts.Builder

All Superinterfaces:

CopyableBuilder<ProjectArtifacts.Builder,ProjectArtifacts>, SdkBuilder<ProjectArtifacts.Builder,ProjectArtifacts>

Enclosing class:

ProjectArtifacts

public static interface ProjectArtifacts.Builder
extends CopyableBuilder<ProjectArtifacts.Builder,ProjectArtifacts>

Method Summary

Modifier and Type	Method	Description
ProjectArtifacts.Builder	location(String location)	Information about the build output artifact location, as follows:
ProjectArtifacts.Builder	name(String name)	Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
ProjectArtifacts.Builder	namespaceType(String namespaceType)	Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
ProjectArtifacts.Builder	namespaceType(ArtifactNamespace namespaceType)	Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
ProjectArtifacts.Builder	packaging(String packaging)	The type of build output artifact to create, as follows:
ProjectArtifacts.Builder	packaging(ArtifactPackaging packaging)	The type of build output artifact to create, as follows:
ProjectArtifacts.Builder	path(String path)	Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
ProjectArtifacts.Builder	type(String type)	The type of build output artifact.
ProjectArtifacts.Builder	type(ArtifactsType type)	The type of build output artifact.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

type

ProjectArtifacts.Builder type(String type)

The type of build output artifact. Valid values include:

• CODEPIPELINE: The build project will have build output generated through AWS CodePipeline.

• NO_ARTIFACTS: The build project will not produce any build output.

• S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).

Parameters:

type - The type of build output artifact. Valid values include:

• CODEPIPELINE: The build project will have build output generated through AWS CodePipeline.

• NO_ARTIFACTS: The build project will not produce any build output.

• S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).

Returns:

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

See Also:

ArtifactsType

type

ProjectArtifacts.Builder type(ArtifactsType type)

The type of build output artifact. Valid values include:

• CODEPIPELINE: The build project will have build output generated through AWS CodePipeline.

• NO_ARTIFACTS: The build project will not produce any build output.

• S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).

Parameters:

type - The type of build output artifact. Valid values include:

• CODEPIPELINE: The build project will have build output generated through AWS CodePipeline.

• NO_ARTIFACTS: The build project will not produce any build output.

• S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).

Returns:

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

See Also:

ArtifactsType

location

ProjectArtifacts.Builder location(String location)

Information about the build output artifact location, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, this is the name of the output bucket.

Parameters:

location - Information about the build output artifact location, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, this is the name of the output bucket.

Returns:

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

path

ProjectArtifacts.Builder path(String path)

Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, this is the path to the output artifact. If path is not specified, then path will not be used.

For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip.

Parameters:

path - Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, this is the path to the output artifact. If path is not specified, then path will not be used.

For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip.

Returns:

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

namespaceType

ProjectArtifacts.Builder namespaceType(String namespaceType)

Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, then valid values include:

  • BUILD_ID: Include the build ID in the location of the build output artifact.

  • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Parameters:

namespaceType - Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, then valid values include:

  • BUILD_ID: Include the build ID in the location of the build output artifact.

  • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Returns:

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

See Also:

ArtifactNamespace

namespaceType

ProjectArtifacts.Builder namespaceType(ArtifactNamespace namespaceType)

Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, then valid values include:

  • BUILD_ID: Include the build ID in the location of the build output artifact.

  • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Parameters:

namespaceType - Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, then valid values include:

  • BUILD_ID: Include the build ID in the location of the build output artifact.

  • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Returns:

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

See Also:

ArtifactNamespace

name

ProjectArtifacts.Builder name(String name)

Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, this is the name of the output artifact object.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Parameters:

name - Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, this is the name of the output artifact object.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Returns:

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

packaging

ProjectArtifacts.Builder packaging(String packaging)

The type of build output artifact to create, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, valid values include:

  • NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.

  • ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

Parameters:

packaging - The type of build output artifact to create, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, valid values include:

  • NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.

  • ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

Returns:

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

See Also:

ArtifactPackaging

packaging

ProjectArtifacts.Builder packaging(ArtifactPackaging packaging)

The type of build output artifact to create, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, valid values include:

  • NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.

  • ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

Parameters:

packaging - The type of build output artifact to create, as follows:

• If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.

• If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

• If type is set to S3, valid values include:

  • NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.

  • ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

Returns:

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

See Also:

ArtifactPackaging