Implementation:Treeverse LakeFS Java SDK Model GarbageCollectionPrepareResponse

Knowledge Sources	Treeverse_LakeFS lakeFS API Reference
Domains	Java_SDK, Data_Model
Last Updated	2026-02-08 00:00 GMT

Overview

Concrete data transfer object representing a garbage collection preparation response in the lakeFS Java SDK.

Description

The GarbageCollectionPrepareResponse class is an auto-generated model object produced by OpenAPI Generator from the lakeFS API specification. It provides type-safe access to GC preparation result fields through getter/setter methods and supports JSON serialization via Gson.

Usage

Use this model when preparing garbage collection jobs and obtaining the commit and address locations for GC processing 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/GarbageCollectionPrepareResponse.java
• Lines: 1-387

Signature

public class GarbageCollectionPrepareResponse {
    // Fields with @SerializedName annotations
    // Getter/setter methods
    // equals, hashCode, toString
    // JSON type adapter
}

Import

import io.lakefs.clients.sdk.model.GarbageCollectionPrepareResponse;

I/O Contract

Inputs

Name	Type	Required	Description
runId	String	Yes	A unique identifier generated for this GC job
gcCommitsLocation	String	Yes	Storage location of the GC commits data
gcAddressesLocation	String	Yes	Storage location of the GC addresses data
gcCommitsPresignedUrl	String	No	Presigned URL for accessing the GC commits data

Outputs

Name	Type	Description
JSON	String	Serialized JSON representation

Usage Examples

Creating an Instance

import io.lakefs.clients.sdk.model.GarbageCollectionPrepareResponse;

GarbageCollectionPrepareResponse obj = new GarbageCollectionPrepareResponse();
obj.setRunId("gc-run-123");
obj.setGcCommitsLocation("s3://bucket/gc/commits/");
obj.setGcAddressesLocation("s3://bucket/gc/addresses/");

Principle

• Treeverse_LakeFS_Java_SDK_Data_Models

Related Pages

• Environment:Treeverse_LakeFS_LakeFS_Server_Environment