Class: LogStash::Setting::DeprecatedAndRenamed

Inherits:

DeprecatedSetting

• Object
• LogStash::Setting
• DeprecatedSetting
• LogStash::Setting::DeprecatedAndRenamed

Defined in:

lib/logstash/settings.rb

Overview

Useful when a setting has been renamed but otherwise is semantically identical

Instance Attribute Summary

• #new_name ⇒ Object readonly

  Returns the value of attribute new_name.

Attributes inherited from LogStash::Setting

#default, #name

Instance Method Summary

• #initialize(name, new_name) ⇒ DeprecatedAndRenamed constructor

  A new instance of DeprecatedAndRenamed.

Methods inherited from DeprecatedSetting

#set

Methods inherited from LogStash::Setting

#==, #reset, #set, #set?, #strict?, #to_hash, #validate_value, #value

Constructor Details

#initialize(name, new_name) ⇒ DeprecatedAndRenamed

Returns a new instance of DeprecatedAndRenamed.

# File 'lib/logstash/settings.rb', line 608

def initialize(name, new_name)
  super(name, "please update your configuration to use `#{new_name}` instead.")
  @new_name = new_name
end

Instance Attribute Details

#new_name ⇒ Object (readonly)

Returns the value of attribute new_name.

# File 'lib/logstash/settings.rb', line 607

def new_name
  @new_name
end