AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodeBuild::Model::ProjectCache Class Reference

#include <ProjectCache.h>

Public Member Functions

 ProjectCache ()
 
 ProjectCache (Aws::Utils::Json::JsonView jsonValue)
 
ProjectCacheoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const CacheTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const CacheType &value)
 
void SetType (CacheType &&value)
 
ProjectCacheWithType (const CacheType &value)
 
ProjectCacheWithType (CacheType &&value)
 
const Aws::StringGetLocation () const
 
bool LocationHasBeenSet () const
 
void SetLocation (const Aws::String &value)
 
void SetLocation (Aws::String &&value)
 
void SetLocation (const char *value)
 
ProjectCacheWithLocation (const Aws::String &value)
 
ProjectCacheWithLocation (Aws::String &&value)
 
ProjectCacheWithLocation (const char *value)
 
const Aws::Vector< CacheMode > & GetModes () const
 
bool ModesHasBeenSet () const
 
void SetModes (const Aws::Vector< CacheMode > &value)
 
void SetModes (Aws::Vector< CacheMode > &&value)
 
ProjectCacheWithModes (const Aws::Vector< CacheMode > &value)
 
ProjectCacheWithModes (Aws::Vector< CacheMode > &&value)
 
ProjectCacheAddModes (const CacheMode &value)
 
ProjectCacheAddModes (CacheMode &&value)
 

Detailed Description

Information about the cache for the build project.

See Also:

AWS API Reference

Definition at line 35 of file ProjectCache.h.

Constructor & Destructor Documentation

◆ ProjectCache() [1/2]

Aws::CodeBuild::Model::ProjectCache::ProjectCache ( )

◆ ProjectCache() [2/2]

Aws::CodeBuild::Model::ProjectCache::ProjectCache ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddModes() [1/2]

ProjectCache& Aws::CodeBuild::Model::ProjectCache::AddModes ( const CacheMode value)
inline

If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.

  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

    • You can use a Docker layer cache in the Linux environment only.

    • The privileged flag must be set so that your project has the required Docker permissions.

    • You should consider the security implications before you use a Docker layer cache.

  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

    • Only directories can be specified for caching. You cannot specify individual files.

    • Symlinks are used to reference cached directories.

    • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

Definition at line 363 of file ProjectCache.h.

◆ AddModes() [2/2]

ProjectCache& Aws::CodeBuild::Model::ProjectCache::AddModes ( CacheMode &&  value)
inline

If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.

  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

    • You can use a Docker layer cache in the Linux environment only.

    • The privileged flag must be set so that your project has the required Docker permissions.

    • You should consider the security implications before you use a Docker layer cache.

  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

    • Only directories can be specified for caching. You cannot specify individual files.

    • Symlinks are used to reference cached directories.

    • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

Definition at line 392 of file ProjectCache.h.

◆ GetLocation()

const Aws::String& Aws::CodeBuild::Model::ProjectCache::GetLocation ( ) const
inline

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

Definition at line 110 of file ProjectCache.h.

◆ GetModes()

const Aws::Vector<CacheMode>& Aws::CodeBuild::Model::ProjectCache::GetModes ( ) const
inline

If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.

  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

    • You can use a Docker layer cache in the Linux environment only.

    • The privileged flag must be set so that your project has the required Docker permissions.

    • You should consider the security implications before you use a Docker layer cache.

  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

    • Only directories can be specified for caching. You cannot specify individual files.

    • Symlinks are used to reference cached directories.

    • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

Definition at line 189 of file ProjectCache.h.

◆ GetType()

const CacheType& Aws::CodeBuild::Model::ProjectCache::GetType ( ) const
inline

The type of cache used by the build project. Valid values include:

  • NO_CACHE: The build project does not use any cache.

  • S3: The build project reads and writes from and to S3.

  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.

Definition at line 52 of file ProjectCache.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CodeBuild::Model::ProjectCache::Jsonize ( ) const

◆ LocationHasBeenSet()

bool Aws::CodeBuild::Model::ProjectCache::LocationHasBeenSet ( ) const
inline

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

Definition at line 117 of file ProjectCache.h.

◆ ModesHasBeenSet()

bool Aws::CodeBuild::Model::ProjectCache::ModesHasBeenSet ( ) const
inline

If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.

  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

    • You can use a Docker layer cache in the Linux environment only.

    • The privileged flag must be set so that your project has the required Docker permissions.

    • You should consider the security implications before you use a Docker layer cache.

  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

    • Only directories can be specified for caching. You cannot specify individual files.

    • Symlinks are used to reference cached directories.

    • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

Definition at line 218 of file ProjectCache.h.

◆ operator=()

ProjectCache& Aws::CodeBuild::Model::ProjectCache::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetLocation() [1/3]

void Aws::CodeBuild::Model::ProjectCache::SetLocation ( const Aws::String value)
inline

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

Definition at line 124 of file ProjectCache.h.

◆ SetLocation() [2/3]

