Class: Google::Cloud::ResourceSettings::V1::SettingMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb

Overview

Metadata about a setting which is not editable by the end user.

Defined Under Namespace

Modules: DataType

Instance Attribute Summary collapse

Instance Attribute Details

#data_type ⇒ ::Google::Cloud::ResourceSettings::V1::SettingMetadata::DataType

Returns The data type for this setting.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 95

class SettingMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The data type for setting values of this setting. See
  # {::Google::Cloud::ResourceSettings::V1::Value Value} for more details on the
  # available data types.
  module DataType
    # Unspecified data type.
    DATA_TYPE_UNSPECIFIED = 0

    # A boolean setting.
    BOOLEAN = 1

    # A string setting.
    STRING = 2

    # A string set setting.
    STRING_SET = 3

    # A Enum setting
    ENUM_VALUE = 4
  end
end

#default_value ⇒ ::Google::Cloud::ResourceSettings::V1::Value

Returns The value provided by Setting.effective_value if no setting value is explicitly set.

Note: not all settings have a default value.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 95

class SettingMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The data type for setting values of this setting. See
  # {::Google::Cloud::ResourceSettings::V1::Value Value} for more details on the
  # available data types.
  module DataType
    # Unspecified data type.
    DATA_TYPE_UNSPECIFIED = 0

    # A boolean setting.
    BOOLEAN = 1

    # A string setting.
    STRING = 2

    # A string set setting.
    STRING_SET = 3

    # A Enum setting
    ENUM_VALUE = 4
  end
end

#description ⇒ ::String

Returns A detailed description of what this setting does.

Returns:

  • (::String) —

    A detailed description of what this setting does.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 95

class SettingMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The data type for setting values of this setting. See
  # {::Google::Cloud::ResourceSettings::V1::Value Value} for more details on the
  # available data types.
  module DataType
    # Unspecified data type.
    DATA_TYPE_UNSPECIFIED = 0

    # A boolean setting.
    BOOLEAN = 1

    # A string setting.
    STRING = 2

    # A string set setting.
    STRING_SET = 3

    # A Enum setting
    ENUM_VALUE = 4
  end
end

#display_name ⇒ ::String

Returns The human readable name for this setting.

Returns:

  • (::String) —

    The human readable name for this setting.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 95

class SettingMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The data type for setting values of this setting. See
  # {::Google::Cloud::ResourceSettings::V1::Value Value} for more details on the
  # available data types.
  module DataType
    # Unspecified data type.
    DATA_TYPE_UNSPECIFIED = 0

    # A boolean setting.
    BOOLEAN = 1

    # A string setting.
    STRING = 2

    # A string set setting.
    STRING_SET = 3

    # A Enum setting
    ENUM_VALUE = 4
  end
end

#read_only ⇒ ::Boolean

Returns 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).



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 95

class SettingMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The data type for setting values of this setting. See
  # {::Google::Cloud::ResourceSettings::V1::Value Value} for more details on the
  # available data types.
  module DataType
    # Unspecified data type.
    DATA_TYPE_UNSPECIFIED = 0

    # A boolean setting.
    BOOLEAN = 1

    # A string setting.
    STRING = 2

    # A string set setting.
    STRING_SET = 3

    # A Enum setting
    ENUM_VALUE = 4
  end
end