Class: Seahorse::Model::Operation
- Inherits:
-
Object
- Object
- Seahorse::Model::Operation
- Defined in:
- lib/seahorse/model/operation.rb
Instance Attribute Summary collapse
- #definition ⇒ Hash readonly
- #documentation ⇒ String<HTML>? readonly
- #http_method ⇒ String readonly
- #http_request_uri ⇒ String readonly
- #input ⇒ Shape? readonly
- #name ⇒ String readonly
- #output ⇒ Shape? readonly
- #paging ⇒ Hash readonly
Instance Method Summary collapse
-
#deprecated? ⇒ Boolean
Returns ‘true` if this API operation is deprecated.
-
#errors ⇒ Enumerator
Returns an enumerator that yields error shapes.
-
#initialize(definition = {}, options = {}) ⇒ Operation
constructor
A new instance of Operation.
Constructor Details
#initialize(definition = {}, options = {}) ⇒ Operation
Returns a new instance of Operation.
7 8 9 10 11 12 13 14 15 16 |
# File 'lib/seahorse/model/operation.rb', line 7 def initialize(definition = {}, = {}) @definition = definition @shape_map = [:shape_map] || ShapeMap.new @name = definition['name'] @input = shape_for(definition['input']) if definition['input'] @output = shape_for(definition['output']) if definition['output'] @deprecated = !!definition['deprecated'] @documentation = definition['documentation'] @paging = definition['paging'] || {} end |
Instance Attribute Details
#definition ⇒ Hash (readonly)
40 41 42 |
# File 'lib/seahorse/model/operation.rb', line 40 def definition @definition end |
#documentation ⇒ String<HTML>? (readonly)
28 29 30 |
# File 'lib/seahorse/model/operation.rb', line 28 def documentation @documentation end |
#http_method ⇒ String (readonly)
22 23 24 |
# File 'lib/seahorse/model/operation.rb', line 22 def http_method @http_method end |
#http_request_uri ⇒ String (readonly)
25 26 27 |
# File 'lib/seahorse/model/operation.rb', line 25 def http_request_uri @http_request_uri end |
#input ⇒ Shape? (readonly)
31 32 33 |
# File 'lib/seahorse/model/operation.rb', line 31 def input @input end |
#name ⇒ String (readonly)
19 20 21 |
# File 'lib/seahorse/model/operation.rb', line 19 def name @name end |
#output ⇒ Shape? (readonly)
34 35 36 |
# File 'lib/seahorse/model/operation.rb', line 34 def output @output end |
#paging ⇒ Hash (readonly)
37 38 39 |
# File 'lib/seahorse/model/operation.rb', line 37 def paging @paging end |
Instance Method Details
#deprecated? ⇒ Boolean
Returns ‘true` if this API operation is deprecated.
53 54 55 |
# File 'lib/seahorse/model/operation.rb', line 53 def deprecated? !!@definition['deprecated'] end |
#errors ⇒ Enumerator
Returns an enumerator that yields error shapes.
59 60 61 62 63 |
# File 'lib/seahorse/model/operation.rb', line 59 def errors errors = (definition['errors'] || []) errors = errors.map { |error| shape_for(error) } errors.enum_for(:each) end |