void Aws::CodeBuild::Model::ProjectCache::SetLocation ( Aws::String &&  value)
inline

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

Definition at line 131 of file ProjectCache.h.

◆ SetLocation() [3/3]

void Aws::CodeBuild::Model::ProjectCache::SetLocation ( const char *  value)
inline

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

Definition at line 138 of file ProjectCache.h.

◆ SetModes() [1/2]

void Aws::CodeBuild::Model::ProjectCache::SetModes ( const Aws::Vector< CacheMode > &  value)
inline

If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.

  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

    • You can use a Docker layer cache in the Linux environment only.

    • The privileged flag must be set so that your project has the required Docker permissions.

    • You should consider the security implications before you use a Docker layer cache.

  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

    • Only directories can be specified for caching. You cannot specify individual files.

    • Symlinks are used to reference cached directories.

    • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

Definition at line 247 of file ProjectCache.h.

◆ SetModes() [2/2]

void Aws::CodeBuild::Model::ProjectCache::SetModes ( Aws::Vector< CacheMode > &&  value)
inline

If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.

  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

    • You can use a Docker layer cache in the Linux environment only.

    • The privileged flag must be set so that your project has the required Docker permissions.

    • You should consider the security implications before you use a Docker layer cache.

  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

    • Only directories can be specified for caching. You cannot specify individual files.

    • Symlinks are used to reference cached directories.

    • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

Definition at line 276 of file ProjectCache.h.

◆ SetType() [1/2]

void Aws::CodeBuild::Model::ProjectCache::SetType ( const CacheType value)
inline

The type of cache used by the build project. Valid values include:

  • NO_CACHE: The build project does not use any cache.

  • S3: The build project reads and writes from and to S3.

  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.

Definition at line 72 of file ProjectCache.h.

◆ SetType() [2/2]

void Aws::CodeBuild::Model::ProjectCache::SetType ( CacheType &&  value)
inline

The type of cache used by the build project. Valid values include:

  • NO_CACHE: The build project does not use any cache.

  • S3: The build project reads and writes from and to S3.

  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.

Definition at line 82 of file ProjectCache.h.

◆ TypeHasBeenSet()

bool Aws::CodeBuild::Model::ProjectCache::TypeHasBeenSet ( ) const
inline

The type of cache used by the build project. Valid values include:

  • NO_CACHE: The build project does not use any cache.

  • S3: The build project reads and writes from and to S3.

  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.

Definition at line 62 of file ProjectCache.h.

◆ WithLocation() [1/3]

ProjectCache& Aws::CodeBuild::Model::ProjectCache::WithLocation ( const Aws::String value)
inline

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

Definition at line 145 of file ProjectCache.h.

◆ WithLocation() [2/3]

ProjectCache& Aws::CodeBuild::Model::ProjectCache::WithLocation ( Aws::String &&  value)
inline

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

Definition at line 152 of file ProjectCache.h.

◆ WithLocation() [3/3]

ProjectCache& Aws::CodeBuild::Model::ProjectCache::WithLocation ( const char *  value)
inline

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

Definition at line 159 of file ProjectCache.h.

◆ WithModes() [1/2]

ProjectCache& Aws::CodeBuild::Model::ProjectCache::WithModes ( const Aws::Vector< CacheMode > &  value)
inline

If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.

  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

    • You can use a Docker layer cache in the Linux environment only.

    • The privileged flag must be set so that your project has the required Docker permissions.

    • You should consider the security implications before you use a Docker layer cache.

  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

    • Only directories can be specified for caching. You cannot specify individual files.

    • Symlinks are used to reference cached directories.

    • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

Definition at line 305 of file ProjectCache.h.

◆ WithModes() [2/2]

ProjectCache& Aws::CodeBuild::Model::ProjectCache::WithModes ( Aws::Vector< CacheMode > &&  value)
inline

If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.

  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

    • You can use a Docker layer cache in the Linux environment only.

    • The privileged flag must be set so that your project has the required Docker permissions.

    • You should consider the security implications before you use a Docker layer cache.

  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

    • Only directories can be specified for caching. You cannot specify individual files.

    • Symlinks are used to reference cached directories.

    • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

Definition at line 334 of file ProjectCache.h.

◆ WithType() [1/2]

ProjectCache& Aws::CodeBuild::Model::ProjectCache::WithType ( const CacheType value)
inline

The type of cache used by the build project. Valid values include:

  • NO_CACHE: The build project does not use any cache.

  • S3: The build project reads and writes from and to S3.

  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.

Definition at line 92 of file ProjectCache.h.

◆ WithType() [2/2]

ProjectCache& Aws::CodeBuild::Model::ProjectCache::WithType ( CacheType &&  value)
inline

The type of cache used by the build project. Valid values include:

  • NO_CACHE: The build project does not use any cache.

  • S3: The build project reads and writes from and to S3.

  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.

Definition at line 102 of file ProjectCache.h.


The documentation for this class was generated from the following file: