UiSource

class q2_sdk.hq.db.ui_source.UiSourceRow

Bases: RepresentationRowBase

UISourceID: IntElement = 'UISourceID'

ShortName: StringElement = 'ShortName'

PasswordPolicyID: IntElement = 'PasswordPolicyID'

Enabled: BoolElement = 'Enabled'

EnableAuthToken: BoolElement = 'EnableAuthToken'

EnableAuthAccessCode: BoolElement = 'EnableAuthAccessCode'

class q2_sdk.hq.db.ui_source.UiSource(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)

NAME = 'UiSource'

REPRESENTATION_ROW_CLASS

alias of UiSourceRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False)

Return type:

List[UiSourceRow]

async update(short_name, enable_auth_access_code, enable_auth_token)