Class UpdateProjectRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateProjectRequest.Builder,
UpdateProjectRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ProjectArtifacts
Information to be changed about the build output artifacts for the build project.final Boolean
Set this to true to generate a publicly accessible URL for your project's build badge.final ProjectBuildBatchConfig
Returns the value of the BuildBatchConfig property for this object.static UpdateProjectRequest.Builder
builder()
final ProjectCache
cache()
Stores recently used information so that it can be quickly accessed at a later time.final Integer
The maximum number of concurrent builds that are allowed for this project.final String
A new or replacement description of the build project.final String
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.final ProjectEnvironment
Information to be changed about the build environment for the build project.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<ProjectFileSystemLocation> An array ofProjectFileSystemLocation
objects for a CodeBuild build project.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the FileSystemLocations property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecondaryArtifacts property.final boolean
For responses, this returns true if the service returned a value for the SecondarySources property.final boolean
For responses, this returns true if the service returned a value for the SecondarySourceVersions property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final LogsConfig
Information about logs for the build project.final String
name()
The name of the build project.final Integer
The number of minutes a build is allowed to be queued before it times out.final List
<ProjectArtifacts> An array ofProjectArtifact
objects.final List
<ProjectSource> An array ofProjectSource
objects.final List
<ProjectSourceVersion> An array ofProjectSourceVersion
objects.static Class
<? extends UpdateProjectRequest.Builder> final String
The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.final ProjectSource
source()
Information to be changed about the build input source code for the build project.final String
A version of the build input to be built for this project.tags()
An updated list of tag key and value pairs associated with this build project.final Integer
The replacement value 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.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final VpcConfig
VpcConfig enables CodeBuild to access resources in an Amazon VPC.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the build project.
You cannot change a build project's name.
- Returns:
- The name of the build project.
You cannot change a build project's name.
-
description
A new or replacement description of the build project.
- Returns:
- A new or replacement description of the build project.
-
source
Information to be changed about the build input source code for the build project.
- Returns:
- Information to be changed about the build input source code for the build project.
-
hasSecondarySources
public final boolean hasSecondarySources()For responses, this returns true if the service returned a value for the SecondarySources property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secondarySources
An array of
ProjectSource
objects.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecondarySources()
method.- Returns:
- An array of
ProjectSource
objects.
-
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 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 examplepr/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 thissourceVersion
(at the project level).For more information, see Source Version Sample with CodeBuild in the 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 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 examplepr/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 thissourceVersion
(at the project level).For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
-
-
-
hasSecondarySourceVersions
public final boolean hasSecondarySourceVersions()For responses, this returns true if the service returned a value for the SecondarySourceVersions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secondarySourceVersions
An array of
ProjectSourceVersion
objects. IfsecondarySourceVersions
is specified at the build level, then they take over thesesecondarySourceVersions
(at the project level).Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecondarySourceVersions()
method.- Returns:
- An array of
ProjectSourceVersion
objects. IfsecondarySourceVersions
is specified at the build level, then they take over thesesecondarySourceVersions
(at the project level).
-
artifacts
Information to be changed about the build output artifacts for the build project.
- Returns:
- Information to be changed about the build output artifacts for the build project.
-
hasSecondaryArtifacts
public final boolean hasSecondaryArtifacts()For responses, this returns true if the service returned a value for the SecondaryArtifacts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secondaryArtifacts
An array of
ProjectArtifact
objects.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecondaryArtifacts()
method.- Returns:
- An array of
ProjectArtifact
objects.
-
cache
Stores recently used information so that it can be quickly accessed at a later time.
- Returns:
- Stores recently used information so that it can be quickly accessed at a later time.
-
environment
Information to be changed about the build environment for the build project.
- Returns:
- Information to be changed about the build environment for the build project.
-
serviceRole
The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
- Returns:
- The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
-
timeoutInMinutes
The replacement value 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.
- Returns:
- The replacement value 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.
-
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
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/<alias-name>
).- Returns:
- 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/<alias-name>
).
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
An updated 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- An updated 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.
-
vpcConfig
VpcConfig enables CodeBuild to access resources in an Amazon VPC.
- Returns:
- VpcConfig enables CodeBuild to access resources in an Amazon VPC.
-
badgeEnabled
Set this to true to generate a publicly accessible URL for your project's build badge.
- Returns:
- Set this to true to generate a publicly accessible URL for your project's build badge.
-
logsConfig
Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.
- Returns:
- Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.
-
hasFileSystemLocations
public final boolean hasFileSystemLocations()For responses, this returns true if the service returned a value for the FileSystemLocations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
fileSystemLocations
An array of
ProjectFileSystemLocation
objects for a CodeBuild build project. AProjectFileSystemLocation
object specifies theidentifier
,location
,mountOptions
,mountPoint
, andtype
of a file system created using Amazon Elastic File System.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFileSystemLocations()
method.- Returns:
- An array of
ProjectFileSystemLocation
objects for a CodeBuild build project. AProjectFileSystemLocation
object specifies theidentifier
,location
,mountOptions
,mountPoint
, andtype
of a file system created using Amazon Elastic File System.
-
buildBatchConfig
Returns the value of the BuildBatchConfig property for this object.- Returns:
- The value of the BuildBatchConfig property for this object.
-
concurrentBuildLimit
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.
To remove this limit, set this value to -1.
- Returns:
- 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.
To remove this limit, set this value to -1.
-
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 interfaceToCopyableBuilder<UpdateProjectRequest.Builder,
UpdateProjectRequest> - Specified by:
toBuilder
in classCodeBuildRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-