CaliperApiCustomEndpoints

class q2_sdk.hq.db.caliper_api_custom_endpoints.CustomEndpointParameters(shortName=None, description=None, wedgeAddressID=None, author=None, customEndpointID=None)

Bases: object

CustomEndpointParameters(shortName: Optional[str] = None, description: Optional[str] = None, wedgeAddressID: Optional[int] = None, author: Optional[str] = None, customEndpointID: Optional[int] = None)

shortName: Optional[str] = None

description: Optional[str] = None

wedgeAddressID: Optional[int] = None

author: Optional[str] = None

customEndpointID: Optional[int] = None

build_sql_parameters()

class q2_sdk.hq.db.caliper_api_custom_endpoints.CaliperApiCustomEndpointsRow

Bases: RepresentationRowBase

CustomEndpointID: IntElement = 'CustomEndpointID'

ShortName: StringElement = 'ShortName'

Description: StringElement = 'Description'

WedgeAddressID: IntElement = 'WedgeAddressID'

Author: StringElement = 'Author'

class q2_sdk.hq.db.caliper_api_custom_endpoints.CaliperApiCustomEndpoints(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 = 'CaliperApiCustomEndpoints'

REPRESENTATION_ROW_CLASS

alias of CaliperApiCustomEndpointsRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False)

Return type:

list[CaliperApiCustomEndpointsRow]

async get_by_short_name(short_name, serialize_for_cli=False)

Return type:

list[CaliperApiCustomEndpointsRow]

async create(endpoint_parameters)

async update(endpoint_parameters)

async delete(short_name)