commonMain.aws.sdk.kotlin.services.codebuild.model.Project.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of codebuild-jvm Show documentation
Show all versions of codebuild-jvm Show documentation
The AWS SDK for Kotlin client for CodeBuild
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.codebuild.model
import aws.smithy.kotlin.runtime.time.Instant
/**
* Information about a build project.
*/
class Project private constructor(builder: Builder) {
/**
* The Amazon Resource Name (ARN) of the build project.
*/
val arn: kotlin.String? = builder.arn
/**
* Information about the build output artifacts for the build project.
*/
val artifacts: aws.sdk.kotlin.services.codebuild.model.ProjectArtifacts? = builder.artifacts
/**
* Information about the build badge for the build project.
*/
val badge: aws.sdk.kotlin.services.codebuild.model.ProjectBadge? = builder.badge
/**
* A ProjectBuildBatchConfig object that defines the batch build options for the project.
*/
val buildBatchConfig: aws.sdk.kotlin.services.codebuild.model.ProjectBuildBatchConfig? = builder.buildBatchConfig
/**
* Information about the cache for the build project.
*/
val cache: aws.sdk.kotlin.services.codebuild.model.ProjectCache? = builder.cache
/**
* The maximum number of concurrent builds that are allowed for this project.
*
* New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
*/
val concurrentBuildLimit: kotlin.Int? = builder.concurrentBuildLimit
/**
* When the build project was created, expressed in Unix time format.
*/
val created: aws.smithy.kotlin.runtime.time.Instant? = builder.created
/**
* A description that makes the build project easy to identify.
*/
val description: kotlin.String? = builder.description
/**
* The Key Management Service 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/`). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).
*/
val encryptionKey: kotlin.String? = builder.encryptionKey
/**
* Information about the build environment for this build project.
*/
val environment: aws.sdk.kotlin.services.codebuild.model.ProjectEnvironment? = builder.environment
/**
* 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.
*/
val fileSystemLocations: List? = builder.fileSystemLocations
/**
* When the build project's settings were last modified, expressed in Unix time format.
*/
val lastModified: aws.smithy.kotlin.runtime.time.Instant? = builder.lastModified
/**
* Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
*/
val logsConfig: aws.sdk.kotlin.services.codebuild.model.LogsConfig? = builder.logsConfig
/**
* The name of the build project.
*/
val name: kotlin.String? = builder.name
/**
* Specifies the visibility of the project's builds. Possible values are:
*
* ## PUBLIC_READ
* The project builds are visible to the public.
*
* ## PRIVATE
* The project builds are not visible to the public.
*/
val projectVisibility: aws.sdk.kotlin.services.codebuild.model.ProjectVisibilityType? = builder.projectVisibility
/**
* Contains the project identifier used with the public build APIs.
*/
val publicProjectAlias: kotlin.String? = builder.publicProjectAlias
/**
* The number of minutes a build is allowed to be queued before it times out.
*/
val queuedTimeoutInMinutes: kotlin.Int? = builder.queuedTimeoutInMinutes
/**
* The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
*/
val resourceAccessRole: kotlin.String? = builder.resourceAccessRole
/**
* An array of `ProjectArtifacts` objects.
*/
val secondaryArtifacts: List? = builder.secondaryArtifacts
/**
* An array of `ProjectSourceVersion` objects. If `secondarySourceVersions` is specified at the build level, then they take over these `secondarySourceVersions` (at the project level).
*/
val secondarySourceVersions: List? = builder.secondarySourceVersions
/**
* An array of `ProjectSource` objects.
*/
val secondarySources: List? = builder.secondarySources
/**
* The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
*/
val serviceRole: kotlin.String? = builder.serviceRole
/**
* Information about the build input source code for this build project.
*/
val source: aws.sdk.kotlin.services.codebuild.model.ProjectSource? = builder.source
/**
* 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 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.
*
* 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](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the *CodeBuild User Guide*.
*/
val sourceVersion: kotlin.String? = builder.sourceVersion
/**
* A list of tag key and value pairs associated with this build project.
*
* These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
*/
val tags: List? = builder.tags
/**
* How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
*/
val timeoutInMinutes: kotlin.Int? = builder.timeoutInMinutes
/**
* Information about the VPC configuration that CodeBuild accesses.
*/
val vpcConfig: aws.sdk.kotlin.services.codebuild.model.VpcConfig? = builder.vpcConfig
/**
* Information about a webhook that connects repository events to a build project in CodeBuild.
*/
val webhook: aws.sdk.kotlin.services.codebuild.model.Webhook? = builder.webhook
companion object {
operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.codebuild.model.Project = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("Project(")
append("arn=$arn,")
append("artifacts=$artifacts,")
append("badge=$badge,")
append("buildBatchConfig=$buildBatchConfig,")
append("cache=$cache,")
append("concurrentBuildLimit=$concurrentBuildLimit,")
append("created=$created,")
append("description=$description,")
append("encryptionKey=$encryptionKey,")
append("environment=$environment,")
append("fileSystemLocations=$fileSystemLocations,")
append("lastModified=$lastModified,")
append("logsConfig=$logsConfig,")
append("name=$name,")
append("projectVisibility=$projectVisibility,")
append("publicProjectAlias=$publicProjectAlias,")
append("queuedTimeoutInMinutes=$queuedTimeoutInMinutes,")
append("resourceAccessRole=$resourceAccessRole,")
append("secondaryArtifacts=$secondaryArtifacts,")
append("secondarySourceVersions=$secondarySourceVersions,")
append("secondarySources=$secondarySources,")
append("serviceRole=$serviceRole,")
append("source=$source,")
append("sourceVersion=$sourceVersion,")
append("tags=$tags,")
append("timeoutInMinutes=$timeoutInMinutes,")
append("vpcConfig=$vpcConfig,")
append("webhook=$webhook)")
}
override fun hashCode(): kotlin.Int {
var result = arn?.hashCode() ?: 0
result = 31 * result + (artifacts?.hashCode() ?: 0)
result = 31 * result + (badge?.hashCode() ?: 0)
result = 31 * result + (buildBatchConfig?.hashCode() ?: 0)
result = 31 * result + (cache?.hashCode() ?: 0)
result = 31 * result + (concurrentBuildLimit ?: 0)
result = 31 * result + (created?.hashCode() ?: 0)
result = 31 * result + (description?.hashCode() ?: 0)
result = 31 * result + (encryptionKey?.hashCode() ?: 0)
result = 31 * result + (environment?.hashCode() ?: 0)
result = 31 * result + (fileSystemLocations?.hashCode() ?: 0)
result = 31 * result + (lastModified?.hashCode() ?: 0)
result = 31 * result + (logsConfig?.hashCode() ?: 0)
result = 31 * result + (name?.hashCode() ?: 0)
result = 31 * result + (projectVisibility?.hashCode() ?: 0)
result = 31 * result + (publicProjectAlias?.hashCode() ?: 0)
result = 31 * result + (queuedTimeoutInMinutes ?: 0)
result = 31 * result + (resourceAccessRole?.hashCode() ?: 0)
result = 31 * result + (secondaryArtifacts?.hashCode() ?: 0)
result = 31 * result + (secondarySourceVersions?.hashCode() ?: 0)
result = 31 * result + (secondarySources?.hashCode() ?: 0)
result = 31 * result + (serviceRole?.hashCode() ?: 0)
result = 31 * result + (source?.hashCode() ?: 0)
result = 31 * result + (sourceVersion?.hashCode() ?: 0)
result = 31 * result + (tags?.hashCode() ?: 0)
result = 31 * result + (timeoutInMinutes ?: 0)
result = 31 * result + (vpcConfig?.hashCode() ?: 0)
result = 31 * result + (webhook?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as Project
if (arn != other.arn) return false
if (artifacts != other.artifacts) return false
if (badge != other.badge) return false
if (buildBatchConfig != other.buildBatchConfig) return false
if (cache != other.cache) return false
if (concurrentBuildLimit != other.concurrentBuildLimit) return false
if (created != other.created) return false
if (description != other.description) return false
if (encryptionKey != other.encryptionKey) return false
if (environment != other.environment) return false
if (fileSystemLocations != other.fileSystemLocations) return false
if (lastModified != other.lastModified) return false
if (logsConfig != other.logsConfig) return false
if (name != other.name) return false
if (projectVisibility != other.projectVisibility) return false
if (publicProjectAlias != other.publicProjectAlias) return false
if (queuedTimeoutInMinutes != other.queuedTimeoutInMinutes) return false
if (resourceAccessRole != other.resourceAccessRole) return false
if (secondaryArtifacts != other.secondaryArtifacts) return false
if (secondarySourceVersions != other.secondarySourceVersions) return false
if (secondarySources != other.secondarySources) return false
if (serviceRole != other.serviceRole) return false
if (source != other.source) return false
if (sourceVersion != other.sourceVersion) return false
if (tags != other.tags) return false
if (timeoutInMinutes != other.timeoutInMinutes) return false
if (vpcConfig != other.vpcConfig) return false
if (webhook != other.webhook) return false
return true
}
inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.codebuild.model.Project = Builder(this).apply(block).build()
class Builder {
/**
* The Amazon Resource Name (ARN) of the build project.
*/
var arn: kotlin.String? = null
/**
* Information about the build output artifacts for the build project.
*/
var artifacts: aws.sdk.kotlin.services.codebuild.model.ProjectArtifacts? = null
/**
* Information about the build badge for the build project.
*/
var badge: aws.sdk.kotlin.services.codebuild.model.ProjectBadge? = null
/**
* A ProjectBuildBatchConfig object that defines the batch build options for the project.
*/
var buildBatchConfig: aws.sdk.kotlin.services.codebuild.model.ProjectBuildBatchConfig? = null
/**
* Information about the cache for the build project.
*/
var cache: aws.sdk.kotlin.services.codebuild.model.ProjectCache? = null
/**
* The maximum number of concurrent builds that are allowed for this project.
*
* New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
*/
var concurrentBuildLimit: kotlin.Int? = null
/**
* When the build project was created, expressed in Unix time format.
*/
var created: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* A description that makes the build project easy to identify.
*/
var description: kotlin.String? = null
/**
* The Key Management Service 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/`). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).
*/
var encryptionKey: kotlin.String? = null
/**
* Information about the build environment for this build project.
*/
var environment: aws.sdk.kotlin.services.codebuild.model.ProjectEnvironment? = null
/**
* 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.
*/
var fileSystemLocations: List? = null
/**
* When the build project's settings were last modified, expressed in Unix time format.
*/
var lastModified: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
*/
var logsConfig: aws.sdk.kotlin.services.codebuild.model.LogsConfig? = null
/**
* The name of the build project.
*/
var name: kotlin.String? = null
/**
* Specifies the visibility of the project's builds. Possible values are:
*
* ## PUBLIC_READ
* The project builds are visible to the public.
*
* ## PRIVATE
* The project builds are not visible to the public.
*/
var projectVisibility: aws.sdk.kotlin.services.codebuild.model.ProjectVisibilityType? = null
/**
* Contains the project identifier used with the public build APIs.
*/
var publicProjectAlias: kotlin.String? = null
/**
* The number of minutes a build is allowed to be queued before it times out.
*/
var queuedTimeoutInMinutes: kotlin.Int? = null
/**
* The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
*/
var resourceAccessRole: kotlin.String? = null
/**
* An array of `ProjectArtifacts` objects.
*/
var secondaryArtifacts: List? = null
/**
* An array of `ProjectSourceVersion` objects. If `secondarySourceVersions` is specified at the build level, then they take over these `secondarySourceVersions` (at the project level).
*/
var secondarySourceVersions: List? = null
/**
* An array of `ProjectSource` objects.
*/
var secondarySources: List? = null
/**
* The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
*/
var serviceRole: kotlin.String? = null
/**
* Information about the build input source code for this build project.
*/
var source: aws.sdk.kotlin.services.codebuild.model.ProjectSource? = null
/**
* 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 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.
*
* 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](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the *CodeBuild User Guide*.
*/
var sourceVersion: kotlin.String? = null
/**
* A list of tag key and value pairs associated with this build project.
*
* These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
*/
var tags: List? = null
/**
* How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
*/
var timeoutInMinutes: kotlin.Int? = null
/**
* Information about the VPC configuration that CodeBuild accesses.
*/
var vpcConfig: aws.sdk.kotlin.services.codebuild.model.VpcConfig? = null
/**
* Information about a webhook that connects repository events to a build project in CodeBuild.
*/
var webhook: aws.sdk.kotlin.services.codebuild.model.Webhook? = null
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.codebuild.model.Project) : this() {
this.arn = x.arn
this.artifacts = x.artifacts
this.badge = x.badge
this.buildBatchConfig = x.buildBatchConfig
this.cache = x.cache
this.concurrentBuildLimit = x.concurrentBuildLimit
this.created = x.created
this.description = x.description
this.encryptionKey = x.encryptionKey
this.environment = x.environment
this.fileSystemLocations = x.fileSystemLocations
this.lastModified = x.lastModified
this.logsConfig = x.logsConfig
this.name = x.name
this.projectVisibility = x.projectVisibility
this.publicProjectAlias = x.publicProjectAlias
this.queuedTimeoutInMinutes = x.queuedTimeoutInMinutes
this.resourceAccessRole = x.resourceAccessRole
this.secondaryArtifacts = x.secondaryArtifacts
this.secondarySourceVersions = x.secondarySourceVersions
this.secondarySources = x.secondarySources
this.serviceRole = x.serviceRole
this.source = x.source
this.sourceVersion = x.sourceVersion
this.tags = x.tags
this.timeoutInMinutes = x.timeoutInMinutes
this.vpcConfig = x.vpcConfig
this.webhook = x.webhook
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.codebuild.model.Project = Project(this)
/**
* construct an [aws.sdk.kotlin.services.codebuild.model.ProjectArtifacts] inside the given [block]
*/
fun artifacts(block: aws.sdk.kotlin.services.codebuild.model.ProjectArtifacts.Builder.() -> kotlin.Unit) {
this.artifacts = aws.sdk.kotlin.services.codebuild.model.ProjectArtifacts.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.codebuild.model.ProjectBadge] inside the given [block]
*/
fun badge(block: aws.sdk.kotlin.services.codebuild.model.ProjectBadge.Builder.() -> kotlin.Unit) {
this.badge = aws.sdk.kotlin.services.codebuild.model.ProjectBadge.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.codebuild.model.ProjectBuildBatchConfig] inside the given [block]
*/
fun buildBatchConfig(block: aws.sdk.kotlin.services.codebuild.model.ProjectBuildBatchConfig.Builder.() -> kotlin.Unit) {
this.buildBatchConfig = aws.sdk.kotlin.services.codebuild.model.ProjectBuildBatchConfig.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.codebuild.model.ProjectCache] inside the given [block]
*/
fun cache(block: aws.sdk.kotlin.services.codebuild.model.ProjectCache.Builder.() -> kotlin.Unit) {
this.cache = aws.sdk.kotlin.services.codebuild.model.ProjectCache.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.codebuild.model.ProjectEnvironment] inside the given [block]
*/
fun environment(block: aws.sdk.kotlin.services.codebuild.model.ProjectEnvironment.Builder.() -> kotlin.Unit) {
this.environment = aws.sdk.kotlin.services.codebuild.model.ProjectEnvironment.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.codebuild.model.LogsConfig] inside the given [block]
*/
fun logsConfig(block: aws.sdk.kotlin.services.codebuild.model.LogsConfig.Builder.() -> kotlin.Unit) {
this.logsConfig = aws.sdk.kotlin.services.codebuild.model.LogsConfig.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.codebuild.model.ProjectSource] inside the given [block]
*/
fun source(block: aws.sdk.kotlin.services.codebuild.model.ProjectSource.Builder.() -> kotlin.Unit) {
this.source = aws.sdk.kotlin.services.codebuild.model.ProjectSource.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.codebuild.model.VpcConfig] inside the given [block]
*/
fun vpcConfig(block: aws.sdk.kotlin.services.codebuild.model.VpcConfig.Builder.() -> kotlin.Unit) {
this.vpcConfig = aws.sdk.kotlin.services.codebuild.model.VpcConfig.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.codebuild.model.Webhook] inside the given [block]
*/
fun webhook(block: aws.sdk.kotlin.services.codebuild.model.Webhook.Builder.() -> kotlin.Unit) {
this.webhook = aws.sdk.kotlin.services.codebuild.model.Webhook.invoke(block)
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy