ProjectCache (AWS SDK for Java

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

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProjectCache()

Constructors
Constructor and Description
`ProjectCache()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProjectCache`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getLocation()` Information about the cache location:
`List<String>`	`getModes()` An array of strings that specify the local cache modes.
`String`	`getType()` The type of cache used by the build project.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setLocation(String location)` Information about the cache location:
`void`	`setModes(Collection<String> modes)` An array of strings that specify the local cache modes.
`void`	`setType(String type)` The type of cache used by the build project.
`String`	`toString()` Returns a string representation of this object.
`ProjectCache`	`withLocation(String location)` Information about the cache location:
`ProjectCache`	`withModes(CacheMode... modes)` An array of strings that specify the local cache modes.
`ProjectCache`	`withModes(Collection<String> modes)` An array of strings that specify the local cache modes.
`ProjectCache`	`withModes(String... modes)` An array of strings that specify the local cache modes.
`ProjectCache`	`withType(CacheType type)` The type of cache used by the build project.
`ProjectCache`	`withType(String type)` The type of cache used by the build project.

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

- Constructor Detail
  - ProjectCache
```
public ProjectCache()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    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.
    Parameters:
    type - 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.
    See Also:
    
    CacheType
  - getType
```
public String getType()
```
    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.
    Returns:
    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.
    See Also:
    
    CacheType
  - withType
```
public ProjectCache withType(String type)
```
    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.
    Parameters:
    type - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CacheType
  - withType
```
public ProjectCache withType(CacheType type)
```
    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.
    Parameters:
    type - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CacheType
  - setLocation
```
public void setLocation(String location)
```
    Information about the cache location:
    - NO_CACHE or LOCAL: This value is ignored.
    - S3: This is the S3 bucket name/prefix.
    Parameters:
    location - Information about the cache location:
    
    NO_CACHE or LOCAL: This value is ignored.
    
    S3: This is the S3 bucket name/prefix.
  - getLocation
```
public String getLocation()
```
    Information about the cache location:
    - NO_CACHE or LOCAL: This value is ignored.
    - S3: This is the S3 bucket name/prefix.
    Returns:
    Information about the cache location:
    
    NO_CACHE or LOCAL: This value is ignored.
    
    S3: This is the S3 bucket name/prefix.
  - withLocation
```
public ProjectCache withLocation(String location)
```
    Information about the cache location:
    - NO_CACHE or LOCAL: This value is ignored.
    - S3: This is the S3 bucket name/prefix.
    Parameters:
    location - Information about the cache location:
    
    NO_CACHE or LOCAL: This value is ignored.
    
    S3: This is the S3 bucket name/prefix.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getModes
```
public List<String> getModes()
```
    An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    Returns:
    An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    See Also:
    
    CacheMode
  - setModes
```
public void setModes(Collection<String> modes)
```
    An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    Parameters:
    modes - An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    See Also:
    
    CacheMode
  - withModes
```
public ProjectCache withModes(String... modes)
```
    An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    NOTE: This method appends the values to the existing list (if any). Use setModes(java.util.Collection) or withModes(java.util.Collection) if you want to override the existing values.
    Parameters:
    modes - An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CacheMode
  - withModes
```
public ProjectCache withModes(Collection<String> modes)
```
    An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    Parameters:
    modes - An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CacheMode
  - withModes
```
public ProjectCache withModes(CacheMode... modes)
```
    An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    Parameters:
    modes - An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
    
    Possible values are:
    
    LOCAL_SOURCE_CACHE
    
    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
    
    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
    
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CacheMode
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 ProjectCache 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.

AWS SDK for Java 1.x API Reference - 1.12.771

Class ProjectCache

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectCache

Method Detail

setType

getType

withType

withType

setLocation

getLocation

withLocation

getModes

setModes

withModes

withModes

withModes

toString

equals

hashCode

clone

marshall