Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SearchResult

The search result object is the definition of an element that is returned as part of search. It contains basic information about the object such as key, name and description. The search result also contains the list of tags for each object along with other contextual information like the data asset root, folder, or entity parents.

Properties

Optional attributeType

attributeType: undefined | string

Type name of the attribute. For example - complex, primitive, or array.

Optional businessName

businessName: undefined | string

Optional user friendly business name of the data object. If set, this supplements the harvested display name of the object.

Optional createdById

createdById: undefined | string

OCID of the user who created the resource.

Optional customProperties

Custom properties defined by users.

Optional dataAssetKey

dataAssetKey: undefined | string

Unique key of the data asset that is the root parent of this object.

Optional dataAssetName

dataAssetName: undefined | string

Name of the data asset that is the root parent of this object.

Optional dataAssetType

dataAssetType: undefined | string

Type name of the data asset. For example, Oracle, MySQL or Oracle Object Storage.

Optional description

description: undefined | string

Detailed description of the object.

Optional entityName

entityName: undefined | string

Name of the parent entity object if this object is an attribute.

Optional entityType

entityType: undefined | string

Type name of the entity. For example, table, view, external table, file, or object.

Optional entitykey

entitykey: undefined | string

Unique key of the entity object if this object is an attribute.

Optional expression

expression: undefined | string

Expression for logical entities against which names of dataObjects will be matched.

Optional externalDataType

externalDataType: undefined | string

Data type of the object if the object is an attribute. Null otherwise.

Optional externalTypeName

externalTypeName: undefined | string

Name of the external object type in the host data asset. For example, column, field, table, view, or file.

Optional folderKey

folderKey: undefined | string

Unique key of the folder object if this object is a sub folder, entity, or attribute.

Optional folderName

folderName: undefined | string

Name of the parent folder object if this object is a sub folder, entity, or attribute.

Optional folderType

folderType: undefined | string

Type name of the folder. For example, schema, directory, or topic.

Optional glossaryKey

glossaryKey: undefined | string

Unique id of the parent glossary.

Optional glossaryName

glossaryName: undefined | string

Name of the parent glossary if this object is a term.

Optional key

key: undefined | string

Unique key of the object returned as part of the search result.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the data object.

Optional name

name: undefined | string

Name of the object.

Optional parentTermKey

parentTermKey: undefined | string

This terms parent term key. Will be null if the term has no parent term.

Optional parentTermName

parentTermName: undefined | string

Name of the parent term. Will be null if the term has no parent term.

Optional path

path: undefined | string

Absolute path of this resource, which could be a term, folder, entity etc, usually resolvable to this resource through a namespace hierarchy.

Optional properties

properties: undefined | object

A map of maps that contains the properties which are specific to the element type in the search result. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most element types have required properties within the "default" category. Example: {@code {"properties": { "default": { "key1": "value1"}}}}

Optional tagSummary

tagSummary: Array<SearchTagSummary>

Array of the tags associated with this object.

Optional termSummary

termSummary: Array<SearchTermSummary>

Array of the terms associated with this object.

Optional timeCreated

timeCreated: Date

The date and time the result object was created, in the format defined by RFC3339. Example: {@code 2019-03-25T21:10:29.600Z}

Optional timeUpdated

timeUpdated: Date

The date and time the result object was updated, in the format defined by RFC3339. Example: {@code 2019-03-25T21:10:29.600Z}

Optional typeName

typeName: undefined | string

Name of the object type.

Optional updatedById

updatedById: undefined | string

OCID of the user who updated the resource.

Functions

getDeserializedJsonObj

getJsonObj