GtFlavor

class q2_sdk.hq.db.gt_flavor.GTFlavorRow

Bases: RepresentationRowBase

GtFlavorID: IntElement = 'GtFlavorID'

ShortName: StringElement = 'ShortName'

Description: StringElement = 'Description'

TransactionTypeID: IntElement = 'TransactionTypeID'

TransactionType: StringElement = 'TransactionType'

enum q2_sdk.hq.db.gt_flavor.BaseGT(value)

Bases: StrEnum

Member Type:

str

Valid values are as follows:

FundsTransfer = <BaseGT.FundsTransfer: 'FundsTransfer'>

ExternalTransfer = <BaseGT.ExternalTransfer: 'ExternalTransfer'>

class q2_sdk.hq.db.gt_flavor.GtFlavor(logger, hq_credentials=None, ret_table_obj=None)

Bases: DbObject

Programmatic access to the Q2 database. Not as flexible as a true ORM, but takes the guesswork out of database schemas and ensures safety in the transactions.

Parameters:

• logger – Reference to calling request’s logger (self.logger in your extension)

• hq_credentials (Optional[HqCredentials]) – HQ Connectivity Information (Defaults to settings file)

• ret_table_obj (Optional[bool]) – Flag to return list of LXML elements if False or TableRow objects from DB calls if True (Defaults to settings file)

GET_BY_NAME_KEY = 'ShortName'

Name = 'GTFlavor'

REPRESENTATION_ROW_CLASS

alias of GTFlavorRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async create(flavor_name, flavor_description, base_gt)

async get(serialize_for_cli=False)