class documentation

class OpQueryFields(OpCode):

View In Hierarchy

Query for available resource/item fields.

Constant OP_DSC_FIELD Undocumented
Constant OP_PARAMS Undocumented
Instance Variable fields List of fields to retrieve
Instance Variable what Resources to query for, must be one of constants.QR_VIA_OP

Inherited from OpCode:

Class Method LoadOpCode Generic load opcode method.
Method __getstate__ Specialized getstate for opcodes.
Method Summary Generates a summary description of this opcode.
Method TinySummary Generates a compact summary description of the opcode.
Constant OP_RESULT Callable to verify opcode result
Constant WITH_LU Boolean that specifies whether this should be included in mcpu's dispatch table
Class Variable OP_DSC_FORMATTER A callable that should format the OP_DSC_FIELD; if not present, then the field will be simply converted to string
Class Variable OP_ID The ID of this opcode. This should be unique amongst all children of this class.
Instance Variable dry_run Whether the LU should be run in dry-run mode, i.e. just the check steps
Instance Variable priority Opcode priority for queue

Inherited from BaseOpCode (via OpCode):

Class Method GetAllParams Compute list of all parameters for an opcode.
Method __init__ Constructor for BaseOpCode.
Method __setstate__ Generic unserializer.
Method Validate Validate opcode parameters, optionally setting default values.

Inherited from ValidatedSlots (via OpCode, BaseOpCode):

Class Method GetAllSlots Compute the list of all declared slots for a class.
Class Variable __slots__ Undocumented
OP_DSC_FIELD: str =

Undocumented

Value
'what'
OP_PARAMS =

Undocumented

Value
[('what', None, ht.TQueryTypeOp, 'Resource(s) to query for'),
 ('fields',
  None,
  ht.TMaybe(ht.TListOf(ht.TNonEmptyString)),
  'Requested fields; if not given, all are returned')]
fields =

List of fields to retrieve

what =

Resources to query for, must be one of constants.QR_VIA_OP