Class: DeltaCloud::Documentation

Inherits:

Object

• Object
• DeltaCloud::Documentation

show all

Defined in:

lib/deltacloud.rb

Defined Under Namespace

Classes: OperationParameter

Instance Attribute Summary (collapse)

• - (Object) api readonly

  Returns the value of attribute api.

• - (Object) collection readonly

  Returns the value of attribute collection.

• - (Object) collection_operations readonly

  Returns the value of attribute collection_operations.

• - (Object) description readonly

  Returns the value of attribute description.

• - (Object) operation readonly

  Returns the value of attribute operation.

• - (Object) params readonly

  Returns the value of attribute params.

Instance Method Summary (collapse)

• - (Documentation) initialize(api, opts = {}) constructor

  A new instance of Documentation.

• - (Object) operations

444
445
446
447
448
449
450
451

# File 'lib/deltacloud.rb', line 444

def initialize(api, opts={})
  @description, @api = opts[:description], api
  @params = parse_parameters(opts[:params]) if opts[:params]
  @collection_operations = opts[:operations] if opts[:operations]
  @collection = opts[:collection]
  @operation = opts[:operation]
  self
end

441
442
443

# File 'lib/deltacloud.rb', line 441

def api
  @api
end

442
443
444

# File 'lib/deltacloud.rb', line 442

def collection
  @collection
end

441
442
443

# File 'lib/deltacloud.rb', line 441

def collection_operations
  @collection_operations
end

441
442
443

# File 'lib/deltacloud.rb', line 441

def description
  @description
end

442
443
444

# File 'lib/deltacloud.rb', line 442

def operation
  @operation
end

441
442
443

# File 'lib/deltacloud.rb', line 441

def params
  @params
end

453
454
455

# File 'lib/deltacloud.rb', line 453

def operations
  @collection_operations.collect { |o| api.documentation(@collection, o) }
end