class Openwsman::Filter
*
-
Filter are evaluated on the server side and help to reduce the amount
-
of processing and information transport.
*
-
There are five basic ways to filter
-
associations
-
-
references
-
-
XPath
-
-
CQL (CIM query language)
-
-
WQL (WS-Management query language)
-
*
-
Openwsman does not do any filter processing by itself but passes it
-
to the backend CIMOM. Support for filters and query languages thus
-
depends on the used CIMOM.
* */
Public Class Methods
new(p1)
click to toggle source
Create empty filter
() { return filter_initialize(); } ~filter_t() { filter_destroy( $self ); } /* * Set associators filter * call-seq: * filter.associators(end_point_reference, assoc_class_name, result_class_name, role, result_role, result_prop[], prop_num) * */ int associators( VALUE epr_v = Qnil, VALUE assocClass_v = Qnil, VALUE resultClass_v = Qnil, VALUE role_v = Qnil, VALUE resultRole_v = Qnil, VALUE resultProp_v = Qnil, VALUE propNum_v = Qnil) { return associators_references( $self, 0, epr_v, assocClass_v, resultClass_v, role_v, resultRole_v, resultProp_v, propNum_v); } /* * Set references filter * * call-seq: * filter.references(end_point_reference, assoc_class_name, result_class_name, role, result_role, result_prop[], prop_num) * */ int references( VALUE epr_v = Qnil, VALUE assocClass_v = Qnil, VALUE resultClass_v = Qnil, VALUE role_v = Qnil, VALUE resultRole_v = Qnil, VALUE resultProp_v = Qnil, VALUE propNum_v = Qnil) { return associators_references( $self, 1, epr_v, assocClass_v, resultClass_v, role_v, resultRole_v, resultProp_v, propNum_v); } /* * Set simple dialect/query filter * call-seq: * filter.simple(dialect, query) * */ int simple(const char *dialect, const char *query) { return filter_set_simple($self, dialect, query ); } /* * Set XPath filter * call-seq: * filter.xpath(query) * */ int xpath(const char *query) { return filter_set_simple($self, WSM_XPATH_FILTER_DIALECT, query ); } /* * Set CQL (CIM query language) filter * call-seq: * filter.cql(query) * */ int cql(const char *query) { return filter_set_simple($self, WSM_CQL_FILTER_DIALECT, query ); } /* * Set WQL (WS-Management query language) filter * call-seq: * filter.wql(query) * */ int wql(const char *query) { return filter_set_simple($self, WSM_WQL_FILTER_DIALECT, query ); } }
Public Instance Methods
associators(end_point_reference, assoc_class_name, result_class_name, role, result_role, result_prop[], prop_num)
click to toggle source
Set associators filter
int associators( VALUE epr_v = Qnil, VALUE assocClass_v = Qnil, VALUE resultClass_v = Qnil, VALUE role_v = Qnil, VALUE resultRole_v = Qnil, VALUE resultProp_v = Qnil, VALUE propNum_v = Qnil) { return associators_references( $self, 0, epr_v, assocClass_v, resultClass_v, role_v, resultRole_v, resultProp_v, propNum_v); } /* * Set references filter * * call-seq: * filter.references(end_point_reference, assoc_class_name, result_class_name, role, result_role, result_prop[], prop_num) * */ int references( VALUE epr_v = Qnil, VALUE assocClass_v = Qnil, VALUE resultClass_v = Qnil, VALUE role_v = Qnil, VALUE resultRole_v = Qnil, VALUE resultProp_v = Qnil, VALUE propNum_v = Qnil) { return associators_references( $self, 1, epr_v, assocClass_v, resultClass_v, role_v, resultRole_v, resultProp_v, propNum_v); } /* * Set simple dialect/query filter * call-seq: * filter.simple(dialect, query) * */ int simple(const char *dialect, const char *query) { return filter_set_simple($self, dialect, query ); } /* * Set XPath filter * call-seq: * filter.xpath(query) * */ int xpath(const char *query) { return filter_set_simple($self, WSM_XPATH_FILTER_DIALECT, query ); } /* * Set CQL (CIM query language) filter * call-seq: * filter.cql(query) * */ int cql(const char *query) { return filter_set_simple($self, WSM_CQL_FILTER_DIALECT, query ); } /* * Set WQL (WS-Management query language) filter * call-seq: * filter.wql(query) * */ int wql(const char *query) { return filter_set_simple($self, WSM_WQL_FILTER_DIALECT, query ); } }
cql(query)
click to toggle source
Set CQL (CIM query language) filter
int cql(const char *query) { return filter_set_simple($self, WSM_CQL_FILTER_DIALECT, query ); } /* * Set WQL (WS-Management query language) filter * call-seq: * filter.wql(query) * */ int wql(const char *query) { return filter_set_simple($self, WSM_WQL_FILTER_DIALECT, query ); } }
references(end_point_reference, assoc_class_name, result_class_name, role, result_role, result_prop[], prop_num)
click to toggle source
Set references filter
int references( VALUE epr_v = Qnil, VALUE assocClass_v = Qnil, VALUE resultClass_v = Qnil, VALUE role_v = Qnil, VALUE resultRole_v = Qnil, VALUE resultProp_v = Qnil, VALUE propNum_v = Qnil) { return associators_references( $self, 1, epr_v, assocClass_v, resultClass_v, role_v, resultRole_v, resultProp_v, propNum_v); } /* * Set simple dialect/query filter * call-seq: * filter.simple(dialect, query) * */ int simple(const char *dialect, const char *query) { return filter_set_simple($self, dialect, query ); } /* * Set XPath filter * call-seq: * filter.xpath(query) * */ int xpath(const char *query) { return filter_set_simple($self, WSM_XPATH_FILTER_DIALECT, query ); } /* * Set CQL (CIM query language) filter * call-seq: * filter.cql(query) * */ int cql(const char *query) { return filter_set_simple($self, WSM_CQL_FILTER_DIALECT, query ); } /* * Set WQL (WS-Management query language) filter * call-seq: * filter.wql(query) * */ int wql(const char *query) { return filter_set_simple($self, WSM_WQL_FILTER_DIALECT, query ); } }
simple(dialect, query)
click to toggle source
Set simple dialect/query filter
int simple(const char *dialect, const char *query) { return filter_set_simple($self, dialect, query ); } /* * Set XPath filter * call-seq: * filter.xpath(query) * */ int xpath(const char *query) { return filter_set_simple($self, WSM_XPATH_FILTER_DIALECT, query ); } /* * Set CQL (CIM query language) filter * call-seq: * filter.cql(query) * */ int cql(const char *query) { return filter_set_simple($self, WSM_CQL_FILTER_DIALECT, query ); } /* * Set WQL (WS-Management query language) filter * call-seq: * filter.wql(query) * */ int wql(const char *query) { return filter_set_simple($self, WSM_WQL_FILTER_DIALECT, query ); } }
wql(query)
click to toggle source
Set WQL (WS-Management query language) filter
int wql(const char *query) { return filter_set_simple($self, WSM_WQL_FILTER_DIALECT, query ); } }
xpath(query)
click to toggle source
Set XPath filter
int xpath(const char *query) { return filter_set_simple($self, WSM_XPATH_FILTER_DIALECT, query ); } /* * Set CQL (CIM query language) filter * call-seq: * filter.cql(query) * */ int cql(const char *query) { return filter_set_simple($self, WSM_CQL_FILTER_DIALECT, query ); } /* * Set WQL (WS-Management query language) filter * call-seq: * filter.wql(query) * */ int wql(const char *query) { return filter_set_simple($self, WSM_WQL_FILTER_DIALECT, query ); } }