Class EntitiesClientAbstract

The client used to fetch, create, update, and delete entities. Implemented by the @contrail/sdk library. ```

Constructors

Methods

  • Batch create will often return an array of created objects and an array of errors, if any were encountered. This is not guaranteed as the implementation depends on the entity being created.

    Returns any

  • Batch update will often return an array of updated objects and an array of errors, if any were encountered. This is not guaranteed as the implementation depends on the entity being updated.

    Returns any

  • Creates and returns the entity from the object passed in the options.

    Parameters

    Returns any

  • Deletes and returns the passed entity object or id(s) in the options.

    Parameters

    Returns any

  • Fetches a single entity or a list of entities based on the options passed.

    Parameters

    Returns Promise<any>

    If id is passed in the options, returns a single entity (object). If ids is passed, returns a list of entities.

  • Take collection of entity references and fetches them from the API returning a map keyed by reference

    Parameters

    Returns Promise<Map<string, any>>

  • Updates the entity with the given object in the options.

    Parameters

    Returns any

    The updated entity.

Generated using TypeDoc