Skip to content

Commit 12f2fe9

Browse files
authored
Add Notation to BuildRuntimeInfo in pkg/ddc/base/runtime.go (#5854)
Signed-off-by: Hanxian Lao <1687483153@qq.com>
1 parent 275d56b commit 12f2fe9

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

pkg/ddc/base/runtime.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,18 @@ type CachePath struct {
172172
Quota *resource.Quantity
173173
}
174174

175+
// BuildRuntimeInfo creates and initializes a RuntimeInfoInterface instance with the specified name, namespace, and runtime type.
176+
// It applies any number of optional configuration functions (opts) to customize the runtime information before returning.
177+
//
178+
// Parameters:
179+
// - name (string): The name of the runtime.
180+
// - namespace (string): The namespace of the runtime.
181+
// - runtimeType (string): The type of the runtime (e.g., Alluxio, JuiceFS).
182+
// - opts (...RuntimeInfoOption): Optional configuration functions that modify the RuntimeInfo struct.
183+
//
184+
// Returns:
185+
// - runtime (RuntimeInfoInterface): A fully configured runtime information object.
186+
// - err (error): Returns an error if any of the provided options fails to apply.
175187
func BuildRuntimeInfo(name string,
176188
namespace string,
177189
runtimeType string,

0 commit comments

Comments
 (0)