ProjectSource (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.codebuild.model.ProjectSource

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ProjectSource.Builder,ProjectSource>

@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.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ProjectSource.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ProjectSource.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 build spec declaration to use for the builds in this build project.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`Integer`	`gitCloneDepth()` Information about the git clone depth 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()`
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - type
```
public 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 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().
    Returns:
    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 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.
    See Also:
    
    SourceType
  - typeAsString
```
public 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 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().
    Returns:
    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 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.
    See Also:
    
    SourceType
  - location
```
public 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 build spec (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/to/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 build spec. 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 build spec. 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.
    Returns:
    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 build spec (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/to/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 build spec. 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 build spec. 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.
  - gitCloneDepth
```
public Integer gitCloneDepth()
```
    Information about the git clone depth for the build project.
    
    Returns:
    
    Information about the git clone depth for the build project.
  - buildspec
```
public String buildspec()
```
    The build spec declaration to use for the builds in this build project.
    
    If this value is not specified, a build spec must be included along with the source code to be built.
    
    Returns:
    
    The build spec declaration to use for the builds in this build project.
    
    If this value is not specified, a build spec must be included along with the source code to be built.
  - auth
```
public 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 (unless the build project's source type value is BITBUCKET or GITHUB).
    
    Returns:
    
    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 (unless the build project's source type value is BITBUCKET or GITHUB).
  - reportBuildStatus
```
public 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.
    
    Returns:
    
    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.
  - insecureSsl
```
public Boolean insecureSsl()
```
    Enable this flag to ignore SSL warnings while connecting to the project source code.
    
    Returns:
    
    Enable this flag to ignore SSL warnings while connecting to the project source code.
  - sourceIdentifier
```
public String sourceIdentifier()
```
    An identifier for this project source.
    
    Returns:
    
    An identifier for this project source.
  - toBuilder
```
public ProjectSource.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<ProjectSource.Builder,ProjectSource>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ProjectSource.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ProjectSource.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class ProjectSource

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

type

typeAsString

location

gitCloneDepth

buildspec

auth

reportBuildStatus

insecureSsl

sourceIdentifier

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields