SearchTermSummary¶

class oci.data_catalog.models.SearchTermSummary(**kwargs)¶

Bases: object

Summary of a term associated with an object. This is a brief summary returned as part of the search result.

Methods

__init__(**kwargs) Initializes a new SearchTermSummary object with values from keyword arguments.

Attributes

`display_name`	[Required] Gets the display_name of this SearchTermSummary.
`glossary_key`	Gets the glossary_key of this SearchTermSummary.
`glossary_name`	Gets the glossary_name of this SearchTermSummary.
`key`	Gets the key of this SearchTermSummary.
`parent_term_key`	Gets the parent_term_key of this SearchTermSummary.
`parent_term_name`	Gets the parent_term_name of this SearchTermSummary.

__init__(**kwargs)¶

Initializes a new SearchTermSummary 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 SearchTermSummary.
display_name (str) – The value to assign to the display_name property of this SearchTermSummary.
glossary_key (str) – The value to assign to the glossary_key property of this SearchTermSummary.
glossary_name (str) – The value to assign to the glossary_name property of this SearchTermSummary.
parent_term_key (str) – The value to assign to the parent_term_key property of this SearchTermSummary.
parent_term_name (str) – The value to assign to the parent_term_name property of this SearchTermSummary.

display_name¶

[Required] Gets the display_name of this SearchTermSummary. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this SearchTermSummary.
Return type:	str

glossary_key¶

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

Returns:	The glossary_key of this SearchTermSummary.
Return type:	str

glossary_name¶

Gets the glossary_name of this SearchTermSummary. Name of the parent glossary.

Returns:	The glossary_name of this SearchTermSummary.
Return type:	str

key¶

Gets the key of this SearchTermSummary. Unique term key that is immutable.

Returns:	The key of this SearchTermSummary.
Return type:	str

parent_term_key¶

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

Returns:	The parent_term_key of this SearchTermSummary.
Return type:	str

parent_term_name¶

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

Returns:	The parent_term_name of this SearchTermSummary.
Return type:	str