X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=doc%2Fclasses%2FMCollective%2FDDL%2FDataDDL.html;fp=doc%2Fclasses%2FMCollective%2FDDL%2FDataDDL.html;h=0000000000000000000000000000000000000000;hb=7c9314f502cde8daad23b61d10b24a542e04154a;hp=0d21aa3da989117655eb7e015aa2ff9bcbadbf4b;hpb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;p=packages%2Fprecise%2Fmcollective.git diff --git a/doc/classes/MCollective/DDL/DataDDL.html b/doc/classes/MCollective/DDL/DataDDL.html deleted file mode 100644 index 0d21aa3..0000000 --- a/doc/classes/MCollective/DDL/DataDDL.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - Class: MCollective::DDL::DataDDL - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassMCollective::DDL::DataDDL
In: - - lib/mcollective/ddl/dataddl.rb - -
-
Parent: - - Base - -
-
- - -
- - - -
- -
-

-A DDL file for the data query plugins. -

-

-Query plugins can today take only one input by convention in the DDL that is called :query, otherwise the input is identical to the standard input. -

-

-metadata :name => "Agent", -

-
-            :description => "Meta data about installed MColletive Agents",
-            :author      => "R.I.Pienaar <rip@devco.net>",
-            :license     => "ASL 2.0",
-            :version     => "1.0",
-            :url         => "http://marionette-collective.org/",
-            :timeout     => 1
-
-

-dataquery :description => "Agent Meta Data" -do -

-
-    input :query,
-          :prompt => "Agent Name",
-          :description => "Valid agent name",
-          :type => :string,
-          :validation => /^[\w\_]+$/,
-          :maxlength => 20
-
-    [:license, :timeout, :description, :url, :version, :author].each do |item|
-      output item,
-             :description => "Agent #{item}",
-             :display_as => item.to_s.capitalize
-    end
-
-

-end -

- -
- - -
- -
-

Methods

- -
- dataquery   - dataquery_interface   - input   -
-
- -
- - - - -
- - - - - - - - - -
-

Public Instance methods

- -
- - -
- - dataquery(input, &block) - -
- -
-

[Source]

-
-
-    # File lib/mcollective/ddl/dataddl.rb, line 31
-31:       def dataquery(input, &block)
-32:         raise "Data queries need a :description" unless input.include?(:description)
-33:         raise "Data queries can only have one definition" if @entities[:data]
-34: 
-35:         @entities[:data]  = {:description => input[:description],
-36:                              :input => {},
-37:                              :output => {}}
-38: 
-39:         @current_entity = :data
-40:         block.call if block_given?
-41:         @current_entity = nil
-42:       end
-
-
-
-
- -
- - -
- - dataquery_interface() - -
- -
-

-Returns the interface for the data query -

-

[Source]

-
-
-    # File lib/mcollective/ddl/dataddl.rb, line 51
-51:       def dataquery_interface
-52:         @entities[:data] || {}
-53:       end
-
-
-
-
- -
- - -
- - input(argument, properties) - -
- -
-

[Source]

-
-
-    # File lib/mcollective/ddl/dataddl.rb, line 44
-44:       def input(argument, properties)
-45:         raise "The only valid input name for a data query is 'query'" if argument != :query
-46: 
-47:         super
-48:       end
-
-
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file