Package io.github.cdklabs.projen.gitlab

Interface Cache

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Cache.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.116Z")
@Stability(Experimental)
public interface Cache
extends software.amazon.jsii.JsiiSerializable

(experimental) Cache Definition.

See Also:

https://docs.gitlab.com/ee/ci/yaml/#cache

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Cache.Builder	A builder for Cache
static class	Cache.Jsii$Proxy	An implementation for Cache

Method Summary

Modifier and Type	Method	Description
static Cache.Builder	builder()
default List<String>	getFallbackKeys()	(experimental) Use cache:fallback_keys to specify a list of keys to try to restore cache from if there is no cache found for the cache:key.
default Object	getKey()	(experimental) Used the to give each cache a unique identifying key.
default List<String>	getPaths()	(experimental) Defines which files or directories to cache.
default CachePolicy	getPolicy()	(experimental) Defines the upload and download behaviour of the cache.
default Boolean	getUntracked()	(experimental) If set to true all files that are untracked in your Git repository will be cached.
default CacheWhen	getWhen()	(experimental) Defines when to save the cache, based on the status of the job (Default: Job Success).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFallbackKeys

@Stability(Experimental)
@Nullable
default List<String> getFallbackKeys()

(experimental) Use cache:fallback_keys to specify a list of keys to try to restore cache from if there is no cache found for the cache:key.

Caches are retrieved in the order specified in the fallback_keys section.

getKey

@Stability(Experimental)
@Nullable
default Object getKey()

(experimental) Used the to give each cache a unique identifying key.

All jobs that use the same cache key use the same cache.

getPaths

@Stability(Experimental)
@Nullable
default List<String> getPaths()

(experimental) Defines which files or directories to cache.

getPolicy

@Stability(Experimental)
@Nullable
default CachePolicy getPolicy()

(experimental) Defines the upload and download behaviour of the cache.

getUntracked

@Stability(Experimental)
@Nullable
default Boolean getUntracked()

(experimental) If set to true all files that are untracked in your Git repository will be cached.

getWhen

@Stability(Experimental)
@Nullable
default CacheWhen getWhen()

(experimental) Defines when to save the cache, based on the status of the job (Default: Job Success).

builder

@Stability(Experimental)
static Cache.Builder builder()

Returns:

a Cache.Builder of Cache