@Generated(value="software.amazon.awssdk:codegen") public final class ProjectSource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProjectSource.Builder,ProjectSource>
Information about the build input source code for the build project.
Modifier and Type | Class and Description |
---|---|
static interface |
ProjectSource.Builder |
Modifier and Type | Method and Description |
---|---|
SourceAuth |
auth()
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
|
static ProjectSource.Builder |
builder() |
String |
buildspec()
The buildspec file declaration to use for the builds in this build project.
|
BuildStatusConfig |
buildStatusConfig()
Contains information that defines how the build project reports the build status to the source provider.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
Integer |
gitCloneDepth()
Information about the Git clone depth for the build project.
|
GitSubmodulesConfig |
gitSubmodulesConfig()
Information about the Git submodules configuration for the build project.
|
int |
hashCode() |
Boolean |
insecureSsl()
Enable this flag to ignore SSL warnings while connecting to the project source code.
|
String |
location()
Information about the location of the source code to be built.
|
Boolean |
reportBuildStatus()
Set to true to report the status of a build's start and finish to your source provider.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ProjectSource.Builder> |
serializableBuilderClass() |
String |
sourceIdentifier()
An identifier for this project source.
|
ProjectSource.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
SourceType |
type()
The type of repository that contains the source code to be built.
|
String |
typeAsString()
The type of repository that contains the source code to be built.
|
copy
public final SourceType type()
The type of repository that contains the source code to be built. Valid values include:
BITBUCKET
: The source code is in a Bitbucket repository.
CODECOMMIT
: The source code is in an AWS CodeCommit repository.
CODEPIPELINE
: The source code settings are specified in the source action of a pipeline in AWS
CodePipeline.
GITHUB
: The source code is in a GitHub or GitHub Enterprise Cloud repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
If the service returns an enum value that is not available in the current SDK version, type
will return
SourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
BITBUCKET
: The source code is in a Bitbucket repository.
CODECOMMIT
: The source code is in an AWS CodeCommit repository.
CODEPIPELINE
: The source code settings are specified in the source action of a pipeline in
AWS CodePipeline.
GITHUB
: The source code is in a GitHub or GitHub Enterprise Cloud repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
SourceType
public final String typeAsString()
The type of repository that contains the source code to be built. Valid values include:
BITBUCKET
: The source code is in a Bitbucket repository.
CODECOMMIT
: The source code is in an AWS CodeCommit repository.
CODEPIPELINE
: The source code settings are specified in the source action of a pipeline in AWS
CodePipeline.
GITHUB
: The source code is in a GitHub or GitHub Enterprise Cloud repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
If the service returns an enum value that is not available in the current SDK version, type
will return
SourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
BITBUCKET
: The source code is in a Bitbucket repository.
CODECOMMIT
: The source code is in an AWS CodeCommit repository.
CODEPIPELINE
: The source code settings are specified in the source action of a pipeline in
AWS CodePipeline.
GITHUB
: The source code is in a GitHub or GitHub Enterprise Cloud repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
SourceType
public final String location()
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in AWS CodePipeline,
location
should not be specified. If it is specified, AWS CodePipeline ignores it. This is because
AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source
code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>
).
For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip
).
The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/
).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the
buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start
creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub
Authorize application page, for Organization access, choose Request access next to each
repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application.
(After you have connected to your GitHub account, you do not need to finish creating the build project. You can
leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source
object, set the auth
object's type
value to OAUTH
.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the
buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to
start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the
Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to
your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild
console.) To instruct AWS CodeBuild to use this connection, in the source
object, set the
auth
object's type
value to OAUTH
.
For source code settings that are specified in the source action of a pipeline in AWS CodePipeline,
location
should not be specified. If it is specified, AWS CodePipeline ignores it. This is
because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the
source code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>
).
For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip
).
The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/
).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source
and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild
console to start creating a build project. When you use the console to connect (or reconnect) with
GitHub, on the GitHub Authorize application page, for Organization access, choose
Request access next to each repository you want to allow AWS CodeBuild to have access to, and then
choose Authorize application. (After you have connected to your GitHub account, you do not need to
finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to
use this connection, in the source
object, set the auth
object's
type
value to OAUTH
.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source
and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS
CodeBuild console to start creating a build project. When you use the console to connect (or reconnect)
with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access.
(After you have connected to your Bitbucket account, you do not need to finish creating the build
project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in
the source
object, set the auth
object's type
value to
OAUTH
.
public final Integer gitCloneDepth()
Information about the Git clone depth for the build project.
public final GitSubmodulesConfig gitSubmodulesConfig()
Information about the Git submodules configuration for the build project.
public final String buildspec()
The buildspec file declaration to use for the builds in this 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 AWS 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 AWS 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 final SourceAuth auth()
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
public final Boolean reportBuildStatus()
Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.
The status of a build triggered by a webhook is always reported to your source provider.
The status of a build triggered by a webhook is always reported to your source provider.
public final BuildStatusConfig buildStatusConfig()
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 final Boolean insecureSsl()
Enable this flag to ignore SSL warnings while connecting to the project source code.
public final String sourceIdentifier()
An identifier for this project source.
public ProjectSource.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ProjectSource.Builder,ProjectSource>
public static ProjectSource.Builder builder()
public static Class<? extends ProjectSource.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.