APIObject class - Platform - BlueCat Gateway - 22.4.1

Gateway Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.4.1

class bluecat.api_object.APIObject(api, api_entity, ver='')

Bases: object

Instantiate an base class for API Entity or an Access Right.

Parameters Description
api API instance used by the API object to communicate with BAM.
api_entity The API object returned by the BAM API.

dump()

Dump out details of the entity to logger. Useful for debug.

get_properties()

Get the properties in the form of a dictionary containing one entry per property.

get_property(name)

Get a single named property or None if not defined.

set_properties(property_dict)

Set any number of properties based on given property_dict.

set_property(name, value)

Set a property value. The change is not persisted until update() is called.