/// The schema for settings. #[derive(Clone, PartialEq, ::prost::Message)] pub struct Setting { /// The resource name of the setting. Must be in one of the following forms: /// /// * `projects/{project_number}/settings/{setting_name}` /// * `folders/{folder_id}/settings/{setting_name}` /// * `organizations/{organization_id}/settings/{setting_name}` /// /// For example, "/projects/123/settings/gcp-enableMyFeature" #[prost(string, tag = "1")] pub name: ::prost::alloc::string::String, /// Output only. Metadata about a setting which is not editable by the end user. #[prost(message, optional, tag = "7")] pub metadata: ::core::option::Option, /// The configured value of the setting at the given parent resource (ignoring /// the resource hierarchy). The data type of \[Value][google.cloud.resourcesettings.v1.Value\] must always be /// consistent with the data type defined in \[Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata\]. #[prost(message, optional, tag = "8")] pub local_value: ::core::option::Option, /// Output only. The computed effective value of the setting at the given parent resource /// (based on the resource hierarchy). /// /// The effective value evaluates to one of the following options in the given /// order (the next option is used if the previous one does not exist): /// /// 1. the local setting value on the given resource: \[Setting.local_value][google.cloud.resourcesettings.v1.Setting.local_value\] /// 2. if one of the given resource's ancestors have a local setting value, /// the local value at the nearest such ancestor /// 3. the setting's default value: \[SettingMetadata.default_value][google.cloud.resourcesettings.v1.SettingMetadata.default_value\] /// 4. an empty value (defined as a `Value` with all fields unset) /// /// The data type of \[Value][google.cloud.resourcesettings.v1.Value\] must always be /// consistent with the data type defined in \[Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata\]. #[prost(message, optional, tag = "9")] pub effective_value: ::core::option::Option, /// A fingerprint used for optimistic concurrency. See /// \[UpdateSetting][google.cloud.resourcesettings.v1.ResourceSettingsService.UpdateSetting\] for more /// details. #[prost(string, tag = "10")] pub etag: ::prost::alloc::string::String, } /// Metadata about a setting which is not editable by the end user. #[derive(Clone, PartialEq, ::prost::Message)] pub struct SettingMetadata { /// The human readable name for this setting. #[prost(string, tag = "1")] pub display_name: ::prost::alloc::string::String, /// A detailed description of what this setting does. #[prost(string, tag = "2")] pub description: ::prost::alloc::string::String, /// A flag indicating that values of this setting cannot be modified (see /// documentation of the specific setting for updates and reasons). #[prost(bool, tag = "3")] pub read_only: bool, /// The data type for this setting. #[prost(enumeration = "setting_metadata::DataType", tag = "4")] pub data_type: i32, /// The value provided by \[Setting.effective_value][google.cloud.resourcesettings.v1.Setting.effective_value\] if no setting value is /// explicitly set. /// /// Note: not all settings have a default value. #[prost(message, optional, tag = "5")] pub default_value: ::core::option::Option, } /// Nested message and enum types in `SettingMetadata`. pub mod setting_metadata { /// The data type for setting values of this setting. See \[Value][google.cloud.resourcesettings.v1.Value\] for more /// details on the available data types. #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] #[repr(i32)] pub enum DataType { /// Unspecified data type. Unspecified = 0, /// A boolean setting. Boolean = 1, /// A string setting. String = 2, /// A string set setting. StringSet = 3, /// A Enum setting EnumValue = 4, } } /// The data in a setting value. #[derive(Clone, PartialEq, ::prost::Message)] pub struct Value { /// Selects the data type and associated value. #[prost(oneof = "value::Value", tags = "1, 2, 3, 4")] pub value: ::core::option::Option, } /// Nested message and enum types in `Value`. pub mod value { /// A string set value that can hold a set of strings. The maximum length of /// each string is 200 characters and there can be a maximum of 50 strings in /// the string set. #[derive(Clone, PartialEq, ::prost::Message)] pub struct StringSet { /// The strings in the set #[prost(string, repeated, tag = "1")] pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>, } /// A enum value that can hold any enum type setting values. /// Each enum type is represented by a number, this representation /// is stored in the definitions. #[derive(Clone, PartialEq, ::prost::Message)] pub struct EnumValue { /// The value of this enum #[prost(string, tag = "1")] pub value: ::prost::alloc::string::String, } /// Selects the data type and associated value. #[derive(Clone, PartialEq, ::prost::Oneof)] pub enum Value { /// Defines this value as being a boolean value. #[prost(bool, tag = "1")] BooleanValue(bool), /// Defines this value as being a string value. #[prost(string, tag = "2")] StringValue(::prost::alloc::string::String), /// Defines this value as being a StringSet. #[prost(message, tag = "3")] StringSetValue(StringSet), /// Defines this value as being a Enum. #[prost(message, tag = "4")] EnumValue(EnumValue), } } /// The request for ListSettings. #[derive(Clone, PartialEq, ::prost::Message)] pub struct ListSettingsRequest { /// Required. The Cloud resource that parents the setting. Must be in one of the /// following forms: /// /// * `projects/{project_number}` /// * `projects/{project_id}` /// * `folders/{folder_id}` /// * `organizations/{organization_id}` #[prost(string, tag = "1")] pub parent: ::prost::alloc::string::String, /// Unused. The size of the page to be returned. #[prost(int32, tag = "2")] pub page_size: i32, /// Unused. A page token used to retrieve the next page. #[prost(string, tag = "3")] pub page_token: ::prost::alloc::string::String, /// The SettingView for this request. #[prost(enumeration = "SettingView", tag = "4")] pub view: i32, } /// The response from ListSettings. #[derive(Clone, PartialEq, ::prost::Message)] pub struct ListSettingsResponse { /// A list of settings that are available at the specified Cloud resource. #[prost(message, repeated, tag = "1")] pub settings: ::prost::alloc::vec::Vec, /// Unused. A page token used to retrieve the next page. #[prost(string, tag = "2")] pub next_page_token: ::prost::alloc::string::String, } /// The request for GetSetting. #[derive(Clone, PartialEq, ::prost::Message)] pub struct GetSettingRequest { /// Required. The name of the setting to get. See \[Setting][google.cloud.resourcesettings.v1.Setting\] for naming /// requirements. #[prost(string, tag = "1")] pub name: ::prost::alloc::string::String, /// The SettingView for this request. #[prost(enumeration = "SettingView", tag = "2")] pub view: i32, } /// The request for UpdateSetting. #[derive(Clone, PartialEq, ::prost::Message)] pub struct UpdateSettingRequest { /// Required. The setting to update. See \[Setting][google.cloud.resourcesettings.v1.Setting\] for field requirements. #[prost(message, optional, tag = "1")] pub setting: ::core::option::Option, } /// View options for Settings. #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)] #[repr(i32)] pub enum SettingView { /// The default / unset value. /// The API will default to the SETTING_VIEW_BASIC view. Unspecified = 0, /// Include \[Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata\], but nothing else. /// This is the default value (for both ListSettings and GetSetting). Basic = 1, /// Include \[Setting.effective_value][google.cloud.resourcesettings.v1.Setting.effective_value\], but nothing else. EffectiveValue = 2, /// Include \[Setting.local_value][google.cloud.resourcesettings.v1.Setting.local_value\], but nothing else. LocalValue = 3, } #[doc = r" Generated client implementations."] pub mod resource_settings_service_client { #![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)] use tonic::codegen::*; #[doc = " An interface to interact with resource settings and setting values throughout"] #[doc = " the resource hierarchy."] #[doc = ""] #[doc = " Services may surface a number of settings for users to control how their"] #[doc = " resources behave. Values of settings applied on a given Cloud resource are"] #[doc = " evaluated hierarchically and inherited by all descendants of that resource."] #[doc = ""] #[doc = " For all requests, returns a `google.rpc.Status` with"] #[doc = " `google.rpc.Code.PERMISSION_DENIED` if the IAM check fails or the `parent`"] #[doc = " resource is not in a Cloud Organization."] #[doc = " For all requests, returns a `google.rpc.Status` with"] #[doc = " `google.rpc.Code.INVALID_ARGUMENT` if the request is malformed."] #[derive(Debug, Clone)] pub struct ResourceSettingsServiceClient { inner: tonic::client::Grpc, } impl ResourceSettingsServiceClient where T: tonic::client::GrpcService, T::ResponseBody: Body + Send + 'static, T::Error: Into, ::Error: Into + Send, { pub fn new(inner: T) -> Self { let inner = tonic::client::Grpc::new(inner); Self { inner } } pub fn with_interceptor( inner: T, interceptor: F, ) -> ResourceSettingsServiceClient> where F: tonic::service::Interceptor, T: tonic::codegen::Service< http::Request, Response = http::Response< >::ResponseBody, >, >, >>::Error: Into + Send + Sync, { ResourceSettingsServiceClient::new(InterceptedService::new(inner, interceptor)) } #[doc = r" Compress requests with `gzip`."] #[doc = r""] #[doc = r" This requires the server to support it otherwise it might respond with an"] #[doc = r" error."] pub fn send_gzip(mut self) -> Self { self.inner = self.inner.send_gzip(); self } #[doc = r" Enable decompressing responses with `gzip`."] pub fn accept_gzip(mut self) -> Self { self.inner = self.inner.accept_gzip(); self } #[doc = " Lists all the settings that are available on the Cloud resource `parent`."] pub async fn list_settings( &mut self, request: impl tonic::IntoRequest, ) -> Result, tonic::Status> { self.inner.ready().await.map_err(|e| { tonic::Status::new( tonic::Code::Unknown, format!("Service was not ready: {}", e.into()), ) })?; let codec = tonic::codec::ProstCodec::default(); let path = http::uri::PathAndQuery::from_static( "/google.cloud.resourcesettings.v1.ResourceSettingsService/ListSettings", ); self.inner.unary(request.into_request(), path, codec).await } #[doc = " Gets a setting."] #[doc = ""] #[doc = " Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the"] #[doc = " setting does not exist."] pub async fn get_setting( &mut self, request: impl tonic::IntoRequest, ) -> Result, tonic::Status> { self.inner.ready().await.map_err(|e| { tonic::Status::new( tonic::Code::Unknown, format!("Service was not ready: {}", e.into()), ) })?; let codec = tonic::codec::ProstCodec::default(); let path = http::uri::PathAndQuery::from_static( "/google.cloud.resourcesettings.v1.ResourceSettingsService/GetSetting", ); self.inner.unary(request.into_request(), path, codec).await } #[doc = " Updates a setting."] #[doc = ""] #[doc = " Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the"] #[doc = " setting does not exist."] #[doc = " Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if"] #[doc = " the setting is flagged as read only."] #[doc = " Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag"] #[doc = " supplied in the request does not match the persisted etag of the setting"] #[doc = " value."] #[doc = ""] #[doc = " On success, the response will contain only `name`, `local_value` and"] #[doc = " `etag`. The `metadata` and `effective_value` cannot be updated through"] #[doc = " this API."] #[doc = ""] #[doc = " Note: the supplied setting will perform a full overwrite of the"] #[doc = " `local_value` field."] pub async fn update_setting( &mut self, request: impl tonic::IntoRequest, ) -> Result, tonic::Status> { self.inner.ready().await.map_err(|e| { tonic::Status::new( tonic::Code::Unknown, format!("Service was not ready: {}", e.into()), ) })?; let codec = tonic::codec::ProstCodec::default(); let path = http::uri::PathAndQuery::from_static( "/google.cloud.resourcesettings.v1.ResourceSettingsService/UpdateSetting", ); self.inner.unary(request.into_request(), path, codec).await } } }