Class 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.

Inheritance
object
SearchResult
Inherited Members
Namespace: Oci.DatacatalogService.Models
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class SearchResult

Properties

AttributeType

Declaration
[JsonProperty(PropertyName = "attributeType")]
public string AttributeType { get; set; }
Property Value
Type Description
string

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

BusinessName

Declaration
[JsonProperty(PropertyName = "businessName")]
public string BusinessName { get; set; }
Property Value
Type Description
string

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

CreatedById

Declaration
[JsonProperty(PropertyName = "createdById")]
public string CreatedById { get; set; }
Property Value
Type Description
string

OCID of the user who created the resource.

CustomProperties

Declaration
[JsonProperty(PropertyName = "customProperties")]
public List<FacetedSearchCustomProperty> CustomProperties { get; set; }
Property Value
Type Description
List<FacetedSearchCustomProperty>

Custom properties defined by users.

DataAssetKey

Declaration
[JsonProperty(PropertyName = "dataAssetKey")]
public string DataAssetKey { get; set; }
Property Value
Type Description
string

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

DataAssetName

Declaration
[JsonProperty(PropertyName = "dataAssetName")]
public string DataAssetName { get; set; }
Property Value
Type Description
string

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

DataAssetType

Declaration
[JsonProperty(PropertyName = "dataAssetType")]
public string DataAssetType { get; set; }
Property Value
Type Description
string

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

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Detailed description of the object.

EntityName

Declaration
[JsonProperty(PropertyName = "entityName")]
public string EntityName { get; set; }
Property Value
Type Description
string

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

EntityType

Declaration
[JsonProperty(PropertyName = "entityType")]
public string EntityType { get; set; }
Property Value
Type Description
string

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

Entitykey

Declaration
[JsonProperty(PropertyName = "entitykey")]
public string Entitykey { get; set; }
Property Value
Type Description
string

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

Expression

Declaration
[JsonProperty(PropertyName = "expression")]
public string Expression { get; set; }
Property Value
Type Description
string

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

ExternalDataType

Declaration
[JsonProperty(PropertyName = "externalDataType")]
public string ExternalDataType { get; set; }
Property Value
Type Description
string

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

ExternalTypeName

Declaration
[JsonProperty(PropertyName = "externalTypeName")]
public string ExternalTypeName { get; set; }
Property Value
Type Description
string

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

FolderKey

Declaration
[JsonProperty(PropertyName = "folderKey")]
public string FolderKey { get; set; }
Property Value
Type Description
string

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

FolderName

Declaration
[JsonProperty(PropertyName = "folderName")]
public string FolderName { get; set; }
Property Value
Type Description
string

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

FolderType

Declaration
[JsonProperty(PropertyName = "folderType")]
public string FolderType { get; set; }
Property Value
Type Description
string

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

GlossaryKey

Declaration
[JsonProperty(PropertyName = "glossaryKey")]
public string GlossaryKey { get; set; }
Property Value
Type Description
string

Unique id of the parent glossary.

GlossaryName

Declaration
[JsonProperty(PropertyName = "glossaryName")]
public string GlossaryName { get; set; }
Property Value
Type Description
string

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

Key

Declaration
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }
Property Value
Type Description
string

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

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

The current state of the data object.

Name

Declaration
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

Name of the object.

ParentTermKey

Declaration
[JsonProperty(PropertyName = "parentTermKey")]
public string ParentTermKey { get; set; }
Property Value
Type Description
string

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

ParentTermName

Declaration
[JsonProperty(PropertyName = "parentTermName")]
public string ParentTermName { get; set; }
Property Value
Type Description
string

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

Path

Declaration
[JsonProperty(PropertyName = "path")]
public string Path { get; set; }
Property Value
Type Description
string

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

Properties

Declaration
[JsonProperty(PropertyName = "properties")]
public Dictionary<string, Dictionary<string, string>> Properties { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, string>>

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: {"properties": { "default": { "key1": "value1"}}}

TagSummary

Declaration
[JsonProperty(PropertyName = "tagSummary")]
public List<SearchTagSummary> TagSummary { get; set; }
Property Value
Type Description
List<SearchTagSummary>

Array of the tags associated with this object.

TermSummary

Declaration
[JsonProperty(PropertyName = "termSummary")]
public List<SearchTermSummary> TermSummary { get; set; }
Property Value
Type Description
List<SearchTermSummary>

Array of the terms associated with this object.

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

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

TypeName

Declaration
[JsonProperty(PropertyName = "typeName")]
public string TypeName { get; set; }
Property Value
Type Description
string

Name of the object type.

UpdatedById

Declaration
[JsonProperty(PropertyName = "updatedById")]
public string UpdatedById { get; set; }
Property Value
Type Description
string

OCID of the user who updated the resource.