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

Class StartBuildRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.codebuild.model.CodeBuildRequest
software.amazon.awssdk.services.codebuild.model.StartBuildRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartBuildRequest extends CodeBuildRequest implements ToCopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>

  • Method Details

    • projectName

      public final String projectName()

      The name of the CodeBuild build project to start running a build.

      Returns:
      The name of the CodeBuild build project to start running a build.

    • hasSecondarySourcesOverride

      public final boolean hasSecondarySourcesOverride()
      For responses, this returns true if the service returned a value for the SecondarySourcesOverride property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • secondarySourcesOverride

      public final List<ProjectSource> secondarySourcesOverride()

      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 hasSecondarySourcesOverride() method.

      Returns:
      An array of ProjectSource objects.

    • hasSecondarySourcesVersionOverride

      public final boolean hasSecondarySourcesVersionOverride()
      For responses, this returns true if the service returned a value for the SecondarySourcesVersionOverride property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • secondarySourcesVersionOverride

      public final List<ProjectSourceVersion> secondarySourcesVersionOverride()

      An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

      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 hasSecondarySourcesVersionOverride() method.

      Returns:
      An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

    • sourceVersion

      public final String 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:

      CodeCommit

      The commit ID, branch, or Git tag to use.

      GitHub

      The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

      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.

      Amazon S3

      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.

      Returns:
      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:

      CodeCommit

      The commit ID, branch, or Git tag to use.

      GitHub

      The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

      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.

      Amazon S3

      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.

    • artifactsOverride

      public final ProjectArtifacts artifactsOverride()

      Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

      Returns:
      Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

    • hasSecondaryArtifactsOverride

      public final boolean hasSecondaryArtifactsOverride()
      For responses, this returns true if the service returned a value for the SecondaryArtifactsOverride property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • secondaryArtifactsOverride

      public final List<ProjectArtifacts> secondaryArtifactsOverride()

      An array of ProjectArtifacts 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 hasSecondaryArtifactsOverride() method.

      Returns:
      An array of ProjectArtifacts objects.

    • hasEnvironmentVariablesOverride

      public final boolean hasEnvironmentVariablesOverride()
      For responses, this returns true if the service returned a value for the EnvironmentVariablesOverride property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • environmentVariablesOverride

      public final List<EnvironmentVariable> environmentVariablesOverride()

      A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

      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 hasEnvironmentVariablesOverride() method.

      Returns:
      A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

    • sourceTypeOverride

      public final SourceType sourceTypeOverride()

      A source input type, for this build, that overrides the source input defined in the build project.

      If the service returns an enum value that is not available in the current SDK version, sourceTypeOverride will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeOverrideAsString().

      Returns:
      A source input type, for this build, that overrides the source input defined in the build project.
      See Also:

    • sourceTypeOverrideAsString

      public final String sourceTypeOverrideAsString()

      A source input type, for this build, that overrides the source input defined in the build project.

      If the service returns an enum value that is not available in the current SDK version, sourceTypeOverride will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeOverrideAsString().

      Returns:
      A source input type, for this build, that overrides the source input defined in the build project.
      See Also:

    • sourceLocationOverride

      public final String sourceLocationOverride()

      A location that overrides, for this build, the source location for the one defined in the build project.

      Returns:
      A location that overrides, for this build, the source location for the one defined in the build project.

    • sourceAuthOverride

      public final SourceAuth 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.

      Returns:
      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.

    • gitCloneDepthOverride

      public final Integer 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.

      Returns:
      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.

    • gitSubmodulesConfigOverride

      public final GitSubmodulesConfig gitSubmodulesConfigOverride()

      Information about the Git submodules configuration for this build of an CodeBuild build project.

      Returns:
      Information about the Git submodules configuration for this build of an CodeBuild build project.

    • buildspecOverride

      public final String buildspecOverride()

      A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.

      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.

      Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.

      Returns:
      A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.

      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.

      Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.

    • insecureSslOverride

      public final Boolean 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.

      Returns:
      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.

    • reportBuildStatusOverride

      public final Boolean 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.

      Returns:
      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.

    • buildStatusConfigOverride

      public final BuildStatusConfig 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.

      Returns:
      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.

    • environmentTypeOverride

      public final EnvironmentType environmentTypeOverride()

      A container type for this build that overrides the one specified in the build project.

      If the service returns an enum value that is not available in the current SDK version, environmentTypeOverride will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from environmentTypeOverrideAsString().

      Returns:
      A container type for this build that overrides the one specified in the build project.
      See Also:

    • environmentTypeOverrideAsString

      public final String environmentTypeOverrideAsString()

      A container type for this build that overrides the one specified in the build project.

      If the service returns an enum value that is not available in the current SDK version, environmentTypeOverride will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from environmentTypeOverrideAsString().

      Returns:
      A container type for this build that overrides the one specified in the build project.
      See Also:

    • imageOverride

      public final String imageOverride()

      The name of an image for this build that overrides the one specified in the build project.

      Returns:
      The name of an image for this build that overrides the one specified in the build project.

    • computeTypeOverride

      public final ComputeType computeTypeOverride()

      The name of a compute type for this build that overrides the one specified in the build project.

      If the service returns an enum value that is not available in the current SDK version, computeTypeOverride will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeOverrideAsString().

      Returns:
      The name of a compute type for this build that overrides the one specified in the build project.
      See Also:

    • computeTypeOverrideAsString

      public final String computeTypeOverrideAsString()

      The name of a compute type for this build that overrides the one specified in the build project.

      If the service returns an enum value that is not available in the current SDK version, computeTypeOverride will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeOverrideAsString().

      Returns:
      The name of a compute type for this build that overrides the one specified in the build project.
      See Also:

    • certificateOverride

      public final String certificateOverride()

      The name of a certificate for this build that overrides the one specified in the build project.

      Returns:
      The name of a certificate for this build that overrides the one specified in the build project.

    • cacheOverride

      public final ProjectCache cacheOverride()

      A ProjectCache object specified for this build that overrides the one defined in the build project.

      Returns:
      A ProjectCache object specified for this build that overrides the one defined in the build project.

    • serviceRoleOverride

      public final String serviceRoleOverride()

      The name of a service role for this build that overrides the one specified in the build project.

      Returns:
      The name of a service role for this build that overrides the one specified in the build project.

    • privilegedModeOverride

      public final Boolean privilegedModeOverride()

      Enable this flag to override privileged mode in the build project.

      Returns:
      Enable this flag to override privileged mode in the build project.

    • timeoutInMinutesOverride

      public final Integer 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.

      Returns:
      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.

    • queuedTimeoutInMinutesOverride

      public final Integer queuedTimeoutInMinutesOverride()

      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.

    • encryptionKeyOverride

      public final String 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>).

      Returns:
      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>).

    • idempotencyToken

      public final String 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.

      Returns:
      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.

    • logsConfigOverride

      public final LogsConfig logsConfigOverride()

      Log settings for this build that override the log settings defined in the build project.

      Returns:
      Log settings for this build that override the log settings defined in the build project.

    • registryCredentialOverride

      public final RegistryCredential registryCredentialOverride()

      The credentials for access to a private registry.

      Returns:
      The credentials for access to a private registry.

    • imagePullCredentialsTypeOverride

      public final ImagePullCredentialsType imagePullCredentialsTypeOverride()

      The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

      CODEBUILD

      Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

      SERVICE_ROLE

      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.

      If the service returns an enum value that is not available in the current SDK version, imagePullCredentialsTypeOverride will return ImagePullCredentialsType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imagePullCredentialsTypeOverrideAsString().

      Returns:
      The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

      CODEBUILD

      Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

      SERVICE_ROLE

      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 Also:

    • imagePullCredentialsTypeOverrideAsString

      public final String imagePullCredentialsTypeOverrideAsString()

      The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

      CODEBUILD

      Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

      SERVICE_ROLE

      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.

      If the service returns an enum value that is not available in the current SDK version, imagePullCredentialsTypeOverride will return ImagePullCredentialsType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imagePullCredentialsTypeOverrideAsString().

      Returns:
      The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

      CODEBUILD

      Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

      SERVICE_ROLE

      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 Also:

    • debugSessionEnabled

      public final Boolean debugSessionEnabled()

      Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

      Returns:
      Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

    • fleetOverride

      public final ProjectFleet fleetOverride()

      A ProjectFleet object specified for this build that overrides the one defined in the build project.

      Returns:
      A ProjectFleet object specified for this build that overrides the one defined in the build project.

    • toBuilder

      public StartBuildRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>
      Specified by:
      toBuilder in class CodeBuildRequest
      Returns:
      a builder for type T

    • builder

      public static StartBuildRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

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

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.