From e4e4b6f8db3d1fade4648cb7ef220759c5b7f2cf Mon Sep 17 00:00:00 2001 From: Parshad Patel Date: Wed, 13 Feb 2019 18:10:36 +0900 Subject: [PATCH] README file updating - more info Change-Id: Ie89b14869354caa0dac1d7cfe2221ec761a14bf6 Issue-ID: SDC-2057 Signed-off-by: Manzon, Inna (im453s) --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 549383d..f52b156 100644 --- a/README.md +++ b/README.md @@ -146,4 +146,22 @@ This version is intended for SDN-C team usage only. ### Changes: 1. Bug fix in Policy metadata object getter (Jtosca) 2. NPE fix in Policy getTargets method (sdc-tosca) -3. Adding more getters to IEntityDetails interface for getEntity API introduced on 1.4.8 version. +3. Adding more getters to IEntityDetails interface for getEntity API introduced in 1.4.8 version: + + **getEntity** API retrieves details of one or more entity templates according to provided query parameters from corresponding topology template. + + **entityQuery** Object describing the searched entity parameters. Includes one of following parameters: entity type, + SDC (node template) type, tosca type as well as optional customizationUUID and UUID + If the parameter is null, the returned result will contain *all* entities that types are supported by SDC. + + **topologyTemplateQuery** parameters of the topology template containing the above entity. + Includes SDC type of the container and optional customizationUUID. + + **isRecursive** indicates if the search is recursive starting from the required topology template. + + Returns list of **IEntityDetails** objects containing information about the found entities. + If either no entities found or the provided query is incorrect, an empty list is returned. + + List getEntity(EntityQuery entityQuery, TopologyTemplateQuery topologyTemplateQuery, boolean isRecursive); + + -- 2.16.6