software.amazon.awssdk.services.codebuild.model

Class Project

java.lang.Object

software.amazon.awssdk.services.codebuild.model.Project

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Project.Builder,Project>

@Generated(value="software.amazon.awssdk:codegen")
public final class Project
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Project.Builder,Project>

Information about a build project.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Project.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the build project.
ProjectArtifacts	artifacts() Information about the build output artifacts for the build project.
ProjectBadge	badge() Information about the build badge for the build project.
ProjectBuildBatchConfig	buildBatchConfig() A ProjectBuildBatchConfig object that defines the batch build options for the project.
static Project.Builder	builder()
ProjectCache	cache() Information about the cache for the build project.
Instant	created() When the build project was created, expressed in Unix time format.
String	description() A description that makes the build project easy to identify.
String	encryptionKey() The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
ProjectEnvironment	environment() Information about the build environment for this build project.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<ProjectFileSystemLocation>	fileSystemLocations() An array of ProjectFileSystemLocation objects for a CodeBuild build project.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFileSystemLocations() Returns true if the FileSystemLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasSecondaryArtifacts() Returns true if the SecondaryArtifacts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSecondarySources() Returns true if the SecondarySources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSecondarySourceVersions() Returns true if the SecondarySourceVersions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Instant	lastModified() When the build project's settings were last modified, expressed in Unix time format.
LogsConfig	logsConfig() Information about logs for the build project.
String	name() The name of the build project.
Integer	queuedTimeoutInMinutes() The number of minutes a build is allowed to be queued before it times out.
List<SdkField<?>>	sdkFields()
List<ProjectArtifacts>	secondaryArtifacts() An array of ProjectArtifacts objects.
List<ProjectSource>	secondarySources() An array of ProjectSource objects.
List<ProjectSourceVersion>	secondarySourceVersions() An array of ProjectSourceVersion objects.
static Class<? extends Project.Builder>	serializableBuilderClass()
String	serviceRole() The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
ProjectSource	source() Information about the build input source code for this build project.
String	sourceVersion() A version of the build input to be built for this project.
List<Tag>	tags() A list of tag key and value pairs associated with this build project.
Integer	timeoutInMinutes() How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
Project.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
VpcConfig	vpcConfig() Information about the VPC configuration that AWS CodeBuild accesses.
Webhook	webhook() Information about a webhook that connects repository events to a build project in AWS CodeBuild.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name of the build project.

Returns:

The name of the build project.

arn

public final String arn()

The Amazon Resource Name (ARN) of the build project.

Returns:

The Amazon Resource Name (ARN) of the build project.

description

public final String description()

A description that makes the build project easy to identify.

Returns:

A description that makes the build project easy to identify.

source

public final ProjectSource source()

Information about the build input source code for this build project.

Returns:

Information about the build input source code for this build project.

hasSecondarySources

public final boolean hasSecondarySources()

Returns true if the SecondarySources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

secondarySources

public final List<ProjectSource> secondarySources()

An array of ProjectSource objects.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSecondarySources() to see if a value was sent in this field.

Returns:

An array of ProjectSource objects.

sourceVersion

public final String sourceVersion()

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

• For AWS 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Returns:

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

• For AWS 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

hasSecondarySourceVersions

public final boolean hasSecondarySourceVersions()

Returns true if the SecondarySourceVersions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

secondarySourceVersions

public final List<ProjectSourceVersion> secondarySourceVersions()

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSecondarySourceVersions() to see if a value was sent in this field.

Returns:

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

artifacts

public final ProjectArtifacts artifacts()

Information about the build output artifacts for the build project.

Returns:

Information about the build output artifacts for the build project.

hasSecondaryArtifacts

public final boolean hasSecondaryArtifacts()

Returns true if the SecondaryArtifacts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

secondaryArtifacts

public final List<ProjectArtifacts> secondaryArtifacts()

An array of ProjectArtifacts objects.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSecondaryArtifacts() to see if a value was sent in this field.

Returns:

An array of ProjectArtifacts objects.

cache

public final ProjectCache cache()

Information about the cache for the build project.

Returns:

Information about the cache for the build project.

environment

public final ProjectEnvironment environment()

Information about the build environment for this build project.

Returns:

Information about the build environment for this build project.

serviceRole

public final String serviceRole()

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

Returns:

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

timeoutInMinutes

public final Integer timeoutInMinutes()

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

Returns:

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

queuedTimeoutInMinutes

public final Integer queuedTimeoutInMinutes()

The number of minutes a build is allowed to be queued before it times out.

Returns:

The number of minutes a build is allowed to be queued before it times out.

encryptionKey

public final String encryptionKey()

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the 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:

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the 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>).

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

A list of tag key and value pairs associated with this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

A list of tag key and value pairs associated with this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

created

public final Instant created()

When the build project was created, expressed in Unix time format.

Returns:

When the build project was created, expressed in Unix time format.

lastModified

public final Instant lastModified()

When the build project's settings were last modified, expressed in Unix time format.

Returns:

When the build project's settings were last modified, expressed in Unix time format.

webhook

public final Webhook webhook()

Information about a webhook that connects repository events to a build project in AWS CodeBuild.

Returns:

Information about a webhook that connects repository events to a build project in AWS CodeBuild.

vpcConfig

public final VpcConfig vpcConfig()

Information about the VPC configuration that AWS CodeBuild accesses.

Returns:

Information about the VPC configuration that AWS CodeBuild accesses.

badge

public final ProjectBadge badge()

Information about the build badge for the build project.

Returns:

Information about the build badge for the build project.

logsConfig

public final LogsConfig logsConfig()

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.

Returns:

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.

hasFileSystemLocations

public final boolean hasFileSystemLocations()

Returns true if the FileSystemLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

fileSystemLocations

public final List<ProjectFileSystemLocation> fileSystemLocations()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFileSystemLocations() to see if a value was sent in this field.

Returns:

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

buildBatchConfig

public final ProjectBuildBatchConfig buildBatchConfig()

A ProjectBuildBatchConfig object that defines the batch build options for the project.

Returns:

A ProjectBuildBatchConfig object that defines the batch build options for the project.

toBuilder

public Project.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Project.Builder,Project>

Returns:

a builder for type T

builder

public static Project.Builder builder()

serializableBuilderClass

public static Class<? extends Project.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.