unitycatalog_common/models/_gen/
unitycatalog.external_locations.v1.rs

1// @generated
2// This file is @generated by prost-build.
3#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
4#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
5pub struct ExternalLocation {
6    /// Name of the external location.
7    #[prost(string, tag="1")]
8    pub name: ::prost::alloc::string::String,
9    /// Path URL of the external location.
10    #[prost(string, tag="2")]
11    pub url: ::prost::alloc::string::String,
12    /// Name of the storage credential used with this location.
13    #[prost(string, tag="3")]
14    pub credential_name: ::prost::alloc::string::String,
15    /// Indicates whether the external location is read-only.
16    #[prost(bool, tag="4")]
17    pub read_only: bool,
18    /// User-provided free-form text description.
19    #[prost(string, optional, tag="5")]
20    pub comment: ::core::option::Option<::prost::alloc::string::String>,
21    /// The owner of the external location.
22    #[prost(string, optional, tag="6")]
23    pub owner: ::core::option::Option<::prost::alloc::string::String>,
24    // metastore id
25    // string metastore_id = 7;
26
27    /// Unique ID of the location's storage credential.
28    #[prost(string, tag="8")]
29    pub credential_id: ::prost::alloc::string::String,
30    /// Time at which this catalog was created, in epoch milliseconds.
31    #[prost(int64, optional, tag="9")]
32    pub created_at: ::core::option::Option<i64>,
33    /// Username of catalog creator.
34    #[prost(string, optional, tag="10")]
35    pub created_by: ::core::option::Option<::prost::alloc::string::String>,
36    /// Time at which this catalog was last updated, in epoch milliseconds.
37    #[prost(int64, optional, tag="11")]
38    pub updated_at: ::core::option::Option<i64>,
39    /// Username of user who last modified catalog.
40    #[prost(string, optional, tag="12")]
41    pub updated_by: ::core::option::Option<::prost::alloc::string::String>,
42    /// Indicates whether the principal is limited to retrieving metadata
43    /// for the associated object through the BROWSE privilege when include_browse is enabled in the request.
44    #[prost(bool, optional, tag="13")]
45    pub browse_only: ::core::option::Option<bool>,
46    #[prost(string, optional, tag="100")]
47    pub external_location_id: ::core::option::Option<::prost::alloc::string::String>,
48}
49/// List external locations
50#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
51#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
52pub struct ListExternalLocationsRequest {
53    /// The maximum number of results per page that should be returned.
54    #[prost(int32, optional, tag="2")]
55    pub max_results: ::core::option::Option<i32>,
56    /// Opaque pagination token to go to next page based on previous query.
57    #[prost(string, optional, tag="3")]
58    pub page_token: ::core::option::Option<::prost::alloc::string::String>,
59    /// Whether to include schemas in the response for which the principal can only access selective metadata for
60    #[prost(bool, optional, tag="4")]
61    pub include_browse: ::core::option::Option<bool>,
62}
63/// List external locations response.
64#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
65#[derive(Clone, PartialEq, ::prost::Message)]
66pub struct ListExternalLocationsResponse {
67    /// The external locations returned.
68    #[prost(message, repeated, tag="1")]
69    pub external_locations: ::prost::alloc::vec::Vec<ExternalLocation>,
70    /// The next_page_token value to include in the next List request.
71    #[prost(string, optional, tag="2")]
72    pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
73}
74/// Create a new external location
75#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
76#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
77pub struct CreateExternalLocationRequest {
78    /// Name of external location.
79    #[prost(string, tag="1")]
80    pub name: ::prost::alloc::string::String,
81    /// Path URL of the external location.
82    #[prost(string, tag="2")]
83    pub url: ::prost::alloc::string::String,
84    /// Name of the storage credential used with this location.
85    #[prost(string, tag="3")]
86    pub credential_name: ::prost::alloc::string::String,
87    /// Indicates whether the external location is read-only.
88    #[prost(bool, optional, tag="4")]
89    pub read_only: ::core::option::Option<bool>,
90    /// User-provided free-form text description.
91    #[prost(string, optional, tag="5")]
92    pub comment: ::core::option::Option<::prost::alloc::string::String>,
93    /// Skips validation of the storage credential associated with the external location.
94    #[prost(bool, optional, tag="6")]
95    pub skip_validation: ::core::option::Option<bool>,
96}
97/// Get an external location
98#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
99#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
100pub struct GetExternalLocationRequest {
101    /// Name of external location.
102    #[prost(string, tag="1")]
103    pub name: ::prost::alloc::string::String,
104}
105/// Update an external location
106#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
107#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
108pub struct UpdateExternalLocationRequest {
109    /// Name of external location.
110    #[prost(string, tag="1")]
111    pub name: ::prost::alloc::string::String,
112    /// Path URL of the external location.
113    #[prost(string, optional, tag="2")]
114    pub url: ::core::option::Option<::prost::alloc::string::String>,
115    /// Name of the storage credential used with this location.
116    #[prost(string, optional, tag="3")]
117    pub credential_name: ::core::option::Option<::prost::alloc::string::String>,
118    /// Indicates whether the external location is read-only.
119    #[prost(bool, optional, tag="4")]
120    pub read_only: ::core::option::Option<bool>,
121    /// owner of the external location.
122    #[prost(string, optional, tag="5")]
123    pub owner: ::core::option::Option<::prost::alloc::string::String>,
124    /// User-provided free-form text description.
125    #[prost(string, optional, tag="6")]
126    pub comment: ::core::option::Option<::prost::alloc::string::String>,
127    /// new name of the external location.
128    #[prost(string, optional, tag="7")]
129    pub new_name: ::core::option::Option<::prost::alloc::string::String>,
130    /// force update of the external location.
131    #[prost(bool, optional, tag="8")]
132    pub force: ::core::option::Option<bool>,
133    /// Skips validation of the storage credential associated with the external location.
134    #[prost(bool, optional, tag="9")]
135    pub skip_validation: ::core::option::Option<bool>,
136}
137/// Delete an external location
138#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
139#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
140pub struct DeleteExternalLocationRequest {
141    /// Name of external location.
142    #[prost(string, tag="1")]
143    pub name: ::prost::alloc::string::String,
144    /// Force deletion even if the external location is not empty.
145    #[prost(bool, optional, tag="2")]
146    pub force: ::core::option::Option<bool>,
147}
148include!("unitycatalog.external_locations.v1.serde.rs");
149// @@protoc_insertion_point(module)
unitycatalog_common/models/_gen/unitycatalog.external_locations.v1.rs

unitycatalog_common/models/_gen/
unitycatalog.external_locations.v1.rs
