opendal/services/gcs/
config.rs

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/// [Google Cloud Storage](https://cloud.google.com/storage) services support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct GcsConfig {
29    /// root URI, all operations happens under `root`
30    pub root: Option<String>,
31    /// bucket name
32    pub bucket: String,
33    /// endpoint URI of GCS service,
34    /// default is `https://storage.googleapis.com`
35    pub endpoint: Option<String>,
36    /// Scope for gcs.
37    pub scope: Option<String>,
38    /// Service Account for gcs.
39    pub service_account: Option<String>,
40    /// Credentials string for GCS service OAuth2 authentication.
41    pub credential: Option<String>,
42    /// Local path to credentials file for GCS service OAuth2 authentication.
43    pub credential_path: Option<String>,
44    /// The predefined acl for GCS.
45    pub predefined_acl: Option<String>,
46    /// The default storage class used by gcs.
47    pub default_storage_class: Option<String>,
48    /// Allow opendal to send requests without signing when credentials are not
49    /// loaded.
50    pub allow_anonymous: bool,
51    /// Disable attempting to load credentials from the GCE metadata server when
52    /// running within Google Cloud.
53    pub disable_vm_metadata: bool,
54    /// Disable loading configuration from the environment.
55    pub disable_config_load: bool,
56    /// A Google Cloud OAuth2 token.
57    ///
58    /// Takes precedence over `credential` and `credential_path`.
59    pub token: Option<String>,
60}
61
62impl Debug for GcsConfig {
63    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
64        f.debug_struct("GcsConfig")
65            .field("root", &self.root)
66            .field("bucket", &self.bucket)
67            .field("endpoint", &self.endpoint)
68            .field("scope", &self.scope)
69            .finish_non_exhaustive()
70    }
71}
opendal/services/gcs/config.rs

opendal/services/gcs/
config.rs
