opendal/services/lakefs/
config.rs

Help
1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::Debug;
19use std::fmt::Formatter;
20
21use serde::Deserialize;
22use serde::Serialize;
23
24/// Configuration for Lakefs service support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct LakefsConfig {
29    /// Base url.
30    ///
31    /// This is required.
32    pub endpoint: Option<String>,
33    /// Username for Lakefs basic authentication.
34    ///
35    /// This is required.
36    pub username: Option<String>,
37    /// Password for Lakefs basic authentication.
38    ///
39    /// This is required.
40    pub password: Option<String>,
41    /// Root of this backend. Can be "/path/to/dir".
42    ///
43    /// Default is "/".
44    pub root: Option<String>,
45
46    /// The repository name
47    ///
48    /// This is required.
49    pub repository: Option<String>,
50    /// Name of the branch or a commit ID. Default is main.
51    ///
52    /// This is optional.
53    pub branch: Option<String>,
54}
55
56impl Debug for LakefsConfig {
57    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
58        let mut ds = f.debug_struct("LakefsConfig");
59
60        if let Some(endpoint) = &self.endpoint {
61            ds.field("endpoint", &endpoint);
62        }
63        if let Some(_username) = &self.username {
64            ds.field("username", &"<redacted>");
65        }
66        if let Some(_password) = &self.password {
67            ds.field("password", &"<redacted>");
68        }
69        if let Some(root) = &self.root {
70            ds.field("root", &root);
71        }
72        if let Some(repository) = &self.repository {
73            ds.field("repository", &repository);
74        }
75        if let Some(branch) = &self.branch {
76            ds.field("branch", &branch);
77        }
78
79        ds.finish()
80    }
81}
opendal/services/lakefs/config.rs

opendal/services/lakefs/
config.rs
