java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.datacatalog.model.SearchResult

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class SearchResult
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
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.
Note: Objects should always be created or deserialized using the SearchResult.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SearchResult.Builder, which maintain a set of all explicitly set fields called SearchResult.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SearchResult.Builder

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor	Description
SearchResult(String key, String name, String description, Date timeCreated, Date timeUpdated, List<SearchTagSummary> tagSummary, List<SearchTermSummary> termSummary, String typeName, String externalTypeName, String externalDataType, String dataAssetKey, String dataAssetType, String dataAssetName, String folderKey, String folderType, String folderName, String entitykey, String entityType, String entityName, String glossaryKey, String glossaryName, String parentTermKey, String parentTermName, String createdById, String updatedById, String path, String businessName, LifecycleState lifecycleState, String attributeType, String expression, List<FacetedSearchCustomProperty> customProperties, Map<String,Map<String,String>> properties)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SearchResult.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getAttributeType()`	Type name of the attribute.
`String`	`getBusinessName()`	Optional user friendly business name of the data object.
`String`	`getCreatedById()`	OCID of the user who created the resource.
`List<FacetedSearchCustomProperty>`	`getCustomProperties()`	Custom properties defined by users.
`String`	`getDataAssetKey()`	Unique key of the data asset that is the root parent of this object.
`String`	`getDataAssetName()`	Name of the data asset that is the root parent of this object.
`String`	`getDataAssetType()`	Type name of the data asset.
`String`	`getDescription()`	Detailed description of the object.
`String`	`getEntitykey()`	Unique key of the entity object if this object is an attribute.
`String`	`getEntityName()`	Name of the parent entity object if this object is an attribute.
`String`	`getEntityType()`	Type name of the entity.
`String`	`getExpression()`	Expression for logical entities against which names of dataObjects will be matched.
`String`	`getExternalDataType()`	Data type of the object if the object is an attribute.
`String`	`getExternalTypeName()`	Name of the external object type in the host data asset.
`String`	`getFolderKey()`	Unique key of the folder object if this object is a sub folder, entity, or attribute.
`String`	`getFolderName()`	Name of the parent folder object if this object is a sub folder, entity, or attribute.
`String`	`getFolderType()`	Type name of the folder.
`String`	`getGlossaryKey()`	Unique id of the parent glossary.
`String`	`getGlossaryName()`	Name of the parent glossary if this object is a term.
`String`	`getKey()`	Unique key of the object returned as part of the search result.
`LifecycleState`	`getLifecycleState()`	The current state of the data object.
`String`	`getName()`	Name of the object.
`String`	`getParentTermKey()`	This terms parent term key.
`String`	`getParentTermName()`	Name of the parent term.
`String`	`getPath()`	Absolute path of this resource, which could be a term, folder, entity etc, usually resolvable to this resource through a namespace hierarchy.
`Map<String,Map<String,String>>`	`getProperties()`	A map of maps that contains the properties which are specific to the element type in the search result.
`List<SearchTagSummary>`	`getTagSummary()`	Array of the tags associated with this object.
`List<SearchTermSummary>`	`getTermSummary()`	Array of the terms associated with this object.
`Date`	`getTimeCreated()`	The date and time the result object was created, in the format defined by RFC3339.
`Date`	`getTimeUpdated()`	The date and time the result object was updated, in the format defined by RFC3339.
`String`	`getTypeName()`	Name of the object type.
`String`	`getUpdatedById()`	OCID of the user who updated the resource.
`int`	`hashCode()`
`SearchResult.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchResult

@Deprecated
@ConstructorProperties({"key","name","description","timeCreated","timeUpdated","tagSummary","termSummary","typeName","externalTypeName","externalDataType","dataAssetKey","dataAssetType","dataAssetName","folderKey","folderType","folderName","entitykey","entityType","entityName","glossaryKey","glossaryName","parentTermKey","parentTermName","createdById","updatedById","path","businessName","lifecycleState","attributeType","expression","customProperties","properties"})
public SearchResult(String key,
                    String name,
                    String description,
                    Date timeCreated,
                    Date timeUpdated,
                    List<SearchTagSummary> tagSummary,
                    List<SearchTermSummary> termSummary,
                    String typeName,
                    String externalTypeName,
                    String externalDataType,
                    String dataAssetKey,
                    String dataAssetType,
                    String dataAssetName,
                    String folderKey,
                    String folderType,
                    String folderName,
                    String entitykey,
                    String entityType,
                    String entityName,
                    String glossaryKey,
                    String glossaryName,
                    String parentTermKey,
                    String parentTermName,
                    String createdById,
                    String updatedById,
                    String path,
                    String businessName,
                    LifecycleState lifecycleState,
                    String attributeType,
                    String expression,
                    List<FacetedSearchCustomProperty> customProperties,
                    Map<String,Map<String,String>> properties)

Deprecated.

Method Detail
- builder
```
public static SearchResult.Builder builder()
```
  Create a new builder.
- toBuilder
```
public SearchResult.Builder toBuilder()
```
- getKey
```
public String getKey()
```
  Unique key of the object returned as part of the search result.
  
  Returns:
  
  the value
