CacheEntry class

This message is a duplicate of Build.Infra.Swarming.CacheEntry, however we will be moving from hardcoded swarming -> task backends. This message will remain as the desired CacheEntry and eventually Build.Infra.Swarming will be deprecated, so this will remain.

Describes a cache directory persisted on a bot.

If a build requested a cache, the cache directory is available on build startup. If the cache was present on the bot, the directory contains files from the previous run on that bot. The build can read/write to the cache directory while it runs. After build completes, the cache directory is persisted. The next time another build requests the same cache and runs on the same bot, the files will still be there (unless the cache was evicted, perhaps due to disk space reasons).

One bot can keep multiple caches at the same time and one build can request multiple different caches. A cache is identified by its name and mapped to a path.

If the bot is running out of space, caches are evicted in LRU manner before the next build on this bot starts.

Buildbucket implicitly declares cache {"name": "<hash(project/bucket/builder)>", "path": "builder"}. This means that any LUCI builder has a "personal disk space" on the bot. Builder cache is often a good start before customizing caching. In recipes, it is available at api.buildbucket.builder_cache_path.

To share a builder cache among multiple builders, it can be overridden:

builders { name: "a" caches { path: "builder" name: "my_shared_cache" } } builders { name: "b" caches { path: "builder" name: "my_shared_cache" } }

Builders "a" and "b" share their builder cache. If an "a" build ran on a bot and left some files in the builder cache and then a "b" build runs on the same bot, the same files will be available in the builder cache.

Inheritance

• Object
• GeneratedMessage
• CacheEntry

Constructors

CacheEntry({String? name, String? path, Duration? waitForWarmCache, String? envVar})

factory

CacheEntry.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

CacheEntry.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

envVar ↔ String

Environment variable with this name will be set to the path to the cache directory.

getter/setter pair

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

name ↔ String

Identifier of the cache. Required. Length is limited to 128. Must be unique in the build.

getter/setter pair

path ↔ String

Relative path where the cache in mapped into. Required.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

unknownFields → UnknownFieldSet

no setter, inherited

waitForWarmCache ↔ Duration

Duration to wait for a bot with a warm cache to pick up the task, before falling back to a bot with a cold (non-existent) cache.

getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void

Adds an extension field value to a repeated field.

inherited

check() → void

inherited

clear() → void

Clears all data that was set in this message.

inherited

clearEnvVar() → void

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

inherited

clearField(int tagNumber) → void

Clears the contents of a given field.

inherited

clearName() → void

clearPath() → void

clearWaitForWarmCache() → void

clone() → CacheEntry

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(CacheEntry)) → CacheEntry

Apply updates to a copy of this message.

override

createEmptyInstance() → CacheEntry

Creates an empty instance of the same message type as this.

override

createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>

Creates a Map representing a map field.

inherited

createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>

Creates List implementing a mutable repeated field.

inherited

ensureWaitForWarmCache() → Duration

extensionsAreInitialized() → bool

inherited

freeze() → GeneratedMessage

Make this message read-only.

inherited

getDefaultForField(int tagNumber) → dynamic

Returns the default value for the given field.

inherited

getExtension(Extension extension) → dynamic

Returns the value of extension.

inherited

getField(int tagNumber) → dynamic

Returns the value of the field associated with tagNumber, or the default value if it is not set.

inherited

getFieldOrNull(int tagNumber) → dynamic

Returns the value of a field, ignoring any defaults.

inherited

getTagNumber(String fieldName) → int?

inherited

hasEnvVar() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasName() → bool

hasPath() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasWaitForWarmCache() → bool

isInitialized() → bool

Whether all required fields in the message and embedded messages are set.

inherited

mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges serialized protocol buffer data into this message.

inherited

mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

inherited

mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.

inherited

mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from a JSON object represented as a Dart map.

inherited

mergeFromMessage(GeneratedMessage other) → void

Merges the contents of the other into this message.

inherited

mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void

Merges field values from json, a JSON object using proto3 encoding.

inherited

mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setExtension(Extension extension, Object value) → void

Sets the value of a non-repeated extension field to value.

inherited

setField(int tagNumber, Object value) → void

Sets the value of a field by its tagNumber.

inherited

toBuilder() → GeneratedMessage

Creates a writable, shallow copy of this message.

inherited

toDebugString() → String

Returns a String representation of this message.

inherited

toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?

Returns an Object representing Proto3 JSON serialization of this.

inherited

toString() → String

Returns a String representation of this message.

inherited

writeToBuffer() → Uint8List

inherited

writeToCodedBufferWriter(CodedBufferWriter output) → void

inherited

writeToJson() → String

Returns a JSON string that encodes this message.

inherited

writeToJsonMap() → Map<String, dynamic>

Returns the JSON encoding of this message as a Dart Map.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create() → CacheEntry

createRepeated() → PbList<CacheEntry>

getDefault() → CacheEntry