Class PanObjectAbstract

constructor

• new PanObject(name, apiClient?): PanObject

• Creates a new instance of PanObject.

  Parameters

  • name: string

    The name of this configuration object.

  • Optional apiClient: ApiClient

    Optional. An ApiClient instance for API requests. Inherited from the hierarchy if not provided.

  Returns PanObject

name

apiClient

• get apiClient(): ApiClient

• Retrieves the ApiClient from the current instance or its parent hierarchy.

  Returns ApiClient

  The ApiClient associated with this object.

  Throws

  An error if the ApiClient instance is not found in the hierarchy.

addChild

• addChild(child): void

• Adds a PanObject as a child to this object, establishing a parent-child relationship.

  Parameters

  • child: PanObject

    The PanObject to be added as a child.

  Returns void

find

• find<ObjectType>(name, classType?): null | ObjectType

• Locates a child PanObject within the configuration tree by name and, optionally, by type.

  Type Parameters

  • ObjectType extends PanObject

  Parameters

  • name: string

    The name of the object to search for.

  • Optional classType: (new (...args) => ObjectType)

    Optional. The class constructor to match instances against.

    • • new (...args): ObjectType

      • Parameters

        • Rest ...args: unknown[]

        Returns ObjectType

  Returns null | ObjectType

  The matching PanObject instance, or null if not found.

findChildByName

• findChildByName(name): null | PanObject

• Searches for a child PanObject by its name.

  Parameters

  • name: string

    The name of the child object to locate.

  Returns null | PanObject

  The found PanObject, or null if no match is found.

getChildren

• getChildren(): readonly PanObject[]

• Retrieves the child PanObject instances of this object.

  Returns readonly PanObject[]

  An array of PanObject representing the children of this object.

hasChild

• hasChild(child): boolean

• Checks if a given PanObject is a child of this object.

  Parameters

  • child: PanObject

    The PanObject to verify.

  Returns boolean

  true if the specified PanObject is a child of this object, otherwise false.

removeChild

• removeChild(child): void

• Removes a PanObject from this object's children, severing the parent-child relationship.

  Parameters

  • child: PanObject

    The PanObject to be removed from the children.

  Returns void