- getName
```
public String getName()
```
  Name of the object.
  
  Returns:
  
  the value
- getDescription
```
public String getDescription()
```
  Detailed description of the object.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the result object was created, in the format defined by RFC3339.
  Example: 2019-03-25T21:10:29.600Z
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  The date and time the result object was updated, in the format defined by RFC3339.
  Example: 2019-03-25T21:10:29.600Z
  
  Returns:
  
  the value
- getTagSummary
```
public List<SearchTagSummary> getTagSummary()
```
  Array of the tags associated with this object.
  
  Returns:
  
  the value
- getTermSummary
```
public List<SearchTermSummary> getTermSummary()
```
  Array of the terms associated with this object.
  
  Returns:
  
  the value
- getTypeName
```
public String getTypeName()
```
  Name of the object type.
  
  Returns:
  
  the value
- getExternalTypeName
```
public String getExternalTypeName()
```
  Name of the external object type in the host data asset.
  For example, column, field, table, view, or file.
  
  Returns:
  
  the value
- getExternalDataType
```
public String getExternalDataType()
```
  Data type of the object if the object is an attribute.
  Null otherwise.
  
  Returns:
  
  the value
- getDataAssetKey
```
public String getDataAssetKey()
```
  Unique key of the data asset that is the root parent of this object.
  
  Returns:
  
  the value
- getDataAssetType
```
public String getDataAssetType()
```
  Type name of the data asset.
  For example, Oracle, MySQL or Oracle Object Storage.
  
  Returns:
  
  the value
- getDataAssetName
```
public String getDataAssetName()
```
  Name of the data asset that is the root parent of this object.
  
  Returns:
  
  the value
- getFolderKey
```
public String getFolderKey()
```
  Unique key of the folder object if this object is a sub folder, entity, or attribute.
  
  Returns:
  
  the value
- getFolderType
```
public String getFolderType()
```
  Type name of the folder.
  For example, schema, directory, or topic.
  
  Returns:
  
  the value
- getFolderName
```
public String getFolderName()
```
  Name of the parent folder object if this object is a sub folder, entity, or attribute.
  
  Returns:
  
  the value
- getEntitykey
```
public String getEntitykey()
```
  Unique key of the entity object if this object is an attribute.
  
  Returns:
  
  the value
- getEntityType
```
public String getEntityType()
```
  Type name of the entity.
  For example, table, view, external table, file, or object.
  
  Returns:
  
  the value
- getEntityName
```
public String getEntityName()
```
  Name of the parent entity object if this object is an attribute.
  
  Returns:
  
  the value
- getGlossaryKey
```
public String getGlossaryKey()
```
  Unique id of the parent glossary.
  
  Returns:
  
  the value
- getGlossaryName
```
public String getGlossaryName()
```
  Name of the parent glossary if this object is a term.
  
  Returns:
  
  the value
- getParentTermKey
```
public String getParentTermKey()
```
  This terms parent term key.
  Will be null if the term has no parent term.
  
  Returns:
  
  the value
- getParentTermName
```
public String getParentTermName()
```
  Name of the parent term.
  Will be null if the term has no parent term.
  
  Returns:
  
  the value
- getCreatedById
```
public String getCreatedById()
```
  OCID of the user who created the resource.
  
  Returns:
  
  the value
- getUpdatedById
```
public String getUpdatedById()
```
  OCID of the user who updated the resource.
  
  Returns:
  
  the value
- getPath
```
public String getPath()
```
  Absolute path of this resource, which could be a term, folder, entity etc, usually resolvable to this resource through a namespace hierarchy.
  
  Returns:
  
  the value
- getBusinessName
```
public String getBusinessName()
```
  Optional user friendly business name of the data object.
  If set, this supplements the harvested display name of the object.
  
  Returns:
  
  the value
- getLifecycleState
```
public LifecycleState getLifecycleState()
```
  The current state of the data object.
  
  Returns:
  
  the value
- getAttributeType
```
public String getAttributeType()
```
  Type name of the attribute.
  For example - complex, primitive, or array.
  
  Returns:
  
  the value
- getExpression
```
public String getExpression()
```
  Expression for logical entities against which names of dataObjects will be matched.
  
  Returns:
  
  the value
- getCustomProperties
```
public List<FacetedSearchCustomProperty> getCustomProperties()
```
  Custom properties defined by users.
  
  Returns:
  
  the value
- getProperties
```
public Map<String,Map<String,String>> getProperties()
```
  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”}}}
  
  Returns:
  
  the value
- toString
```
public String toString()
```
  Overrides:
  
  toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class SearchResult

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

SearchResult

Method Detail

builder

toBuilder

getKey

getName

getDescription

getTimeCreated

getTimeUpdated

getTagSummary

getTermSummary

getTypeName

getExternalTypeName

getExternalDataType

getDataAssetKey

getDataAssetType

getDataAssetName

getFolderKey

getFolderType

getFolderName

getEntitykey

getEntityType

getEntityName

getGlossaryKey

getGlossaryName

getParentTermKey

getParentTermName

getCreatedById

getUpdatedById

getPath

getBusinessName

getLifecycleState

getAttributeType

getExpression

getCustomProperties

getProperties

toString

toString

equals

hashCode