SearchResult

class oci.data_catalog.models.SearchResult(**kwargs)

Bases: object

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.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a SearchResult.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a SearchResult.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a SearchResult.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a SearchResult.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a SearchResult.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a SearchResult.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a SearchResult.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a SearchResult.
attribute_type Gets the attribute_type of this SearchResult.
business_name Gets the business_name of this SearchResult.
created_by_id Gets the created_by_id of this SearchResult.
custom_properties Gets the custom_properties of this SearchResult.
data_asset_key Gets the data_asset_key of this SearchResult.
data_asset_name Gets the data_asset_name of this SearchResult.
data_asset_type Gets the data_asset_type of this SearchResult.
description Gets the description of this SearchResult.
entity_name Gets the entity_name of this SearchResult.
entity_type Gets the entity_type of this SearchResult.
entitykey Gets the entitykey of this SearchResult.
expression Gets the expression of this SearchResult.
external_data_type Gets the external_data_type of this SearchResult.
external_type_name Gets the external_type_name of this SearchResult.
folder_key Gets the folder_key of this SearchResult.
folder_name Gets the folder_name of this SearchResult.
folder_type Gets the folder_type of this SearchResult.
glossary_key Gets the glossary_key of this SearchResult.
glossary_name Gets the glossary_name of this SearchResult.
key Gets the key of this SearchResult.
lifecycle_state Gets the lifecycle_state of this SearchResult.
name Gets the name of this SearchResult.
parent_term_key Gets the parent_term_key of this SearchResult.
parent_term_name Gets the parent_term_name of this SearchResult.
path Gets the path of this SearchResult.
tag_summary Gets the tag_summary of this SearchResult.
term_summary Gets the term_summary of this SearchResult.
time_created Gets the time_created of this SearchResult.
time_updated Gets the time_updated of this SearchResult.
type_name Gets the type_name of this SearchResult.
updated_by_id Gets the updated_by_id of this SearchResult.

Methods

__init__(**kwargs) Initializes a new SearchResult object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a SearchResult. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a SearchResult. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a SearchResult. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a SearchResult. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a SearchResult. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a SearchResult. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'

A constant which can be used with the lifecycle_state property of a SearchResult. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a SearchResult. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new SearchResult object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • key (str) – The value to assign to the key property of this SearchResult.
  • name (str) – The value to assign to the name property of this SearchResult.
  • description (str) – The value to assign to the description property of this SearchResult.
  • time_created (datetime) – The value to assign to the time_created property of this SearchResult.
  • time_updated (datetime) – The value to assign to the time_updated property of this SearchResult.
  • tag_summary (list[oci.data_catalog.models.SearchTagSummary]) – The value to assign to the tag_summary property of this SearchResult.
  • term_summary (list[oci.data_catalog.models.SearchTermSummary]) – The value to assign to the term_summary property of this SearchResult.
  • type_name (str) – The value to assign to the type_name property of this SearchResult.
  • external_type_name (str) – The value to assign to the external_type_name property of this SearchResult.
  • external_data_type (str) – The value to assign to the external_data_type property of this SearchResult.
  • data_asset_key (str) – The value to assign to the data_asset_key property of this SearchResult.
  • data_asset_type (str) – The value to assign to the data_asset_type property of this SearchResult.
  • data_asset_name (str) – The value to assign to the data_asset_name property of this SearchResult.
  • folder_key (str) – The value to assign to the folder_key property of this SearchResult.
  • folder_type (str) – The value to assign to the folder_type property of this SearchResult.
  • folder_name (str) – The value to assign to the folder_name property of this SearchResult.
  • entitykey (str) – The value to assign to the entitykey property of this SearchResult.
  • entity_type (str) – The value to assign to the entity_type property of this SearchResult.
  • entity_name (str) – The value to assign to the entity_name property of this SearchResult.
  • glossary_key (str) – The value to assign to the glossary_key property of this SearchResult.
  • glossary_name (str) – The value to assign to the glossary_name property of this SearchResult.
  • parent_term_key (str) – The value to assign to the parent_term_key property of this SearchResult.
  • parent_term_name (str) – The value to assign to the parent_term_name property of this SearchResult.
  • created_by_id (str) – The value to assign to the created_by_id property of this SearchResult.
  • updated_by_id (str) – The value to assign to the updated_by_id property of this SearchResult.
  • path (str) – The value to assign to the path property of this SearchResult.
  • business_name (str) – The value to assign to the business_name property of this SearchResult.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SearchResult. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • attribute_type (str) – The value to assign to the attribute_type property of this SearchResult.
  • expression (str) – The value to assign to the expression property of this SearchResult.
  • custom_properties (list[oci.data_catalog.models.FacetedSearchCustomProperty]) – The value to assign to the custom_properties property of this SearchResult.
