@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
SearchResult.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and 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.
|
| Modifier and Type | Method and 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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"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)
public static SearchResult.Builder builder()
Create a new builder.
public SearchResult.Builder toBuilder()
public String getKey()
Unique key of the object returned as part of the search result.
public String getName()
Name of the object.
public String getDescription()
Detailed description of the object.
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
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
public List<SearchTagSummary> getTagSummary()
Array of the tags associated with this object.
public List<SearchTermSummary> getTermSummary()
Array of the terms associated with this object.
public String getTypeName()
Name of the object type.
public String getExternalTypeName()
Name of the external object type in the host data asset. For example, column, field, table, view, or file.
public String getExternalDataType()
Data type of the object if the object is an attribute. Null otherwise.
public String getDataAssetKey()
Unique key of the data asset that is the root parent of this object.
public String getDataAssetType()
Type name of the data asset. For example, Oracle, MySQL or Oracle Object Storage.
public String getDataAssetName()
Name of the data asset that is the root parent of this object.
public String getFolderKey()
Unique key of the folder object if this object is a sub folder, entity, or attribute.
public String getFolderType()
Type name of the folder. For example, schema, directory, or topic.
public String getFolderName()
Name of the parent folder object if this object is a sub folder, entity, or attribute.
public String getEntitykey()
Unique key of the entity object if this object is an attribute.
public String getEntityType()
Type name of the entity. For example, table, view, external table, file, or object.
public String getEntityName()
Name of the parent entity object if this object is an attribute.
public String getGlossaryKey()
Unique id of the parent glossary.
public String getGlossaryName()
Name of the parent glossary if this object is a term.
public String getParentTermKey()
This terms parent term key. Will be null if the term has no parent term.
public String getParentTermName()
Name of the parent term. Will be null if the term has no parent term.
public String getCreatedById()
OCID of the user who created the resource.
public String getUpdatedById()
OCID of the user who updated the resource.
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.
public String getBusinessName()
Optional user friendly business name of the data object. If set, this supplements the harvested display name of the object.
public LifecycleState getLifecycleState()
The current state of the data object.
public String getAttributeType()
Type name of the attribute. For example - complex, primitive, or array.
public String getExpression()
Expression for logical entities against which names of dataObjects will be matched.
public List<FacetedSearchCustomProperty> getCustomProperties()
Custom properties defined by users.
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"}}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.