Class: Google::Cloud::ResourceSettings::V1::Setting

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

The schema for settings.

Instance Attribute Summary collapse

Instance Attribute Details

#effective_value ⇒ ::Google::Cloud::ResourceSettings::V1::Value (readonly)

Returns 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
  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
  4. an empty value (defined as a Value with all fields unset)

The data type of Value must always be consistent with the data type defined in Setting.metadata.

Returns:

  • (::Google::Cloud::ResourceSettings::V1::Value) —

    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
    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
    4. an empty value (defined as a Value with all fields unset)

    The data type of Value must always be consistent with the data type defined in Setting.metadata.



69
70
71
72
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 69

class Setting
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#etag ⇒ ::String

Returns A fingerprint used for optimistic concurrency. See UpdateSetting for more details.

Returns:

  • (::String) —

    A fingerprint used for optimistic concurrency. See UpdateSetting for more details.



69
70
71
72
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 69

class Setting
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns The configured value of the setting at the given parent resource (ignoring the resource hierarchy). The data type of Value must always be consistent with the data type defined in Setting.metadata.

Returns:



69
70
71
72
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 69

class Setting
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metadata ⇒ ::Google::Cloud::ResourceSettings::V1::SettingMetadata (readonly)

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

Returns:



69
70
71
72
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 69

class Setting
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

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

Returns:

  • (::String) —

    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"



69
70
71
72
 
# File 'proto_docs/google/cloud/resourcesettings/v1/resource_settings.rb', line 69

class Setting
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end