Class: DeltaCloud::Documentation::OperationParameter
- Inherits:
-
Object
- Object
- DeltaCloud::Documentation::OperationParameter
- Defined in:
- lib/deltacloud.rb
Instance Attribute Summary (collapse)
-
- (Object) description
readonly
Returns the value of attribute description.
-
- (Object) name
readonly
Returns the value of attribute name.
-
- (Object) required
readonly
Returns the value of attribute required.
-
- (Object) type
readonly
Returns the value of attribute type.
Instance Method Summary (collapse)
-
- (OperationParameter) initialize(data)
constructor
A new instance of OperationParameter.
- - (Object) to_comment
Constructor Details
- (OperationParameter) initialize(data)
A new instance of OperationParameter
463 464 465 |
# File 'lib/deltacloud.rb', line 463 def initialize(data) @name, @type, @required, @description = data[:name], data[:type], data[:required], data[:description] end |
Instance Attribute Details
- (Object) description (readonly)
Returns the value of attribute description
461 462 463 |
# File 'lib/deltacloud.rb', line 461 def description @description end |
- (Object) name (readonly)
Returns the value of attribute name
458 459 460 |
# File 'lib/deltacloud.rb', line 458 def name @name end |
- (Object) required (readonly)
Returns the value of attribute required
460 461 462 |
# File 'lib/deltacloud.rb', line 460 def required @required end |
- (Object) type (readonly)
Returns the value of attribute type
459 460 461 |
# File 'lib/deltacloud.rb', line 459 def type @type end |
Instance Method Details
- (Object) to_comment
467 468 469 |
# File 'lib/deltacloud.rb', line 467 def to_comment " # @param [#{@type}, #{@name}] #{@description}" end |