Reference documentation and code samples for the Resource Settings V1 API class Google::Cloud::ResourceSettings::V1::SettingMetadata.
Metadata about a setting which is not editable by the end user.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#data_type
def data_type() -> ::Google::Cloud::ResourceSettings::V1::SettingMetadata::DataType
Returns
- (::Google::Cloud::ResourceSettings::V1::SettingMetadata::DataType) — The data type for this setting.
#data_type=
def data_type=(value) -> ::Google::Cloud::ResourceSettings::V1::SettingMetadata::DataType
Parameter
- value (::Google::Cloud::ResourceSettings::V1::SettingMetadata::DataType) — The data type for this setting.
Returns
- (::Google::Cloud::ResourceSettings::V1::SettingMetadata::DataType) — The data type for this setting.
#default_value
def default_value() -> ::Google::Cloud::ResourceSettings::V1::Value
Returns
-
(::Google::Cloud::ResourceSettings::V1::Value) — The value provided by
Setting.effective_value
if no setting value is explicitly set.
Note: not all settings have a default value.
#default_value=
def default_value=(value) -> ::Google::Cloud::ResourceSettings::V1::Value
Parameter
-
value (::Google::Cloud::ResourceSettings::V1::Value) — The value provided by
Setting.effective_value
if no setting value is explicitly set.
Note: not all settings have a default value.
Returns
-
(::Google::Cloud::ResourceSettings::V1::Value) — The value provided by
Setting.effective_value
if no setting value is explicitly set.
Note: not all settings have a default value.
#description
def description() -> ::String
Returns
- (::String) — A detailed description of what this setting does.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — A detailed description of what this setting does.
Returns
- (::String) — A detailed description of what this setting does.
#display_name
def display_name() -> ::String
Returns
- (::String) — The human readable name for this setting.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — The human readable name for this setting.
Returns
- (::String) — The human readable name for this setting.
#read_only
def read_only() -> ::Boolean
Returns
- (::Boolean) — A flag indicating that values of this setting cannot be modified (see documentation of the specific setting for updates and reasons).
#read_only=
def read_only=(value) -> ::Boolean
Parameter
- value (::Boolean) — A flag indicating that values of this setting cannot be modified (see documentation of the specific setting for updates and reasons).
Returns
- (::Boolean) — A flag indicating that values of this setting cannot be modified (see documentation of the specific setting for updates and reasons).