com.amazonaws.services.codebuild.model

Class ProjectEnvironment

java.lang.Object

com.amazonaws.services.codebuild.model.ProjectEnvironment

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProjectEnvironment
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about the build environment of the build project.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProjectEnvironment()

Method Summary

Modifier and Type	Method and Description
ProjectEnvironment	clone()
boolean	equals(Object obj)
String	getComputeType() Information about the compute resources the build project will use.
List<EnvironmentVariable>	getEnvironmentVariables() A set of environment variables to make available to builds for this build project.
String	getImage() The ID of the Docker image to use for this build project.
Boolean	getPrivilegedMode() If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default).
String	getType() The type of build environment to use for related builds.
int	hashCode()
Boolean	isPrivilegedMode() If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default).
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setComputeType(ComputeType computeType) Information about the compute resources the build project will use.
void	setComputeType(String computeType) Information about the compute resources the build project will use.
void	setEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables) A set of environment variables to make available to builds for this build project.
void	setImage(String image) The ID of the Docker image to use for this build project.
void	setPrivilegedMode(Boolean privilegedMode) If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default).
void	setType(EnvironmentType type) The type of build environment to use for related builds.
void	setType(String type) The type of build environment to use for related builds.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ProjectEnvironment	withComputeType(ComputeType computeType) Information about the compute resources the build project will use.
ProjectEnvironment	withComputeType(String computeType) Information about the compute resources the build project will use.
ProjectEnvironment	withEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables) A set of environment variables to make available to builds for this build project.
ProjectEnvironment	withEnvironmentVariables(EnvironmentVariable... environmentVariables) A set of environment variables to make available to builds for this build project.
ProjectEnvironment	withImage(String image) The ID of the Docker image to use for this build project.
ProjectEnvironment	withPrivilegedMode(Boolean privilegedMode) If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default).
ProjectEnvironment	withType(EnvironmentType type) The type of build environment to use for related builds.
ProjectEnvironment	withType(String type) The type of build environment to use for related builds.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProjectEnvironment

public ProjectEnvironment()

Method Detail

setType

public void setType(String type)

The type of build environment to use for related builds.

Parameters:

type - The type of build environment to use for related builds.

See Also:

EnvironmentType

getType

public String getType()

The type of build environment to use for related builds.

Returns:

The type of build environment to use for related builds.

See Also:

EnvironmentType

withType

public ProjectEnvironment withType(String type)

The type of build environment to use for related builds.

Parameters:

type - The type of build environment to use for related builds.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentType

setType

public void setType(EnvironmentType type)

The type of build environment to use for related builds.

Parameters:

type - The type of build environment to use for related builds.

See Also:

EnvironmentType

withType

public ProjectEnvironment withType(EnvironmentType type)

The type of build environment to use for related builds.

Parameters:

type - The type of build environment to use for related builds.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentType

setImage

public void setImage(String image)

The ID of the Docker image to use for this build project.

Parameters:

image - The ID of the Docker image to use for this build project.

getImage

public String getImage()

The ID of the Docker image to use for this build project.

Returns:

The ID of the Docker image to use for this build project.

withImage

public ProjectEnvironment withImage(String image)

The ID of the Docker image to use for this build project.

Parameters:

image - The ID of the Docker image to use for this build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

setComputeType

public void setComputeType(String computeType)

Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

Parameters:

computeType - Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

See Also:

ComputeType

getComputeType

public String getComputeType()

Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

Returns:

Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

See Also:

ComputeType

withComputeType

public ProjectEnvironment withComputeType(String computeType)

Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

Parameters:

computeType - Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComputeType

setComputeType

public void setComputeType(ComputeType computeType)

Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

Parameters:

computeType - Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

See Also:

ComputeType

withComputeType

public ProjectEnvironment withComputeType(ComputeType computeType)

Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

Parameters:

computeType - Information about the compute resources the build project will use. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

• BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComputeType

getEnvironmentVariables

public List<EnvironmentVariable> getEnvironmentVariables()

A set of environment variables to make available to builds for this build project.

Returns:

A set of environment variables to make available to builds for this build project.

setEnvironmentVariables

public void setEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables)

A set of environment variables to make available to builds for this build project.

Parameters:

environmentVariables - A set of environment variables to make available to builds for this build project.

withEnvironmentVariables

public ProjectEnvironment withEnvironmentVariables(EnvironmentVariable... environmentVariables)

A set of environment variables to make available to builds for this build project.

NOTE: This method appends the values to the existing list (if any). Use setEnvironmentVariables(java.util.Collection) or withEnvironmentVariables(java.util.Collection) if you want to override the existing values.

Parameters:

environmentVariables - A set of environment variables to make available to builds for this build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

withEnvironmentVariables

public ProjectEnvironment withEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables)

A set of environment variables to make available to builds for this build project.

Parameters:

environmentVariables - A set of environment variables to make available to builds for this build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPrivilegedMode

public void setPrivilegedMode(Boolean privilegedMode)

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

Parameters:

privilegedMode - If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

getPrivilegedMode

public Boolean getPrivilegedMode()

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

Returns:

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

withPrivilegedMode

public ProjectEnvironment withPrivilegedMode(Boolean privilegedMode)

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

Parameters:

privilegedMode - If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

Returns:

Returns a reference to this object so that method calls can be chained together.

isPrivilegedMode

public Boolean isPrivilegedMode()

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

Returns:

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

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