class documentation

/2/filters/[filter_uuid] resource.

Method DELETE Deletes a filter rule.
Method GET Returns a filter rule.
Method PUT Replaces an existing filter rule, or creates one if it doesn't exist already.

Inherited from ResourceBase:

Method __init__ Generic resource constructor.
Method dryRun Check if the request specifies dry-run mode.
Method getBodyParameter Check and return the value for a given parameter.
Method GetClient Wrapper for luxi.Client with HTTP-specific error handling.
Method SubmitJob Generic wrapper for submit job, for better http compatibility.
Method useBulk Check if the request specifies bulk querying.
Method useForce Check if the request specifies a forced operation.
Method useLocking Check if the request specifies locking.
Constant DELETE_ACCESS Undocumented
Constant GET_ACCESS Undocumented
Constant POST_ACCESS Undocumented
Constant PUT_ACCESS Undocumented
Class Variable request_body Undocumented
Instance Variable items Undocumented
Instance Variable queryargs Undocumented
Method _checkIntVariable Return the parsed value of an int argument.
Method _checkStringVariable Return the parsed value of a string argument.
Method _GetRequestBody Returns the body data.
Instance Variable _client_cls Undocumented
Instance Variable _req Undocumented
def DELETE(self):

Deletes a filter rule.

def GET(self):

Returns a filter rule.

Returns

a dictionary with job parameters. The result includes:

  • uuid: unique filter ID string
  • watermark: highest job ID ever used as a number
  • priority: filter priority as a non-negative number
  • predicates: filter predicates, each one being a list with the first element being the name of the predicate and the rest being parameters suitable for that predicate
  • action: effect of the filter as a string
  • reason_trail: reasons for the addition of this filter as a list of lists
def PUT(self):

Replaces an existing filter rule, or creates one if it doesn't exist already.

Returns
the UUID of the changed or created filter rule.