attribute_type

Gets the attribute_type of this SearchResult. Type name of the attribute. For example - complex, primitive, or array.

Returns:The attribute_type of this SearchResult.
Return type:str
business_name

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

Returns:The business_name of this SearchResult.
Return type:str
created_by_id

Gets the created_by_id of this SearchResult. OCID of the user who created the resource.

Returns:The created_by_id of this SearchResult.
Return type:str
custom_properties

Gets the custom_properties of this SearchResult. Custom properties defined by users.

Returns:The custom_properties of this SearchResult.
Return type:list[oci.data_catalog.models.FacetedSearchCustomProperty]
data_asset_key

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

Returns:The data_asset_key of this SearchResult.
Return type:str
data_asset_name

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

Returns:The data_asset_name of this SearchResult.
Return type:str
data_asset_type

Gets the data_asset_type of this SearchResult. Type name of the data asset. For example, Oracle, MySQL or Oracle Object Storage.

Returns:The data_asset_type of this SearchResult.
Return type:str
description

Gets the description of this SearchResult. Detailed description of the object.

Returns:The description of this SearchResult.
Return type:str
entity_name

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

Returns:The entity_name of this SearchResult.
Return type:str
entity_type

Gets the entity_type of this SearchResult. Type name of the entity. For example, table, view, external table, file, or object.

Returns:The entity_type of this SearchResult.
Return type:str
entitykey

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

Returns:The entitykey of this SearchResult.
Return type:str
expression

Gets the expression of this SearchResult. Expression for logical entities against which names of dataObjects will be matched.

Returns:The expression of this SearchResult.
Return type:str
external_data_type

Gets the external_data_type of this SearchResult. Data type of the object if the object is an attribute. Null otherwise.

Returns:The external_data_type of this SearchResult.
Return type:str
external_type_name

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

Returns:The external_type_name of this SearchResult.
Return type:str
folder_key

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

Returns:The folder_key of this SearchResult.
Return type:str
folder_name

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

Returns:The folder_name of this SearchResult.
Return type:str
folder_type

Gets the folder_type of this SearchResult. Type name of the folder. For example, schema, directory, or topic.

Returns:The folder_type of this SearchResult.
Return type:str
glossary_key

Gets the glossary_key of this SearchResult. Unique id of the parent glossary.

Returns:The glossary_key of this SearchResult.
Return type:str
glossary_name

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

Returns:The glossary_name of this SearchResult.
Return type:str
key

Gets the key of this SearchResult. Unique key of the object returned as part of the search result.

Returns:The key of this SearchResult.
Return type:str
lifecycle_state

Gets the lifecycle_state of this SearchResult. The current state of the data object.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this SearchResult.
Return type:str
name

Gets the name of this SearchResult. Name of the object.

Returns:The name of this SearchResult.
Return type:str
parent_term_key

Gets the parent_term_key of this SearchResult. This terms parent term key. Will be null if the term has no parent term.

Returns:The parent_term_key of this SearchResult.
Return type:str
parent_term_name

Gets the parent_term_name of this SearchResult. Name of the parent term. Will be null if the term has no parent term.

Returns:The parent_term_name of this SearchResult.
Return type:str
path

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

Returns:The path of this SearchResult.
Return type:str
tag_summary

Gets the tag_summary of this SearchResult. Array of the tags associated with this object.

Returns:The tag_summary of this SearchResult.
Return type:list[oci.data_catalog.models.SearchTagSummary]
term_summary

Gets the term_summary of this SearchResult. Array of the terms associated with this object.

Returns:The term_summary of this SearchResult.
Return type:list[oci.data_catalog.models.SearchTermSummary]
time_created

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

Returns:The time_created of this SearchResult.
Return type:datetime
time_updated

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

Returns:The time_updated of this SearchResult.
Return type:datetime
type_name

Gets the type_name of this SearchResult. Name of the object type.

Returns:The type_name of this SearchResult.
Return type:str
updated_by_id

Gets the updated_by_id of this SearchResult. OCID of the user who updated the resource.

Returns:The updated_by_id of this SearchResult.
Return type:str