UpdateCustomPropertyDetails

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

Bases: object

Properties used in custom atrribute update operations.

Methods

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

Attributes

allowed_values Gets the allowed_values of this UpdateCustomPropertyDetails.
description Gets the description of this UpdateCustomPropertyDetails.
display_name Gets the display_name of this UpdateCustomPropertyDetails.
is_editable Gets the is_editable of this UpdateCustomPropertyDetails.
is_filterable Gets the is_filterable of this UpdateCustomPropertyDetails.
is_hidden Gets the is_hidden of this UpdateCustomPropertyDetails.
is_hidden_in_search Gets the is_hidden_in_search of this UpdateCustomPropertyDetails.
is_multi_valued Gets the is_multi_valued of this UpdateCustomPropertyDetails.
is_sortable Gets the is_sortable of this UpdateCustomPropertyDetails.
properties Gets the properties of this UpdateCustomPropertyDetails.
__init__(**kwargs)

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

Parameters:
  • display_name (str) – The value to assign to the display_name property of this UpdateCustomPropertyDetails.
  • description (str) – The value to assign to the description property of this UpdateCustomPropertyDetails.
  • is_sortable (bool) – The value to assign to the is_sortable property of this UpdateCustomPropertyDetails.
  • is_filterable (bool) – The value to assign to the is_filterable property of this UpdateCustomPropertyDetails.
  • is_multi_valued (bool) – The value to assign to the is_multi_valued property of this UpdateCustomPropertyDetails.
  • is_hidden (bool) – The value to assign to the is_hidden property of this UpdateCustomPropertyDetails.
  • is_editable (bool) – The value to assign to the is_editable property of this UpdateCustomPropertyDetails.
  • is_hidden_in_search (bool) – The value to assign to the is_hidden_in_search property of this UpdateCustomPropertyDetails.
  • allowed_values (list[str]) – The value to assign to the allowed_values property of this UpdateCustomPropertyDetails.
  • properties (dict(str, dict(str, str))) – The value to assign to the properties property of this UpdateCustomPropertyDetails.
allowed_values

Gets the allowed_values of this UpdateCustomPropertyDetails. Allowed values for the custom property if any

Returns:The allowed_values of this UpdateCustomPropertyDetails.
Return type:list[str]
description

Gets the description of this UpdateCustomPropertyDetails. Detailed description of the data asset.

Returns:The description of this UpdateCustomPropertyDetails.
Return type:str
display_name

Gets the display_name of this UpdateCustomPropertyDetails. 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 UpdateCustomPropertyDetails.
Return type:str
is_editable

Gets the is_editable of this UpdateCustomPropertyDetails. If this field is a editable field

Returns:The is_editable of this UpdateCustomPropertyDetails.
Return type:bool
is_filterable

Gets the is_filterable of this UpdateCustomPropertyDetails. If this field allows to filter or create facets from UI

Returns:The is_filterable of this UpdateCustomPropertyDetails.
Return type:bool
is_hidden

Gets the is_hidden of this UpdateCustomPropertyDetails. If this field is a hidden field

Returns:The is_hidden of this UpdateCustomPropertyDetails.
Return type:bool

Gets the is_hidden_in_search of this UpdateCustomPropertyDetails. If this field is allowed to pop in search results

Returns:The is_hidden_in_search of this UpdateCustomPropertyDetails.
Return type:bool
is_multi_valued

Gets the is_multi_valued of this UpdateCustomPropertyDetails. If this field allows multiple values to be set

Returns:The is_multi_valued of this UpdateCustomPropertyDetails.
Return type:bool
is_sortable

Gets the is_sortable of this UpdateCustomPropertyDetails. If this field allows to sort from UI

Returns:The is_sortable of this UpdateCustomPropertyDetails.
Return type:bool
properties

Gets the properties of this UpdateCustomPropertyDetails. A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it’s set of required and optional properties. 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 data assets have required properties within the “default” category. Example: {“properties”: { “default”: { “host”: “host1”, “port”: “1521”, “database”: “orcl”}}}

Returns:The properties of this UpdateCustomPropertyDetails.
Return type:dict(str, dict(str, str))