Implementation:Treeverse LakeFS Java SDK Model HookRun
Appearance
| Knowledge Sources | |
|---|---|
| Domains | Java_SDK, Data_Model |
| Last Updated | 2026-02-08 00:00 GMT |
Overview
Concrete data transfer object representing a single hook run execution record in the lakeFS Java SDK.
Description
The HookRun class is an auto-generated model object produced by OpenAPI Generator from the lakeFS API specification. It provides type-safe access to hook run fields through getter/setter methods and supports JSON serialization via Gson. It includes a StatusEnum inner enum with values FAILED and COMPLETED.
Usage
Use this model when inspecting individual hook execution results within an action run through the lakeFS Java SDK API classes.
Code Reference
Source Location
- Repository: Treeverse_LakeFS
- File: clients/java/src/main/java/io/lakefs/clients/sdk/model/HookRun.java
- Lines: 1-493
Signature
public class HookRun {
// Fields with @SerializedName annotations
// Getter/setter methods
// equals, hashCode, toString
// JSON type adapter
}
Import
import io.lakefs.clients.sdk.model.HookRun;
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| hookRunId | String | Yes | Unique identifier for the hook run |
| action | String | Yes | Name of the action this hook belongs to |
| hookId | String | Yes | Identifier for the hook definition |
| startTime | OffsetDateTime | Yes | Timestamp when the hook run started |
| endTime | OffsetDateTime | No | Timestamp when the hook run ended |
| status | StatusEnum | Yes | Hook run status (FAILED or COMPLETED) |
Outputs
| Name | Type | Description |
|---|---|---|
| JSON | String | Serialized JSON representation |
Usage Examples
Creating an Instance
import io.lakefs.clients.sdk.model.HookRun;
HookRun obj = new HookRun();
obj.setHookRunId("hook-run-123");
obj.setAction("my-pre-commit-action");
obj.setHookId("validate-schema");
obj.setStatus(HookRun.StatusEnum.COMPLETED);
Principle
Related Pages
Page Connections
Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment