ProjectSource (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codebuild.model.ProjectSource

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProjectSource
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about the build input source code for the build project.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProjectSource()

Constructors
Constructor and Description
`ProjectSource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProjectSource`	`clone()`
`boolean`	`equals(Object obj)`
`SourceAuth`	`getAuth()` Information about the authorization settings for AWS CodeBuild to access the source code to be built.
`String`	`getBuildspec()` The build spec declaration to use for the builds in this build project.
`String`	`getLocation()` Information about the location of the source code to be built.
`String`	`getType()` The type of repository that contains the source code to be built.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAuth(SourceAuth auth)` Information about the authorization settings for AWS CodeBuild to access the source code to be built.
`void`	`setBuildspec(String buildspec)` The build spec declaration to use for the builds in this build project.
`void`	`setLocation(String location)` Information about the location of the source code to be built.
`void`	`setType(SourceType type)` The type of repository that contains the source code to be built.
`void`	`setType(String type)` The type of repository that contains the source code to be built.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ProjectSource`	`withAuth(SourceAuth auth)` Information about the authorization settings for AWS CodeBuild to access the source code to be built.
`ProjectSource`	`withBuildspec(String buildspec)` The build spec declaration to use for the builds in this build project.
`ProjectSource`	`withLocation(String location)` Information about the location of the source code to be built.
`ProjectSource`	`withType(SourceType type)` The type of repository that contains the source code to be built.
`ProjectSource`	`withType(String type)` 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

- Constructor Detail
  - ProjectSource
```
public ProjectSource()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The type of repository that contains the source code to be built. Valid values include:
    - 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.
    - S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    Parameters:
    type - The type of repository that contains the source code to be built. Valid values include:
    
    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.
    
    S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    See Also:
    
    SourceType
  - getType
```
public String getType()
```
    The type of repository that contains the source code to be built. Valid values include:
    - 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.
    - S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    Returns:
    The type of repository that contains the source code to be built. Valid values include:
    
    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.
    
    S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    See Also:
    
    SourceType
  - withType
```
public ProjectSource withType(String type)
```
    The type of repository that contains the source code to be built. Valid values include:
    - 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.
    - S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    Parameters:
    type - The type of repository that contains the source code to be built. Valid values include:
    
    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.
    
    S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SourceType
  - setType
```
public void setType(SourceType type)
```
    The type of repository that contains the source code to be built. Valid values include:
    - 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.
    - S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    Parameters:
    type - The type of repository that contains the source code to be built. Valid values include:
    
    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.
    
    S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    See Also:
    
    SourceType
  - withType
```
public ProjectSource withType(SourceType type)
```
    The type of repository that contains the source code to be built. Valid values include:
    - 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.
    - S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    Parameters:
    type - The type of repository that contains the source code to be built. Valid values include:
    
    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.
    
    S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SourceType
  - setLocation
```
public void setLocation(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 will ignore 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, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip)
    - For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH.
    Parameters:
    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 will ignore 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, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip)
    
    For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH.
  - getLocation
```
public String getLocation()
```
    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 will ignore 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, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip)
    - For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then 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 will ignore 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, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip)
    
    For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH.
  - withLocation
```
public ProjectSource withLocation(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 will ignore 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, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip)
    - For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH.
    Parameters:
    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 will ignore 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, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip)
    
    For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBuildspec
```
public void setBuildspec(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.
    
    Parameters:
    
    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.
  - getBuildspec
```
public String getBuildspec()
```
    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.
  - withBuildspec
```
public ProjectSource withBuildspec(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuth
```
public void setAuth(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 GITHUB).
    
    Parameters:
    
    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 GITHUB).
  - getAuth
```
public SourceAuth getAuth()
```
    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 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 GITHUB).
  - withAuth
```
public ProjectSource withAuth(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 GITHUB).
    
    Parameters:
    
    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 GITHUB).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ProjectSource clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ProjectSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectSource

Method Detail

setType

getType

withType

setType

withType

setLocation

getLocation

withLocation

setBuildspec

getBuildspec

withBuildspec

setAuth

getAuth

withAuth

toString

equals

hashCode

clone

marshall