Class LogEntry.Builder
- All Implemented Interfaces:
LogEntry._FinalStage,LogEntry.MethodStage,LogEntry.ResourceStage,LogEntry.StatusStage,LogEntry.TimestampStage
- Enclosing class:
LogEntry
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) build()The app context the request operated under — the context partition the credential carried.The app context the request operated under — the context partition the credential carried.The app context the request operated under — the context partition the credential carried.delegationChain(Nullable<String> delegationChain) A JSON-encoded record of who delegated the credential that made this call, present only when the request was made under a key minted via thedelegate-mintcapability (seePOST /v1/admin/keys/scoped).delegationChain(String delegationChain) A JSON-encoded record of who delegated the credential that made this call, present only when the request was made under a key minted via thedelegate-mintcapability (seePOST /v1/admin/keys/scoped).delegationChain(Optional<String> delegationChain) A JSON-encoded record of who delegated the credential that made this call, present only when the request was made under a key minted via thedelegate-mintcapability (seePOST /v1/admin/keys/scoped).durationMs(Long durationMs) Total request duration in milliseconds, from auth to response completion.durationMs(Optional<Long> durationMs) Total request duration in milliseconds, from auth to response completion.Error code explaining WHY a failed call was rejected, when the failure had a typed code — one ofRATE_LIMITED,SUBSCRIPTION_LIMIT_EXCEEDED,INSUFFICIENT_BALANCE,RESOURCE_IN_USE,VERSION_CONFLICT,SESSION_REFRESH_REQUIRED,WRITE_FROZEN,UNSUPPORTED_WIRE_VERSION.Error code explaining WHY a failed call was rejected, when the failure had a typed code — one ofRATE_LIMITED,SUBSCRIPTION_LIMIT_EXCEEDED,INSUFFICIENT_BALANCE,RESOURCE_IN_USE,VERSION_CONFLICT,SESSION_REFRESH_REQUIRED,WRITE_FROZEN,UNSUPPORTED_WIRE_VERSION.Error code explaining WHY a failed call was rejected, when the failure had a typed code — one ofRATE_LIMITED,SUBSCRIPTION_LIMIT_EXCEEDED,INSUFFICIENT_BALANCE,RESOURCE_IN_USE,VERSION_CONFLICT,SESSION_REFRESH_REQUIRED,WRITE_FROZEN,UNSUPPORTED_WIRE_VERSION.ID of the API key or scoped token that issued the request.ID of the API key or scoped token that issued the request.ID of the API key or scoped token that issued the request.HTTP method of the request.Full request path.Full request path.Correlation id for this call.Correlation id for this call.Correlation id for this call.Top-level resource the call targeted, derived from the request path — for exampledocuments,records,search,schemas,folders,entities,namespaces,users,usage,auth,models,ping,rag,chat,ask,erasure-requests, orexport.status(int status) HTTP response status code.When the API call completed (ISO-8601 UTC).
-
Method Details
-
from
- Specified by:
fromin interfaceLogEntry.TimestampStage
-
timestamp
When the API call completed (ISO-8601 UTC).
When the API call completed (ISO-8601 UTC).
- Specified by:
timestampin interfaceLogEntry.TimestampStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
method
HTTP method of the request.
HTTP method of the request.
- Specified by:
methodin interfaceLogEntry.MethodStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
resource
Top-level resource the call targeted, derived from the request path — for example
documents,records,search,schemas,folders,entities,namespaces,users,usage,auth,models,ping,rag,chat,ask,erasure-requests, orexport. Rows may also carry values that are not filterable via theresourcequery parameter, andclients/orgsappear on rows written before those identity surfaces were folded intoentities.Top-level resource the call targeted, derived from the request path — for example
documents,records,search,schemas,folders,entities,namespaces,users,usage,auth,models,ping,rag,chat,ask,erasure-requests, orexport. Rows may also carry values that are not filterable via theresourcequery parameter, andclients/orgsappear on rows written before those identity surfaces were folded intoentities.- Specified by:
resourcein interfaceLogEntry.ResourceStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
status
HTTP response status code.
HTTP response status code.
- Specified by:
statusin interfaceLogEntry.StatusStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
delegationChain
A JSON-encoded record of who delegated the credential that made this call, present only when the request was made under a key minted via the
delegate-mintcapability (seePOST /v1/admin/keys/scoped). Null for the overwhelming majority of calls, which carry no delegation.- Specified by:
delegationChainin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
delegationChain
A JSON-encoded record of who delegated the credential that made this call, present only when the request was made under a key minted via the
delegate-mintcapability (seePOST /v1/admin/keys/scoped). Null for the overwhelming majority of calls, which carry no delegation.- Specified by:
delegationChainin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
delegationChain
A JSON-encoded record of who delegated the credential that made this call, present only when the request was made under a key minted via the
delegate-mintcapability (seePOST /v1/admin/keys/scoped). Null for the overwhelming majority of calls, which carry no delegation.- Specified by:
delegationChainin interfaceLogEntry._FinalStage
-
errorCode
Error code explaining WHY a failed call was rejected, when the failure had a typed code — one of
RATE_LIMITED,SUBSCRIPTION_LIMIT_EXCEEDED,INSUFFICIENT_BALANCE,RESOURCE_IN_USE,VERSION_CONFLICT,SESSION_REFRESH_REQUIRED,WRITE_FROZEN,UNSUPPORTED_WIRE_VERSION. Null for successful calls, for failures that carry only a message, and for calls recorded before this release that are still within your log retention window. Request and response bodies are never logged, so no further detail is available here by design.- Specified by:
errorCodein interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
errorCode
Error code explaining WHY a failed call was rejected, when the failure had a typed code — one of
RATE_LIMITED,SUBSCRIPTION_LIMIT_EXCEEDED,INSUFFICIENT_BALANCE,RESOURCE_IN_USE,VERSION_CONFLICT,SESSION_REFRESH_REQUIRED,WRITE_FROZEN,UNSUPPORTED_WIRE_VERSION. Null for successful calls, for failures that carry only a message, and for calls recorded before this release that are still within your log retention window. Request and response bodies are never logged, so no further detail is available here by design.- Specified by:
errorCodein interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
errorCode
Error code explaining WHY a failed call was rejected, when the failure had a typed code — one of
RATE_LIMITED,SUBSCRIPTION_LIMIT_EXCEEDED,INSUFFICIENT_BALANCE,RESOURCE_IN_USE,VERSION_CONFLICT,SESSION_REFRESH_REQUIRED,WRITE_FROZEN,UNSUPPORTED_WIRE_VERSION. Null for successful calls, for failures that carry only a message, and for calls recorded before this release that are still within your log retention window. Request and response bodies are never logged, so no further detail is available here by design.- Specified by:
errorCodein interfaceLogEntry._FinalStage
-
requestId
Correlation id for this call. Quote it when contacting support so the call can be traced. Most useful on failures, but recorded for successful calls too. Where an error response body carries a
requestId, it is this same id.- Specified by:
requestIdin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
requestId
Correlation id for this call. Quote it when contacting support so the call can be traced. Most useful on failures, but recorded for successful calls too. Where an error response body carries a
requestId, it is this same id.- Specified by:
requestIdin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
requestId
Correlation id for this call. Quote it when contacting support so the call can be traced. Most useful on failures, but recorded for successful calls too. Where an error response body carries a
requestId, it is this same id.- Specified by:
requestIdin interfaceLogEntry._FinalStage
-
path
Full request path.
- Specified by:
pathin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
path
Full request path.
- Specified by:
pathin interfaceLogEntry._FinalStage
-
durationMs
Total request duration in milliseconds, from auth to response completion.
- Specified by:
durationMsin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
durationMs
Total request duration in milliseconds, from auth to response completion.
- Specified by:
durationMsin interfaceLogEntry._FinalStage
-
keyId
ID of the API key or scoped token that issued the request. Null if the request was unauthenticated (extremely rare — most paths require auth before logging).
- Specified by:
keyIdin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
keyId
ID of the API key or scoped token that issued the request. Null if the request was unauthenticated (extremely rare — most paths require auth before logging).
- Specified by:
keyIdin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
keyId
ID of the API key or scoped token that issued the request. Null if the request was unauthenticated (extremely rare — most paths require auth before logging).
- Specified by:
keyIdin interfaceLogEntry._FinalStage
-
contextId
The app context the request operated under — the context partition the credential carried.
*for a root/cross-context caller. Null for older log lines or for entry points that are not context-scoped.- Specified by:
contextIdin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
contextId
The app context the request operated under — the context partition the credential carried.
*for a root/cross-context caller. Null for older log lines or for entry points that are not context-scoped.- Specified by:
contextIdin interfaceLogEntry._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
contextId
The app context the request operated under — the context partition the credential carried.
*for a root/cross-context caller. Null for older log lines or for entry points that are not context-scoped.- Specified by:
contextIdin interfaceLogEntry._FinalStage
-
build
- Specified by:
buildin interfaceLogEntry._FinalStage
-
additionalProperty
- Specified by:
additionalPropertyin interfaceLogEntry._FinalStage
-
additionalProperties
- Specified by:
additionalPropertiesin interfaceLogEntry._FinalStage
-