Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Update a build cache

Updates a build cache.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Updates a build cache.

Not available yet. Sylphx Build is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

  • Path PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache
  • Scope build:write
  • Effect write — a successful call changes state.
  • Collection build_caches
  • Query update_mask, allow_missing, validate_only

#Request

FieldTypeWhat it is
build_cacheBuildCacheThe build cache to update; name identifies it. Required.
update_maskfield_maskThe fields to write; unset writes every populated field.
allow_missingboolCreate the Resource when it does not exist (declarative upsert).
validate_onlyboolValidate and return the result without writing anything.

#BuildCache

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/build_caches/{build_cache}.
metaResourceMetaResource metadata.
specBuildCacheSpecDesired state. Required.

#ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

#BuildCacheSpec

FieldTypeWhat it is
retentiondurationEntries unused this long are evicted; default 7 days.

#Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/build_caches/{build_cache}.
uidstringbch_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specBuildCacheSpecDesired state. Required.
statusBuildCacheStatusObserved state. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#BuildCacheSpec

FieldTypeWhat it is
retentiondurationEntries unused this long are evicted; default 7 days.

#BuildCacheStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
size_bytesint64Bytes stored. Output only.
last_use_timetimestampWhen a build last read the cache. Output only.

#Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/build_caches/build-cache","spec":{}}'