/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.codebuild.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StartBuildRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the CodeBuild build project to start running a build. *
*/ private String projectName; /** *
* An array of ProjectSource
objects.
*
* An array of ProjectSourceVersion
objects that specify one or more versions of the project's
* secondary sources to be used for this build only.
*
* The version of the build input to be built, for this build only. If not specified, the latest version is used. If * specified, the contents depends on the source provider: *
** The commit ID, branch, or Git tag to use. *
*
* 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.
*
* 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. *
** The version ID of the object that represents the build input ZIP file to use. *
*
* If sourceVersion
is specified at the project level, then this sourceVersion
(at the
* build level) takes precedence.
*
* For more information, see Source Version Sample * with CodeBuild in the CodeBuild User Guide. *
*/ private String sourceVersion; /** ** Build output artifact settings that override, for this build only, the latest ones already defined in the build * project. *
*/ private ProjectArtifacts artifactsOverride; /** *
* An array of ProjectArtifacts
objects.
*
* A set of environment variables that overrides, for this build only, the latest ones already defined in the build * project. *
*/ private java.util.List* A source input type, for this build, that overrides the source input defined in the build project. *
*/ private String sourceTypeOverride; /** ** A location that overrides, for this build, the source location for the one defined in the build project. *
*/ private String sourceLocationOverride; /** ** An authorization type for this build that overrides the one defined in the build project. This override applies * only if the build project's source is BitBucket or GitHub. *
*/ private SourceAuth sourceAuthOverride; /** ** The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous * depth of history defined in the build project. *
*/ private Integer gitCloneDepthOverride; /** ** Information about the Git submodules configuration for this build of an CodeBuild build project. *
*/ private GitSubmodulesConfig gitSubmodulesConfigOverride; /** ** A buildspec file declaration that overrides, for this build only, the latest one already defined in the build * project. *
*
* If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file
* relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the path to an S3
* bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
* file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is
* not provided or is set to an empty string, the source code must contain a buildspec file in its root directory.
* For more information, see Buildspec File Name and Storage Location.
*
* Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL * setting determines whether to ignore SSL warnings while connecting to the project source code. This override * applies only if the build's source is GitHub Enterprise. *
*/ private Boolean insecureSslOverride; /** *
* Set to true to report to your source provider the status of a build's start and completion. If you use this
* option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
* invalidInputException
is thrown.
*
* To be able to report the build status to the source provider, the user associated with the source provider must * have write access to the repo. If the user does not have write access, the build status cannot be updated. For * more information, see Source * provider access in the CodeBuild User Guide. *
** The status of a build triggered by a webhook is always reported to your source provider. *
*
* Contains information that defines how the build project reports the build status to the source provider. This
* option is only used when the source provider is GITHUB
, GITHUB_ENTERPRISE
, or
* BITBUCKET
.
*
* A container type for this build that overrides the one specified in the build project. *
*/ private String environmentTypeOverride; /** ** The name of an image for this build that overrides the one specified in the build project. *
*/ private String imageOverride; /** ** The name of a compute type for this build that overrides the one specified in the build project. *
*/ private String computeTypeOverride; /** ** The name of a certificate for this build that overrides the one specified in the build project. *
*/ private String certificateOverride; /** ** A ProjectCache object specified for this build that overrides the one defined in the build project. *
*/ private ProjectCache cacheOverride; /** ** The name of a service role for this build that overrides the one specified in the build project. *
*/ private String serviceRoleOverride; /** ** Enable this flag to override privileged mode in the build project. *
*/ private Boolean privilegedModeOverride; /** ** The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest * setting already defined in the build project. *
*/ private Integer timeoutInMinutesOverride; /** ** The number of minutes a build is allowed to be queued before it times out. *
*/ private Integer queuedTimeoutInMinutesOverride; /** ** The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The * CMK key encrypts 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>
).
*
* A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is * included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same * token, but change a parameter, CodeBuild returns a parameter mismatch error. *
*/ private String idempotencyToken; /** ** Log settings for this build that override the log settings defined in the build project. *
*/ private LogsConfig logsConfigOverride; /** ** The credentials for access to a private registry. *
*/ private RegistryCredential registryCredentialOverride; /** ** The type of credentials CodeBuild uses to pull images in your build. There are two valid values: *
** Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to * trust CodeBuild's service principal. *
** Specifies that CodeBuild uses your build project's service role. *
*
* When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials. When
* using an CodeBuild curated image, you must use CODEBUILD
credentials.
*
* Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in * Session Manager. *
*/ private Boolean debugSessionEnabled; /** ** The name of the CodeBuild build project to start running a build. *
* * @param projectName * The name of the CodeBuild build project to start running a build. */ public void setProjectName(String projectName) { this.projectName = projectName; } /** ** The name of the CodeBuild build project to start running a build. *
* * @return The name of the CodeBuild build project to start running a build. */ public String getProjectName() { return this.projectName; } /** ** The name of the CodeBuild build project to start running a build. *
* * @param projectName * The name of the CodeBuild build project to start running a build. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withProjectName(String projectName) { setProjectName(projectName); return this; } /** *
* An array of ProjectSource
objects.
*
ProjectSource
objects.
*/
public java.util.List
* An array of ProjectSource
objects.
*
ProjectSource
objects.
*/
public void setSecondarySourcesOverride(java.util.Collection
* An array of ProjectSource
objects.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSecondarySourcesOverride(java.util.Collection)} or * {@link #withSecondarySourcesOverride(java.util.Collection)} if you want to override the existing values. *
* * @param secondarySourcesOverride * An array ofProjectSource
objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBuildRequest withSecondarySourcesOverride(ProjectSource... secondarySourcesOverride) {
if (this.secondarySourcesOverride == null) {
setSecondarySourcesOverride(new java.util.ArrayList
* An array of ProjectSource
objects.
*
ProjectSource
objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBuildRequest withSecondarySourcesOverride(java.util.Collection
* An array of ProjectSourceVersion
objects that specify one or more versions of the project's
* secondary sources to be used for this build only.
*
ProjectSourceVersion
objects that specify one or more versions of the project's
* secondary sources to be used for this build only.
*/
public java.util.List
* An array of ProjectSourceVersion
objects that specify one or more versions of the project's
* secondary sources to be used for this build only.
*
ProjectSourceVersion
objects that specify one or more versions of the project's
* secondary sources to be used for this build only.
*/
public void setSecondarySourcesVersionOverride(java.util.Collection
* An array of ProjectSourceVersion
objects that specify one or more versions of the project's
* secondary sources to be used for this build only.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSecondarySourcesVersionOverride(java.util.Collection)} or * {@link #withSecondarySourcesVersionOverride(java.util.Collection)} if you want to override the existing values. *
* * @param secondarySourcesVersionOverride * An array ofProjectSourceVersion
objects that specify one or more versions of the project's
* secondary sources to be used for this build only.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBuildRequest withSecondarySourcesVersionOverride(ProjectSourceVersion... secondarySourcesVersionOverride) {
if (this.secondarySourcesVersionOverride == null) {
setSecondarySourcesVersionOverride(new java.util.ArrayList
* An array of ProjectSourceVersion
objects that specify one or more versions of the project's
* secondary sources to be used for this build only.
*
ProjectSourceVersion
objects that specify one or more versions of the project's
* secondary sources to be used for this build only.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBuildRequest withSecondarySourcesVersionOverride(java.util.Collection* The version of the build input to be built, for this build only. If not specified, the latest version is used. If * specified, the contents depends on the source provider: *
** The commit ID, branch, or Git tag to use. *
*
* 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.
*
* 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. *
** The version ID of the object that represents the build input ZIP file to use. *
*
* If sourceVersion
is specified at the project level, then this sourceVersion
(at the
* build level) takes precedence.
*
* For more information, see Source Version Sample * with CodeBuild in the CodeBuild User Guide. *
* * @param sourceVersion * The version of the build input to be built, for this build only. If not specified, the latest version is * used. If specified, the contents depends on the source provider: ** The commit ID, branch, or Git tag to use. *
*
* 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.
*
* 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. *
** The version ID of the object that represents the build input ZIP file to use. *
*
* If sourceVersion
is specified at the project level, then this sourceVersion
(at
* the build level) takes precedence.
*
* For more information, see Source Version * Sample with CodeBuild in the CodeBuild User Guide. */ public void setSourceVersion(String sourceVersion) { this.sourceVersion = sourceVersion; } /** *
* The version of the build input to be built, for this build only. If not specified, the latest version is used. If * specified, the contents depends on the source provider: *
** The commit ID, branch, or Git tag to use. *
*
* 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.
*
* 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. *
** The version ID of the object that represents the build input ZIP file to use. *
*
* If sourceVersion
is specified at the project level, then this sourceVersion
(at the
* build level) takes precedence.
*
* For more information, see Source Version Sample * with CodeBuild in the CodeBuild User Guide. *
* * @return The version of the build input to be built, for this build only. If not specified, the latest version is * used. If specified, the contents depends on the source provider: ** The commit ID, branch, or Git tag to use. *
*
* 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.
*
* 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. *
** The version ID of the object that represents the build input ZIP file to use. *
*
* If sourceVersion
is specified at the project level, then this sourceVersion
(at
* the build level) takes precedence.
*
* For more information, see Source Version * Sample with CodeBuild in the CodeBuild User Guide. */ public String getSourceVersion() { return this.sourceVersion; } /** *
* The version of the build input to be built, for this build only. If not specified, the latest version is used. If * specified, the contents depends on the source provider: *
** The commit ID, branch, or Git tag to use. *
*
* 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.
*
* 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. *
** The version ID of the object that represents the build input ZIP file to use. *
*
* If sourceVersion
is specified at the project level, then this sourceVersion
(at the
* build level) takes precedence.
*
* For more information, see Source Version Sample * with CodeBuild in the CodeBuild User Guide. *
* * @param sourceVersion * The version of the build input to be built, for this build only. If not specified, the latest version is * used. If specified, the contents depends on the source provider: ** The commit ID, branch, or Git tag to use. *
*
* 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.
*
* 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. *
** The version ID of the object that represents the build input ZIP file to use. *
*
* If sourceVersion
is specified at the project level, then this sourceVersion
(at
* the build level) takes precedence.
*
* For more information, see Source Version * Sample with CodeBuild in the CodeBuild User Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withSourceVersion(String sourceVersion) { setSourceVersion(sourceVersion); return this; } /** *
* Build output artifact settings that override, for this build only, the latest ones already defined in the build * project. *
* * @param artifactsOverride * Build output artifact settings that override, for this build only, the latest ones already defined in the * build project. */ public void setArtifactsOverride(ProjectArtifacts artifactsOverride) { this.artifactsOverride = artifactsOverride; } /** ** Build output artifact settings that override, for this build only, the latest ones already defined in the build * project. *
* * @return Build output artifact settings that override, for this build only, the latest ones already defined in the * build project. */ public ProjectArtifacts getArtifactsOverride() { return this.artifactsOverride; } /** ** Build output artifact settings that override, for this build only, the latest ones already defined in the build * project. *
* * @param artifactsOverride * Build output artifact settings that override, for this build only, the latest ones already defined in the * build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withArtifactsOverride(ProjectArtifacts artifactsOverride) { setArtifactsOverride(artifactsOverride); return this; } /** *
* An array of ProjectArtifacts
objects.
*
ProjectArtifacts
objects.
*/
public java.util.List
* An array of ProjectArtifacts
objects.
*
ProjectArtifacts
objects.
*/
public void setSecondaryArtifactsOverride(java.util.Collection
* An array of ProjectArtifacts
objects.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSecondaryArtifactsOverride(java.util.Collection)} or * {@link #withSecondaryArtifactsOverride(java.util.Collection)} if you want to override the existing values. *
* * @param secondaryArtifactsOverride * An array ofProjectArtifacts
objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBuildRequest withSecondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride) {
if (this.secondaryArtifactsOverride == null) {
setSecondaryArtifactsOverride(new java.util.ArrayList
* An array of ProjectArtifacts
objects.
*
ProjectArtifacts
objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBuildRequest withSecondaryArtifactsOverride(java.util.Collection* A set of environment variables that overrides, for this build only, the latest ones already defined in the build * project. *
* * @return A set of environment variables that overrides, for this build only, the latest ones already defined in * the build project. */ public java.util.List* A set of environment variables that overrides, for this build only, the latest ones already defined in the build * project. *
* * @param environmentVariablesOverride * A set of environment variables that overrides, for this build only, the latest ones already defined in the * build project. */ public void setEnvironmentVariablesOverride(java.util.Collection* A set of environment variables that overrides, for this build only, the latest ones already defined in the build * project. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setEnvironmentVariablesOverride(java.util.Collection)} or * {@link #withEnvironmentVariablesOverride(java.util.Collection)} if you want to override the existing values. *
* * @param environmentVariablesOverride * A set of environment variables that overrides, for this build only, the latest ones already defined in the * build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withEnvironmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride) { if (this.environmentVariablesOverride == null) { setEnvironmentVariablesOverride(new java.util.ArrayList* A set of environment variables that overrides, for this build only, the latest ones already defined in the build * project. *
* * @param environmentVariablesOverride * A set of environment variables that overrides, for this build only, the latest ones already defined in the * build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withEnvironmentVariablesOverride(java.util.Collection* A source input type, for this build, that overrides the source input defined in the build project. *
* * @param sourceTypeOverride * A source input type, for this build, that overrides the source input defined in the build project. * @see SourceType */ public void setSourceTypeOverride(String sourceTypeOverride) { this.sourceTypeOverride = sourceTypeOverride; } /** ** A source input type, for this build, that overrides the source input defined in the build project. *
* * @return A source input type, for this build, that overrides the source input defined in the build project. * @see SourceType */ public String getSourceTypeOverride() { return this.sourceTypeOverride; } /** ** A source input type, for this build, that overrides the source input defined in the build project. *
* * @param sourceTypeOverride * A source input type, for this build, that overrides the source input defined in the build project. * @return Returns a reference to this object so that method calls can be chained together. * @see SourceType */ public StartBuildRequest withSourceTypeOverride(String sourceTypeOverride) { setSourceTypeOverride(sourceTypeOverride); return this; } /** ** A source input type, for this build, that overrides the source input defined in the build project. *
* * @param sourceTypeOverride * A source input type, for this build, that overrides the source input defined in the build project. * @return Returns a reference to this object so that method calls can be chained together. * @see SourceType */ public StartBuildRequest withSourceTypeOverride(SourceType sourceTypeOverride) { this.sourceTypeOverride = sourceTypeOverride.toString(); return this; } /** ** A location that overrides, for this build, the source location for the one defined in the build project. *
* * @param sourceLocationOverride * A location that overrides, for this build, the source location for the one defined in the build project. */ public void setSourceLocationOverride(String sourceLocationOverride) { this.sourceLocationOverride = sourceLocationOverride; } /** ** A location that overrides, for this build, the source location for the one defined in the build project. *
* * @return A location that overrides, for this build, the source location for the one defined in the build project. */ public String getSourceLocationOverride() { return this.sourceLocationOverride; } /** ** A location that overrides, for this build, the source location for the one defined in the build project. *
* * @param sourceLocationOverride * A location that overrides, for this build, the source location for the one defined in the build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withSourceLocationOverride(String sourceLocationOverride) { setSourceLocationOverride(sourceLocationOverride); return this; } /** ** An authorization type for this build that overrides the one defined in the build project. This override applies * only if the build project's source is BitBucket or GitHub. *
* * @param sourceAuthOverride * An authorization type for this build that overrides the one defined in the build project. This override * applies only if the build project's source is BitBucket or GitHub. */ public void setSourceAuthOverride(SourceAuth sourceAuthOverride) { this.sourceAuthOverride = sourceAuthOverride; } /** ** An authorization type for this build that overrides the one defined in the build project. This override applies * only if the build project's source is BitBucket or GitHub. *
* * @return An authorization type for this build that overrides the one defined in the build project. This override * applies only if the build project's source is BitBucket or GitHub. */ public SourceAuth getSourceAuthOverride() { return this.sourceAuthOverride; } /** ** An authorization type for this build that overrides the one defined in the build project. This override applies * only if the build project's source is BitBucket or GitHub. *
* * @param sourceAuthOverride * An authorization type for this build that overrides the one defined in the build project. This override * applies only if the build project's source is BitBucket or GitHub. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withSourceAuthOverride(SourceAuth sourceAuthOverride) { setSourceAuthOverride(sourceAuthOverride); return this; } /** ** The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous * depth of history defined in the build project. *
* * @param gitCloneDepthOverride * The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any * previous depth of history defined in the build project. */ public void setGitCloneDepthOverride(Integer gitCloneDepthOverride) { this.gitCloneDepthOverride = gitCloneDepthOverride; } /** ** The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous * depth of history defined in the build project. *
* * @return The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any * previous depth of history defined in the build project. */ public Integer getGitCloneDepthOverride() { return this.gitCloneDepthOverride; } /** ** The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous * depth of history defined in the build project. *
* * @param gitCloneDepthOverride * The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any * previous depth of history defined in the build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withGitCloneDepthOverride(Integer gitCloneDepthOverride) { setGitCloneDepthOverride(gitCloneDepthOverride); return this; } /** ** Information about the Git submodules configuration for this build of an CodeBuild build project. *
* * @param gitSubmodulesConfigOverride * Information about the Git submodules configuration for this build of an CodeBuild build project. */ public void setGitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride) { this.gitSubmodulesConfigOverride = gitSubmodulesConfigOverride; } /** ** Information about the Git submodules configuration for this build of an CodeBuild build project. *
* * @return Information about the Git submodules configuration for this build of an CodeBuild build project. */ public GitSubmodulesConfig getGitSubmodulesConfigOverride() { return this.gitSubmodulesConfigOverride; } /** ** Information about the Git submodules configuration for this build of an CodeBuild build project. *
* * @param gitSubmodulesConfigOverride * Information about the Git submodules configuration for this build of an CodeBuild build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withGitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride) { setGitSubmodulesConfigOverride(gitSubmodulesConfigOverride); return this; } /** ** A buildspec file declaration that overrides, for this build only, the latest one already defined in the build * project. *
*
* If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file
* relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the path to an S3
* bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
* file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is
* not provided or is set to an empty string, the source code must contain a buildspec file in its root directory.
* For more information, see Buildspec File Name and Storage Location.
*
* If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec
* file relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the
* path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project.
* Specify the buildspec file using its ARN (for example,
* arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is not provided or is set to
* an empty string, the source code must contain a buildspec file in its root directory. For more
* information, see Buildspec File Name and Storage Location.
*/
public void setBuildspecOverride(String buildspecOverride) {
this.buildspecOverride = buildspecOverride;
}
/**
*
* A buildspec file declaration that overrides, for this build only, the latest one already defined in the build * project. *
*
* If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file
* relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the path to an S3
* bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
* file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is
* not provided or is set to an empty string, the source code must contain a buildspec file in its root directory.
* For more information, see Buildspec File Name and Storage Location.
*
* If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec
* file relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the
* path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project.
* Specify the buildspec file using its ARN (for example,
* arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is not provided or is set to
* an empty string, the source code must contain a buildspec file in its root directory. For more
* information, see Buildspec File Name and Storage Location.
*/
public String getBuildspecOverride() {
return this.buildspecOverride;
}
/**
*
* A buildspec file declaration that overrides, for this build only, the latest one already defined in the build * project. *
*
* If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file
* relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the path to an S3
* bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
* file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is
* not provided or is set to an empty string, the source code must contain a buildspec file in its root directory.
* For more information, see Buildspec File Name and Storage Location.
*
* If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec
* file relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the
* path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project.
* Specify the buildspec file using its ARN (for example,
* arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is not provided or is set to
* an empty string, the source code must contain a buildspec file in its root directory. For more
* information, see Buildspec File Name and Storage Location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBuildRequest withBuildspecOverride(String buildspecOverride) {
setBuildspecOverride(buildspecOverride);
return this;
}
/**
*
* Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL * setting determines whether to ignore SSL warnings while connecting to the project source code. This override * applies only if the build's source is GitHub Enterprise. *
* * @param insecureSslOverride * Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure * SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This * override applies only if the build's source is GitHub Enterprise. */ public void setInsecureSslOverride(Boolean insecureSslOverride) { this.insecureSslOverride = insecureSslOverride; } /** ** Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL * setting determines whether to ignore SSL warnings while connecting to the project source code. This override * applies only if the build's source is GitHub Enterprise. *
* * @return Enable this flag to override the insecure SSL setting that is specified in the build project. The * insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source * code. This override applies only if the build's source is GitHub Enterprise. */ public Boolean getInsecureSslOverride() { return this.insecureSslOverride; } /** ** Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL * setting determines whether to ignore SSL warnings while connecting to the project source code. This override * applies only if the build's source is GitHub Enterprise. *
* * @param insecureSslOverride * Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure * SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This * override applies only if the build's source is GitHub Enterprise. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withInsecureSslOverride(Boolean insecureSslOverride) { setInsecureSslOverride(insecureSslOverride); return this; } /** ** Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL * setting determines whether to ignore SSL warnings while connecting to the project source code. This override * applies only if the build's source is GitHub Enterprise. *
* * @return Enable this flag to override the insecure SSL setting that is specified in the build project. The * insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source * code. This override applies only if the build's source is GitHub Enterprise. */ public Boolean isInsecureSslOverride() { return this.insecureSslOverride; } /** *
* Set to true to report to your source provider the status of a build's start and completion. If you use this
* option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
* invalidInputException
is thrown.
*
* To be able to report the build status to the source provider, the user associated with the source provider must * have write access to the repo. If the user does not have write access, the build status cannot be updated. For * more information, see Source * provider access in the CodeBuild User Guide. *
** The status of a build triggered by a webhook is always reported to your source provider. *
*invalidInputException
is thrown.
* * To be able to report the build status to the source provider, the user associated with the source provider * must have write access to the repo. If the user does not have write access, the build status cannot be * updated. For more information, see Source provider * access in the CodeBuild User Guide. *
** The status of a build triggered by a webhook is always reported to your source provider. *
*/ public void setReportBuildStatusOverride(Boolean reportBuildStatusOverride) { this.reportBuildStatusOverride = reportBuildStatusOverride; } /** *
* Set to true to report to your source provider the status of a build's start and completion. If you use this
* option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
* invalidInputException
is thrown.
*
* To be able to report the build status to the source provider, the user associated with the source provider must * have write access to the repo. If the user does not have write access, the build status cannot be updated. For * more information, see Source * provider access in the CodeBuild User Guide. *
** The status of a build triggered by a webhook is always reported to your source provider. *
*invalidInputException
is thrown.
* * To be able to report the build status to the source provider, the user associated with the source * provider must have write access to the repo. If the user does not have write access, the build status * cannot be updated. For more information, see Source provider * access in the CodeBuild User Guide. *
** The status of a build triggered by a webhook is always reported to your source provider. *
*/ public Boolean getReportBuildStatusOverride() { return this.reportBuildStatusOverride; } /** *
* Set to true to report to your source provider the status of a build's start and completion. If you use this
* option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
* invalidInputException
is thrown.
*
* To be able to report the build status to the source provider, the user associated with the source provider must * have write access to the repo. If the user does not have write access, the build status cannot be updated. For * more information, see Source * provider access in the CodeBuild User Guide. *
** The status of a build triggered by a webhook is always reported to your source provider. *
*invalidInputException
is thrown.
* * To be able to report the build status to the source provider, the user associated with the source provider * must have write access to the repo. If the user does not have write access, the build status cannot be * updated. For more information, see Source provider * access in the CodeBuild User Guide. *
** The status of a build triggered by a webhook is always reported to your source provider. *
* @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withReportBuildStatusOverride(Boolean reportBuildStatusOverride) { setReportBuildStatusOverride(reportBuildStatusOverride); return this; } /** *
* Set to true to report to your source provider the status of a build's start and completion. If you use this
* option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
* invalidInputException
is thrown.
*
* To be able to report the build status to the source provider, the user associated with the source provider must * have write access to the repo. If the user does not have write access, the build status cannot be updated. For * more information, see Source * provider access in the CodeBuild User Guide. *
** The status of a build triggered by a webhook is always reported to your source provider. *
*invalidInputException
is thrown.
* * To be able to report the build status to the source provider, the user associated with the source * provider must have write access to the repo. If the user does not have write access, the build status * cannot be updated. For more information, see Source provider * access in the CodeBuild User Guide. *
** The status of a build triggered by a webhook is always reported to your source provider. *
*/ public Boolean isReportBuildStatusOverride() { return this.reportBuildStatusOverride; } /** *
* Contains information that defines how the build project reports the build status to the source provider. This
* option is only used when the source provider is GITHUB
, GITHUB_ENTERPRISE
, or
* BITBUCKET
.
*
GITHUB
, GITHUB_ENTERPRISE
,
* or BITBUCKET
.
*/
public void setBuildStatusConfigOverride(BuildStatusConfig buildStatusConfigOverride) {
this.buildStatusConfigOverride = buildStatusConfigOverride;
}
/**
*
* Contains information that defines how the build project reports the build status to the source provider. This
* option is only used when the source provider is GITHUB
, GITHUB_ENTERPRISE
, or
* BITBUCKET
.
*
GITHUB
, GITHUB_ENTERPRISE
,
* or BITBUCKET
.
*/
public BuildStatusConfig getBuildStatusConfigOverride() {
return this.buildStatusConfigOverride;
}
/**
*
* Contains information that defines how the build project reports the build status to the source provider. This
* option is only used when the source provider is GITHUB
, GITHUB_ENTERPRISE
, or
* BITBUCKET
.
*
GITHUB
, GITHUB_ENTERPRISE
,
* or BITBUCKET
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBuildRequest withBuildStatusConfigOverride(BuildStatusConfig buildStatusConfigOverride) {
setBuildStatusConfigOverride(buildStatusConfigOverride);
return this;
}
/**
* * A container type for this build that overrides the one specified in the build project. *
* * @param environmentTypeOverride * A container type for this build that overrides the one specified in the build project. * @see EnvironmentType */ public void setEnvironmentTypeOverride(String environmentTypeOverride) { this.environmentTypeOverride = environmentTypeOverride; } /** ** A container type for this build that overrides the one specified in the build project. *
* * @return A container type for this build that overrides the one specified in the build project. * @see EnvironmentType */ public String getEnvironmentTypeOverride() { return this.environmentTypeOverride; } /** ** A container type for this build that overrides the one specified in the build project. *
* * @param environmentTypeOverride * A container type for this build that overrides the one specified in the build project. * @return Returns a reference to this object so that method calls can be chained together. * @see EnvironmentType */ public StartBuildRequest withEnvironmentTypeOverride(String environmentTypeOverride) { setEnvironmentTypeOverride(environmentTypeOverride); return this; } /** ** A container type for this build that overrides the one specified in the build project. *
* * @param environmentTypeOverride * A container type for this build that overrides the one specified in the build project. * @return Returns a reference to this object so that method calls can be chained together. * @see EnvironmentType */ public StartBuildRequest withEnvironmentTypeOverride(EnvironmentType environmentTypeOverride) { this.environmentTypeOverride = environmentTypeOverride.toString(); return this; } /** ** The name of an image for this build that overrides the one specified in the build project. *
* * @param imageOverride * The name of an image for this build that overrides the one specified in the build project. */ public void setImageOverride(String imageOverride) { this.imageOverride = imageOverride; } /** ** The name of an image for this build that overrides the one specified in the build project. *
* * @return The name of an image for this build that overrides the one specified in the build project. */ public String getImageOverride() { return this.imageOverride; } /** ** The name of an image for this build that overrides the one specified in the build project. *
* * @param imageOverride * The name of an image for this build that overrides the one specified in the build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withImageOverride(String imageOverride) { setImageOverride(imageOverride); return this; } /** ** The name of a compute type for this build that overrides the one specified in the build project. *
* * @param computeTypeOverride * The name of a compute type for this build that overrides the one specified in the build project. * @see ComputeType */ public void setComputeTypeOverride(String computeTypeOverride) { this.computeTypeOverride = computeTypeOverride; } /** ** The name of a compute type for this build that overrides the one specified in the build project. *
* * @return The name of a compute type for this build that overrides the one specified in the build project. * @see ComputeType */ public String getComputeTypeOverride() { return this.computeTypeOverride; } /** ** The name of a compute type for this build that overrides the one specified in the build project. *
* * @param computeTypeOverride * The name of a compute type for this build that overrides the one specified in the build project. * @return Returns a reference to this object so that method calls can be chained together. * @see ComputeType */ public StartBuildRequest withComputeTypeOverride(String computeTypeOverride) { setComputeTypeOverride(computeTypeOverride); return this; } /** ** The name of a compute type for this build that overrides the one specified in the build project. *
* * @param computeTypeOverride * The name of a compute type for this build that overrides the one specified in the build project. * @return Returns a reference to this object so that method calls can be chained together. * @see ComputeType */ public StartBuildRequest withComputeTypeOverride(ComputeType computeTypeOverride) { this.computeTypeOverride = computeTypeOverride.toString(); return this; } /** ** The name of a certificate for this build that overrides the one specified in the build project. *
* * @param certificateOverride * The name of a certificate for this build that overrides the one specified in the build project. */ public void setCertificateOverride(String certificateOverride) { this.certificateOverride = certificateOverride; } /** ** The name of a certificate for this build that overrides the one specified in the build project. *
* * @return The name of a certificate for this build that overrides the one specified in the build project. */ public String getCertificateOverride() { return this.certificateOverride; } /** ** The name of a certificate for this build that overrides the one specified in the build project. *
* * @param certificateOverride * The name of a certificate for this build that overrides the one specified in the build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withCertificateOverride(String certificateOverride) { setCertificateOverride(certificateOverride); return this; } /** ** A ProjectCache object specified for this build that overrides the one defined in the build project. *
* * @param cacheOverride * A ProjectCache object specified for this build that overrides the one defined in the build project. */ public void setCacheOverride(ProjectCache cacheOverride) { this.cacheOverride = cacheOverride; } /** ** A ProjectCache object specified for this build that overrides the one defined in the build project. *
* * @return A ProjectCache object specified for this build that overrides the one defined in the build project. */ public ProjectCache getCacheOverride() { return this.cacheOverride; } /** ** A ProjectCache object specified for this build that overrides the one defined in the build project. *
* * @param cacheOverride * A ProjectCache object specified for this build that overrides the one defined in the build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withCacheOverride(ProjectCache cacheOverride) { setCacheOverride(cacheOverride); return this; } /** ** The name of a service role for this build that overrides the one specified in the build project. *
* * @param serviceRoleOverride * The name of a service role for this build that overrides the one specified in the build project. */ public void setServiceRoleOverride(String serviceRoleOverride) { this.serviceRoleOverride = serviceRoleOverride; } /** ** The name of a service role for this build that overrides the one specified in the build project. *
* * @return The name of a service role for this build that overrides the one specified in the build project. */ public String getServiceRoleOverride() { return this.serviceRoleOverride; } /** ** The name of a service role for this build that overrides the one specified in the build project. *
* * @param serviceRoleOverride * The name of a service role for this build that overrides the one specified in the build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withServiceRoleOverride(String serviceRoleOverride) { setServiceRoleOverride(serviceRoleOverride); return this; } /** ** Enable this flag to override privileged mode in the build project. *
* * @param privilegedModeOverride * Enable this flag to override privileged mode in the build project. */ public void setPrivilegedModeOverride(Boolean privilegedModeOverride) { this.privilegedModeOverride = privilegedModeOverride; } /** ** Enable this flag to override privileged mode in the build project. *
* * @return Enable this flag to override privileged mode in the build project. */ public Boolean getPrivilegedModeOverride() { return this.privilegedModeOverride; } /** ** Enable this flag to override privileged mode in the build project. *
* * @param privilegedModeOverride * Enable this flag to override privileged mode in the build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withPrivilegedModeOverride(Boolean privilegedModeOverride) { setPrivilegedModeOverride(privilegedModeOverride); return this; } /** ** Enable this flag to override privileged mode in the build project. *
* * @return Enable this flag to override privileged mode in the build project. */ public Boolean isPrivilegedModeOverride() { return this.privilegedModeOverride; } /** ** The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest * setting already defined in the build project. *
* * @param timeoutInMinutesOverride * The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the * latest setting already defined in the build project. */ public void setTimeoutInMinutesOverride(Integer timeoutInMinutesOverride) { this.timeoutInMinutesOverride = timeoutInMinutesOverride; } /** ** The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest * setting already defined in the build project. *
* * @return The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the * latest setting already defined in the build project. */ public Integer getTimeoutInMinutesOverride() { return this.timeoutInMinutesOverride; } /** ** The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest * setting already defined in the build project. *
* * @param timeoutInMinutesOverride * The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the * latest setting already defined in the build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withTimeoutInMinutesOverride(Integer timeoutInMinutesOverride) { setTimeoutInMinutesOverride(timeoutInMinutesOverride); return this; } /** ** The number of minutes a build is allowed to be queued before it times out. *
* * @param queuedTimeoutInMinutesOverride * The number of minutes a build is allowed to be queued before it times out. */ public void setQueuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride) { this.queuedTimeoutInMinutesOverride = queuedTimeoutInMinutesOverride; } /** ** The number of minutes a build is allowed to be queued before it times out. *
* * @return The number of minutes a build is allowed to be queued before it times out. */ public Integer getQueuedTimeoutInMinutesOverride() { return this.queuedTimeoutInMinutesOverride; } /** ** The number of minutes a build is allowed to be queued before it times out. *
* * @param queuedTimeoutInMinutesOverride * The number of minutes a build is allowed to be queued before it times out. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withQueuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride) { setQueuedTimeoutInMinutesOverride(queuedTimeoutInMinutesOverride); return this; } /** ** The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The * CMK key encrypts 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>
).
*
* 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>
).
*/
public void setEncryptionKeyOverride(String encryptionKeyOverride) {
this.encryptionKeyOverride = encryptionKeyOverride;
}
/**
*
* The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The * CMK key encrypts 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>
).
*
* 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>
).
*/
public String getEncryptionKeyOverride() {
return this.encryptionKeyOverride;
}
/**
*
* The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The * CMK key encrypts 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>
).
*
* 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>
).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBuildRequest withEncryptionKeyOverride(String encryptionKeyOverride) {
setEncryptionKeyOverride(encryptionKeyOverride);
return this;
}
/**
*
* A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is * included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same * token, but change a parameter, CodeBuild returns a parameter mismatch error. *
* * @param idempotencyToken * A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The * token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild * request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error. */ public void setIdempotencyToken(String idempotencyToken) { this.idempotencyToken = idempotencyToken; } /** ** A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is * included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same * token, but change a parameter, CodeBuild returns a parameter mismatch error. *
* * @return A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The * token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild * request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error. */ public String getIdempotencyToken() { return this.idempotencyToken; } /** ** A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is * included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same * token, but change a parameter, CodeBuild returns a parameter mismatch error. *
* * @param idempotencyToken * A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The * token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild * request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withIdempotencyToken(String idempotencyToken) { setIdempotencyToken(idempotencyToken); return this; } /** ** Log settings for this build that override the log settings defined in the build project. *
* * @param logsConfigOverride * Log settings for this build that override the log settings defined in the build project. */ public void setLogsConfigOverride(LogsConfig logsConfigOverride) { this.logsConfigOverride = logsConfigOverride; } /** ** Log settings for this build that override the log settings defined in the build project. *
* * @return Log settings for this build that override the log settings defined in the build project. */ public LogsConfig getLogsConfigOverride() { return this.logsConfigOverride; } /** ** Log settings for this build that override the log settings defined in the build project. *
* * @param logsConfigOverride * Log settings for this build that override the log settings defined in the build project. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withLogsConfigOverride(LogsConfig logsConfigOverride) { setLogsConfigOverride(logsConfigOverride); return this; } /** ** The credentials for access to a private registry. *
* * @param registryCredentialOverride * The credentials for access to a private registry. */ public void setRegistryCredentialOverride(RegistryCredential registryCredentialOverride) { this.registryCredentialOverride = registryCredentialOverride; } /** ** The credentials for access to a private registry. *
* * @return The credentials for access to a private registry. */ public RegistryCredential getRegistryCredentialOverride() { return this.registryCredentialOverride; } /** ** The credentials for access to a private registry. *
* * @param registryCredentialOverride * The credentials for access to a private registry. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withRegistryCredentialOverride(RegistryCredential registryCredentialOverride) { setRegistryCredentialOverride(registryCredentialOverride); return this; } /** ** The type of credentials CodeBuild uses to pull images in your build. There are two valid values: *
** Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to * trust CodeBuild's service principal. *
** Specifies that CodeBuild uses your build project's service role. *
*
* When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials. When
* using an CodeBuild curated image, you must use CODEBUILD
credentials.
*
* Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository * policy to trust CodeBuild's service principal. *
** Specifies that CodeBuild uses your build project's service role. *
*
* When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials.
* When using an CodeBuild curated image, you must use CODEBUILD
credentials.
* @see ImagePullCredentialsType
*/
public void setImagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride) {
this.imagePullCredentialsTypeOverride = imagePullCredentialsTypeOverride;
}
/**
*
* The type of credentials CodeBuild uses to pull images in your build. There are two valid values: *
** Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to * trust CodeBuild's service principal. *
** Specifies that CodeBuild uses your build project's service role. *
*
* When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials. When
* using an CodeBuild curated image, you must use CODEBUILD
credentials.
*
* Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository * policy to trust CodeBuild's service principal. *
** Specifies that CodeBuild uses your build project's service role. *
*
* When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials.
* When using an CodeBuild curated image, you must use CODEBUILD
credentials.
* @see ImagePullCredentialsType
*/
public String getImagePullCredentialsTypeOverride() {
return this.imagePullCredentialsTypeOverride;
}
/**
*
* The type of credentials CodeBuild uses to pull images in your build. There are two valid values: *
** Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to * trust CodeBuild's service principal. *
** Specifies that CodeBuild uses your build project's service role. *
*
* When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials. When
* using an CodeBuild curated image, you must use CODEBUILD
credentials.
*
* Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository * policy to trust CodeBuild's service principal. *
** Specifies that CodeBuild uses your build project's service role. *
*
* When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials.
* When using an CodeBuild curated image, you must use CODEBUILD
credentials.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImagePullCredentialsType
*/
public StartBuildRequest withImagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride) {
setImagePullCredentialsTypeOverride(imagePullCredentialsTypeOverride);
return this;
}
/**
*
* The type of credentials CodeBuild uses to pull images in your build. There are two valid values: *
** Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to * trust CodeBuild's service principal. *
** Specifies that CodeBuild uses your build project's service role. *
*
* When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials. When
* using an CodeBuild curated image, you must use CODEBUILD
credentials.
*
* Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository * policy to trust CodeBuild's service principal. *
** Specifies that CodeBuild uses your build project's service role. *
*
* When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials.
* When using an CodeBuild curated image, you must use CODEBUILD
credentials.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImagePullCredentialsType
*/
public StartBuildRequest withImagePullCredentialsTypeOverride(ImagePullCredentialsType imagePullCredentialsTypeOverride) {
this.imagePullCredentialsTypeOverride = imagePullCredentialsTypeOverride.toString();
return this;
}
/**
*
* Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in * Session Manager. *
* * @param debugSessionEnabled * Specifies if session debugging is enabled for this build. For more information, see Viewing a running build * in Session Manager. */ public void setDebugSessionEnabled(Boolean debugSessionEnabled) { this.debugSessionEnabled = debugSessionEnabled; } /** ** Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in * Session Manager. *
* * @return Specifies if session debugging is enabled for this build. For more information, see Viewing a running * build in Session Manager. */ public Boolean getDebugSessionEnabled() { return this.debugSessionEnabled; } /** ** Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in * Session Manager. *
* * @param debugSessionEnabled * Specifies if session debugging is enabled for this build. For more information, see Viewing a running build * in Session Manager. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBuildRequest withDebugSessionEnabled(Boolean debugSessionEnabled) { setDebugSessionEnabled(debugSessionEnabled); return this; } /** ** Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in * Session Manager. *
* * @return Specifies if session debugging is enabled for this build. For more information, see Viewing a running * build in Session Manager. */ public Boolean isDebugSessionEnabled() { return this.debugSessionEnabled; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getProjectName() != null) sb.append("ProjectName: ").append(getProjectName()).append(","); if (getSecondarySourcesOverride() != null) sb.append("SecondarySourcesOverride: ").append(getSecondarySourcesOverride()).append(","); if (getSecondarySourcesVersionOverride() != null) sb.append("SecondarySourcesVersionOverride: ").append(getSecondarySourcesVersionOverride()).append(","); if (getSourceVersion() != null) sb.append("SourceVersion: ").append(getSourceVersion()).append(","); if (getArtifactsOverride() != null) sb.append("ArtifactsOverride: ").append(getArtifactsOverride()).append(","); if (getSecondaryArtifactsOverride() != null) sb.append("SecondaryArtifactsOverride: ").append(getSecondaryArtifactsOverride()).append(","); if (getEnvironmentVariablesOverride() != null) sb.append("EnvironmentVariablesOverride: ").append(getEnvironmentVariablesOverride()).append(","); if (getSourceTypeOverride() != null) sb.append("SourceTypeOverride: ").append(getSourceTypeOverride()).append(","); if (getSourceLocationOverride() != null) sb.append("SourceLocationOverride: ").append(getSourceLocationOverride()).append(","); if (getSourceAuthOverride() != null) sb.append("SourceAuthOverride: ").append(getSourceAuthOverride()).append(","); if (getGitCloneDepthOverride() != null) sb.append("GitCloneDepthOverride: ").append(getGitCloneDepthOverride()).append(","); if (getGitSubmodulesConfigOverride() != null) sb.append("GitSubmodulesConfigOverride: ").append(getGitSubmodulesConfigOverride()).append(","); if (getBuildspecOverride() != null) sb.append("BuildspecOverride: ").append(getBuildspecOverride()).append(","); if (getInsecureSslOverride() != null) sb.append("InsecureSslOverride: ").append(getInsecureSslOverride()).append(","); if (getReportBuildStatusOverride() != null) sb.append("ReportBuildStatusOverride: ").append(getReportBuildStatusOverride()).append(","); if (getBuildStatusConfigOverride() != null) sb.append("BuildStatusConfigOverride: ").append(getBuildStatusConfigOverride()).append(","); if (getEnvironmentTypeOverride() != null) sb.append("EnvironmentTypeOverride: ").append(getEnvironmentTypeOverride()).append(","); if (getImageOverride() != null) sb.append("ImageOverride: ").append(getImageOverride()).append(","); if (getComputeTypeOverride() != null) sb.append("ComputeTypeOverride: ").append(getComputeTypeOverride()).append(","); if (getCertificateOverride() != null) sb.append("CertificateOverride: ").append(getCertificateOverride()).append(","); if (getCacheOverride() != null) sb.append("CacheOverride: ").append(getCacheOverride()).append(","); if (getServiceRoleOverride() != null) sb.append("ServiceRoleOverride: ").append(getServiceRoleOverride()).append(","); if (getPrivilegedModeOverride() != null) sb.append("PrivilegedModeOverride: ").append(getPrivilegedModeOverride()).append(","); if (getTimeoutInMinutesOverride() != null) sb.append("TimeoutInMinutesOverride: ").append(getTimeoutInMinutesOverride()).append(","); if (getQueuedTimeoutInMinutesOverride() != null) sb.append("QueuedTimeoutInMinutesOverride: ").append(getQueuedTimeoutInMinutesOverride()).append(","); if (getEncryptionKeyOverride() != null) sb.append("EncryptionKeyOverride: ").append(getEncryptionKeyOverride()).append(","); if (getIdempotencyToken() != null) sb.append("IdempotencyToken: ").append(getIdempotencyToken()).append(","); if (getLogsConfigOverride() != null) sb.append("LogsConfigOverride: ").append(getLogsConfigOverride()).append(","); if (getRegistryCredentialOverride() != null) sb.append("RegistryCredentialOverride: ").append(getRegistryCredentialOverride()).append(","); if (getImagePullCredentialsTypeOverride() != null) sb.append("ImagePullCredentialsTypeOverride: ").append(getImagePullCredentialsTypeOverride()).append(","); if (getDebugSessionEnabled() != null) sb.append("DebugSessionEnabled: ").append(getDebugSessionEnabled()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartBuildRequest == false) return false; StartBuildRequest other = (StartBuildRequest) obj; if (other.getProjectName() == null ^ this.getProjectName() == null) return false; if (other.getProjectName() != null && other.getProjectName().equals(this.getProjectName()) == false) return false; if (other.getSecondarySourcesOverride() == null ^ this.getSecondarySourcesOverride() == null) return false; if (other.getSecondarySourcesOverride() != null && other.getSecondarySourcesOverride().equals(this.getSecondarySourcesOverride()) == false) return false; if (other.getSecondarySourcesVersionOverride() == null ^ this.getSecondarySourcesVersionOverride() == null) return false; if (other.getSecondarySourcesVersionOverride() != null && other.getSecondarySourcesVersionOverride().equals(this.getSecondarySourcesVersionOverride()) == false) return false; if (other.getSourceVersion() == null ^ this.getSourceVersion() == null) return false; if (other.getSourceVersion() != null && other.getSourceVersion().equals(this.getSourceVersion()) == false) return false; if (other.getArtifactsOverride() == null ^ this.getArtifactsOverride() == null) return false; if (other.getArtifactsOverride() != null && other.getArtifactsOverride().equals(this.getArtifactsOverride()) == false) return false; if (other.getSecondaryArtifactsOverride() == null ^ this.getSecondaryArtifactsOverride() == null) return false; if (other.getSecondaryArtifactsOverride() != null && other.getSecondaryArtifactsOverride().equals(this.getSecondaryArtifactsOverride()) == false) return false; if (other.getEnvironmentVariablesOverride() == null ^ this.getEnvironmentVariablesOverride() == null) return false; if (other.getEnvironmentVariablesOverride() != null && other.getEnvironmentVariablesOverride().equals(this.getEnvironmentVariablesOverride()) == false) return false; if (other.getSourceTypeOverride() == null ^ this.getSourceTypeOverride() == null) return false; if (other.getSourceTypeOverride() != null && other.getSourceTypeOverride().equals(this.getSourceTypeOverride()) == false) return false; if (other.getSourceLocationOverride() == null ^ this.getSourceLocationOverride() == null) return false; if (other.getSourceLocationOverride() != null && other.getSourceLocationOverride().equals(this.getSourceLocationOverride()) == false) return false; if (other.getSourceAuthOverride() == null ^ this.getSourceAuthOverride() == null) return false; if (other.getSourceAuthOverride() != null && other.getSourceAuthOverride().equals(this.getSourceAuthOverride()) == false) return false; if (other.getGitCloneDepthOverride() == null ^ this.getGitCloneDepthOverride() == null) return false; if (other.getGitCloneDepthOverride() != null && other.getGitCloneDepthOverride().equals(this.getGitCloneDepthOverride()) == false) return false; if (other.getGitSubmodulesConfigOverride() == null ^ this.getGitSubmodulesConfigOverride() == null) return false; if (other.getGitSubmodulesConfigOverride() != null && other.getGitSubmodulesConfigOverride().equals(this.getGitSubmodulesConfigOverride()) == false) return false; if (other.getBuildspecOverride() == null ^ this.getBuildspecOverride() == null) return false; if (other.getBuildspecOverride() != null && other.getBuildspecOverride().equals(this.getBuildspecOverride()) == false) return false; if (other.getInsecureSslOverride() == null ^ this.getInsecureSslOverride() == null) return false; if (other.getInsecureSslOverride() != null && other.getInsecureSslOverride().equals(this.getInsecureSslOverride()) == false) return false; if (other.getReportBuildStatusOverride() == null ^ this.getReportBuildStatusOverride() == null) return false; if (other.getReportBuildStatusOverride() != null && other.getReportBuildStatusOverride().equals(this.getReportBuildStatusOverride()) == false) return false; if (other.getBuildStatusConfigOverride() == null ^ this.getBuildStatusConfigOverride() == null) return false; if (other.getBuildStatusConfigOverride() != null && other.getBuildStatusConfigOverride().equals(this.getBuildStatusConfigOverride()) == false) return false; if (other.getEnvironmentTypeOverride() == null ^ this.getEnvironmentTypeOverride() == null) return false; if (other.getEnvironmentTypeOverride() != null && other.getEnvironmentTypeOverride().equals(this.getEnvironmentTypeOverride()) == false) return false; if (other.getImageOverride() == null ^ this.getImageOverride() == null) return false; if (other.getImageOverride() != null && other.getImageOverride().equals(this.getImageOverride()) == false) return false; if (other.getComputeTypeOverride() == null ^ this.getComputeTypeOverride() == null) return false; if (other.getComputeTypeOverride() != null && other.getComputeTypeOverride().equals(this.getComputeTypeOverride()) == false) return false; if (other.getCertificateOverride() == null ^ this.getCertificateOverride() == null) return false; if (other.getCertificateOverride() != null && other.getCertificateOverride().equals(this.getCertificateOverride()) == false) return false; if (other.getCacheOverride() == null ^ this.getCacheOverride() == null) return false; if (other.getCacheOverride() != null && other.getCacheOverride().equals(this.getCacheOverride()) == false) return false; if (other.getServiceRoleOverride() == null ^ this.getServiceRoleOverride() == null) return false; if (other.getServiceRoleOverride() != null && other.getServiceRoleOverride().equals(this.getServiceRoleOverride()) == false) return false; if (other.getPrivilegedModeOverride() == null ^ this.getPrivilegedModeOverride() == null) return false; if (other.getPrivilegedModeOverride() != null && other.getPrivilegedModeOverride().equals(this.getPrivilegedModeOverride()) == false) return false; if (other.getTimeoutInMinutesOverride() == null ^ this.getTimeoutInMinutesOverride() == null) return false; if (other.getTimeoutInMinutesOverride() != null && other.getTimeoutInMinutesOverride().equals(this.getTimeoutInMinutesOverride()) == false) return false; if (other.getQueuedTimeoutInMinutesOverride() == null ^ this.getQueuedTimeoutInMinutesOverride() == null) return false; if (other.getQueuedTimeoutInMinutesOverride() != null && other.getQueuedTimeoutInMinutesOverride().equals(this.getQueuedTimeoutInMinutesOverride()) == false) return false; if (other.getEncryptionKeyOverride() == null ^ this.getEncryptionKeyOverride() == null) return false; if (other.getEncryptionKeyOverride() != null && other.getEncryptionKeyOverride().equals(this.getEncryptionKeyOverride()) == false) return false; if (other.getIdempotencyToken() == null ^ this.getIdempotencyToken() == null) return false; if (other.getIdempotencyToken() != null && other.getIdempotencyToken().equals(this.getIdempotencyToken()) == false) return false; if (other.getLogsConfigOverride() == null ^ this.getLogsConfigOverride() == null) return false; if (other.getLogsConfigOverride() != null && other.getLogsConfigOverride().equals(this.getLogsConfigOverride()) == false) return false; if (other.getRegistryCredentialOverride() == null ^ this.getRegistryCredentialOverride() == null) return false; if (other.getRegistryCredentialOverride() != null && other.getRegistryCredentialOverride().equals(this.getRegistryCredentialOverride()) == false) return false; if (other.getImagePullCredentialsTypeOverride() == null ^ this.getImagePullCredentialsTypeOverride() == null) return false; if (other.getImagePullCredentialsTypeOverride() != null && other.getImagePullCredentialsTypeOverride().equals(this.getImagePullCredentialsTypeOverride()) == false) return false; if (other.getDebugSessionEnabled() == null ^ this.getDebugSessionEnabled() == null) return false; if (other.getDebugSessionEnabled() != null && other.getDebugSessionEnabled().equals(this.getDebugSessionEnabled()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getProjectName() == null) ? 0 : getProjectName().hashCode()); hashCode = prime * hashCode + ((getSecondarySourcesOverride() == null) ? 0 : getSecondarySourcesOverride().hashCode()); hashCode = prime * hashCode + ((getSecondarySourcesVersionOverride() == null) ? 0 : getSecondarySourcesVersionOverride().hashCode()); hashCode = prime * hashCode + ((getSourceVersion() == null) ? 0 : getSourceVersion().hashCode()); hashCode = prime * hashCode + ((getArtifactsOverride() == null) ? 0 : getArtifactsOverride().hashCode()); hashCode = prime * hashCode + ((getSecondaryArtifactsOverride() == null) ? 0 : getSecondaryArtifactsOverride().hashCode()); hashCode = prime * hashCode + ((getEnvironmentVariablesOverride() == null) ? 0 : getEnvironmentVariablesOverride().hashCode()); hashCode = prime * hashCode + ((getSourceTypeOverride() == null) ? 0 : getSourceTypeOverride().hashCode()); hashCode = prime * hashCode + ((getSourceLocationOverride() == null) ? 0 : getSourceLocationOverride().hashCode()); hashCode = prime * hashCode + ((getSourceAuthOverride() == null) ? 0 : getSourceAuthOverride().hashCode()); hashCode = prime * hashCode + ((getGitCloneDepthOverride() == null) ? 0 : getGitCloneDepthOverride().hashCode()); hashCode = prime * hashCode + ((getGitSubmodulesConfigOverride() == null) ? 0 : getGitSubmodulesConfigOverride().hashCode()); hashCode = prime * hashCode + ((getBuildspecOverride() == null) ? 0 : getBuildspecOverride().hashCode()); hashCode = prime * hashCode + ((getInsecureSslOverride() == null) ? 0 : getInsecureSslOverride().hashCode()); hashCode = prime * hashCode + ((getReportBuildStatusOverride() == null) ? 0 : getReportBuildStatusOverride().hashCode()); hashCode = prime * hashCode + ((getBuildStatusConfigOverride() == null) ? 0 : getBuildStatusConfigOverride().hashCode()); hashCode = prime * hashCode + ((getEnvironmentTypeOverride() == null) ? 0 : getEnvironmentTypeOverride().hashCode()); hashCode = prime * hashCode + ((getImageOverride() == null) ? 0 : getImageOverride().hashCode()); hashCode = prime * hashCode + ((getComputeTypeOverride() == null) ? 0 : getComputeTypeOverride().hashCode()); hashCode = prime * hashCode + ((getCertificateOverride() == null) ? 0 : getCertificateOverride().hashCode()); hashCode = prime * hashCode + ((getCacheOverride() == null) ? 0 : getCacheOverride().hashCode()); hashCode = prime * hashCode + ((getServiceRoleOverride() == null) ? 0 : getServiceRoleOverride().hashCode()); hashCode = prime * hashCode + ((getPrivilegedModeOverride() == null) ? 0 : getPrivilegedModeOverride().hashCode()); hashCode = prime * hashCode + ((getTimeoutInMinutesOverride() == null) ? 0 : getTimeoutInMinutesOverride().hashCode()); hashCode = prime * hashCode + ((getQueuedTimeoutInMinutesOverride() == null) ? 0 : getQueuedTimeoutInMinutesOverride().hashCode()); hashCode = prime * hashCode + ((getEncryptionKeyOverride() == null) ? 0 : getEncryptionKeyOverride().hashCode()); hashCode = prime * hashCode + ((getIdempotencyToken() == null) ? 0 : getIdempotencyToken().hashCode()); hashCode = prime * hashCode + ((getLogsConfigOverride() == null) ? 0 : getLogsConfigOverride().hashCode()); hashCode = prime * hashCode + ((getRegistryCredentialOverride() == null) ? 0 : getRegistryCredentialOverride().hashCode()); hashCode = prime * hashCode + ((getImagePullCredentialsTypeOverride() == null) ? 0 : getImagePullCredentialsTypeOverride().hashCode()); hashCode = prime * hashCode + ((getDebugSessionEnabled() == null) ? 0 : getDebugSessionEnabled().hashCode()); return hashCode; } @Override public StartBuildRequest clone() { return (StartBuildRequest) super.clone(); } }