Class: Groonga::Command::ObjectRemove

Inherits:
Base
  • Object
show all
Defined in:
lib/groonga/command/object-remove.rb

Overview

A command class that represents object_remove command.

Since:

  • 1.1.7

Instance Attribute Summary

Attributes inherited from Base

#arguments, #command_name, #original_format, #original_source, #path_prefix

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#==, #[], #[]=, #command_format?, #initialize, #key?, #output_type, #request_id, #to_command_format, #to_uri_format, #uri_format?

Constructor Details

This class inherits a constructor from Groonga::Command::Base

Class Method Details

.command_name ⇒ Object

Since:

  • 1.1.7



26
27
28
 
# File 'lib/groonga/command/object-remove.rb', line 26

def command_name
  "object_remove"
end

.parameter_names ⇒ Object

Since:

  • 1.1.7



30
31
32
33
34
35
 
# File 'lib/groonga/command/object-remove.rb', line 30

def parameter_names
  [
    :name,
    :force,
  ]
end

Instance Method Details

#force? ⇒ Boolean

Returns Whether force to remove the object or not.

Returns:

  • (Boolean) —

    Whether force to remove the object or not.

Since:

  • 1.1.7



50
51
52
 
# File 'lib/groonga/command/object-remove.rb', line 50

def force?
  self[:force] == "yes"
end

#name ⇒ String

Returns The object name to be removed.

Returns:

  • (String) —

    The object name to be removed.

Since:

  • 1.1.7



43
44
45
 
# File 'lib/groonga/command/object-remove.rb', line 43

def name
  self[:name]
end