CreateCustomPropertyDetails¶

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

Bases: object

Properties used in custom property create operations.

Attributes

`DATA_TYPE_BOOLEAN`	A constant which can be used with the data_type property of a CreateCustomPropertyDetails.
`DATA_TYPE_DATE`	A constant which can be used with the data_type property of a CreateCustomPropertyDetails.
`DATA_TYPE_NUMBER`	A constant which can be used with the data_type property of a CreateCustomPropertyDetails.
`DATA_TYPE_RICH_TEXT`	A constant which can be used with the data_type property of a CreateCustomPropertyDetails.
`DATA_TYPE_TEXT`	A constant which can be used with the data_type property of a CreateCustomPropertyDetails.
`allowed_values`	Gets the allowed_values of this CreateCustomPropertyDetails.
`data_type`	Gets the data_type of this CreateCustomPropertyDetails.
`description`	Gets the description of this CreateCustomPropertyDetails.
`display_name`	[Required] Gets the display_name of this CreateCustomPropertyDetails.
`is_editable`	Gets the is_editable of this CreateCustomPropertyDetails.
`is_event_enabled`	Gets the is_event_enabled of this CreateCustomPropertyDetails.
`is_filterable`	Gets the is_filterable of this CreateCustomPropertyDetails.
`is_hidden`	Gets the is_hidden of this CreateCustomPropertyDetails.
`is_hidden_in_search`	Gets the is_hidden_in_search of this CreateCustomPropertyDetails.
`is_multi_valued`	Gets the is_multi_valued of this CreateCustomPropertyDetails.
`is_shown_in_list`	Gets the is_shown_in_list of this CreateCustomPropertyDetails.
`is_sortable`	Gets the is_sortable of this CreateCustomPropertyDetails.
`properties`	Gets the properties of this CreateCustomPropertyDetails.

Methods

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

DATA_TYPE_BOOLEAN = 'BOOLEAN'¶: A constant which can be used with the data_type property of a CreateCustomPropertyDetails. This constant has a value of “BOOLEAN”

DATA_TYPE_DATE = 'DATE'¶: A constant which can be used with the data_type property of a CreateCustomPropertyDetails. This constant has a value of “DATE”

DATA_TYPE_NUMBER = 'NUMBER'¶: A constant which can be used with the data_type property of a CreateCustomPropertyDetails. This constant has a value of “NUMBER”

DATA_TYPE_RICH_TEXT = 'RICH_TEXT'¶: A constant which can be used with the data_type property of a CreateCustomPropertyDetails. This constant has a value of “RICH_TEXT”

DATA_TYPE_TEXT = 'TEXT'¶: A constant which can be used with the data_type property of a CreateCustomPropertyDetails. This constant has a value of “TEXT”

__init__(**kwargs)¶

Initializes a new CreateCustomPropertyDetails 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 CreateCustomPropertyDetails.
description (str) – The value to assign to the description property of this CreateCustomPropertyDetails.
data_type (str) – The value to assign to the data_type property of this CreateCustomPropertyDetails. Allowed values for this property are: “TEXT”, “RICH_TEXT”, “BOOLEAN”, “NUMBER”, “DATE”
is_sortable (bool) – The value to assign to the is_sortable property of this CreateCustomPropertyDetails.
is_filterable (bool) – The value to assign to the is_filterable property of this CreateCustomPropertyDetails.
is_multi_valued (bool) – The value to assign to the is_multi_valued property of this CreateCustomPropertyDetails.
is_hidden (bool) – The value to assign to the is_hidden property of this CreateCustomPropertyDetails.
is_editable (bool) – The value to assign to the is_editable property of this CreateCustomPropertyDetails.
is_shown_in_list (bool) – The value to assign to the is_shown_in_list property of this CreateCustomPropertyDetails.
is_hidden_in_search (bool) – The value to assign to the is_hidden_in_search property of this CreateCustomPropertyDetails.
is_event_enabled (bool) – The value to assign to the is_event_enabled property of this CreateCustomPropertyDetails.
allowed_values (list[str]) – The value to assign to the allowed_values property of this CreateCustomPropertyDetails.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this CreateCustomPropertyDetails.

allowed_values¶

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

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

data_type¶

Gets the data_type of this CreateCustomPropertyDetails. The data type of the custom property

Allowed values for this property are: “TEXT”, “RICH_TEXT”, “BOOLEAN”, “NUMBER”, “DATE”

Returns:	The data_type of this CreateCustomPropertyDetails.
Return type:	str

description¶

Gets the description of this CreateCustomPropertyDetails. Detailed description of the custom property.

Returns:	The description of this CreateCustomPropertyDetails.
Return type:	str

display_name¶

[Required] Gets the display_name of this CreateCustomPropertyDetails. 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 CreateCustomPropertyDetails.
Return type:	str

is_editable¶

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

Returns:	The is_editable of this CreateCustomPropertyDetails.
Return type:	bool

is_event_enabled¶

Gets the is_event_enabled of this CreateCustomPropertyDetails. If an OCI Event will be emitted when the custom property is modified.

Returns:	The is_event_enabled of this CreateCustomPropertyDetails.
Return type:	bool

is_filterable¶

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

Returns:	The is_filterable of this CreateCustomPropertyDetails.
Return type:	bool

is_hidden¶

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

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

is_hidden_in_search¶

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

Returns:	The is_hidden_in_search of this CreateCustomPropertyDetails.
Return type:	bool

is_multi_valued¶

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

Returns:	The is_multi_valued of this CreateCustomPropertyDetails.
Return type:	bool

is_shown_in_list¶

Gets the is_shown_in_list of this CreateCustomPropertyDetails. If this field is displayed in a list view of applicable objects.

Returns:	The is_shown_in_list of this CreateCustomPropertyDetails.
Return type:	bool

is_sortable¶

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

Returns:	The is_sortable of this CreateCustomPropertyDetails.
Return type:	bool

properties¶

Gets the properties of this CreateCustomPropertyDetails. A map of maps that contains the properties which are specific to the data 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. To determine the set of optional and required properties for a data asset type, a query can be done on ‘/types?type=dataAsset’ that returns a collection of all data asset types. The appropriate data asset type, which includes definitions of all of it’s properties, can be identified from this collection. Example: {“properties”: { “default”: { “host”: “host1”, “port”: “1521”, “database”: “orcl”}}}

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