CustomProperty

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

Bases: object

Custom Property Definition

Attributes:

DATA_TYPE_BOOLEAN

A constant which can be used with the data_type property of a CustomProperty.

DATA_TYPE_DATE

A constant which can be used with the data_type property of a CustomProperty.

DATA_TYPE_NUMBER

A constant which can be used with the data_type property of a CustomProperty.

DATA_TYPE_RICH_TEXT

A constant which can be used with the data_type property of a CustomProperty.

DATA_TYPE_TEXT

A constant which can be used with the data_type property of a CustomProperty.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a CustomProperty.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a CustomProperty.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a CustomProperty.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a CustomProperty.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a CustomProperty.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a CustomProperty.

LIFECYCLE_STATE_MOVING

A constant which can be used with the lifecycle_state property of a CustomProperty.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a CustomProperty.

allowed_values

Gets the allowed_values of this CustomProperty.

created_by_id

Gets the created_by_id of this CustomProperty.

data_type

Gets the data_type of this CustomProperty.

description

Gets the description of this CustomProperty.

display_name

Gets the display_name of this CustomProperty.

events

Gets the events of this CustomProperty.

is_editable

Gets the is_editable of this CustomProperty.

is_event_enabled

Gets the is_event_enabled of this CustomProperty.

is_filterable

Gets the is_filterable of this CustomProperty.

is_hidden

Gets the is_hidden of this CustomProperty.

is_hidden_in_search

Gets the is_hidden_in_search of this CustomProperty.

is_list_type

Gets the is_list_type of this CustomProperty.

is_multi_valued

Gets the is_multi_valued of this CustomProperty.

is_service_defined

Gets the is_service_defined of this CustomProperty.

is_shown_in_list

Gets the is_shown_in_list of this CustomProperty.

is_sortable

Gets the is_sortable of this CustomProperty.

key

[Required] Gets the key of this CustomProperty.

lifecycle_state

Gets the lifecycle_state of this CustomProperty.

namespace_name

Gets the namespace_name of this CustomProperty.

properties

Gets the properties of this CustomProperty.

scope

Gets the scope of this CustomProperty.

time_created

Gets the time_created of this CustomProperty.

time_updated

Gets the time_updated of this CustomProperty.

updated_by_id

Gets the updated_by_id of this CustomProperty.

usage_count

Gets the usage_count of this CustomProperty.

Methods:

__init__(**kwargs)

Initializes a new CustomProperty object with values from keyword arguments.

DATA_TYPE_BOOLEAN = 'BOOLEAN'

A constant which can be used with the data_type property of a CustomProperty. This constant has a value of “BOOLEAN”

DATA_TYPE_DATE = 'DATE'

A constant which can be used with the data_type property of a CustomProperty. This constant has a value of “DATE”

DATA_TYPE_NUMBER = 'NUMBER'

A constant which can be used with the data_type property of a CustomProperty. 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 CustomProperty. 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 CustomProperty. This constant has a value of “TEXT”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new CustomProperty 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 CustomProperty.

  • display_name (str) – The value to assign to the display_name property of this CustomProperty.

  • data_type (str) – The value to assign to the data_type property of this CustomProperty. Allowed values for this property are: “TEXT”, “RICH_TEXT”, “BOOLEAN”, “NUMBER”, “DATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • description (str) – The value to assign to the description property of this CustomProperty.

  • namespace_name (str) – The value to assign to the namespace_name property of this CustomProperty.

  • is_list_type (bool) – The value to assign to the is_list_type property of this CustomProperty.

  • is_sortable (bool) – The value to assign to the is_sortable property of this CustomProperty.

  • is_filterable (bool) – The value to assign to the is_filterable property of this CustomProperty.

  • is_multi_valued (bool) – The value to assign to the is_multi_valued property of this CustomProperty.

  • is_hidden (bool) – The value to assign to the is_hidden property of this CustomProperty.

  • is_editable (bool) – The value to assign to the is_editable property of this CustomProperty.

  • is_shown_in_list (bool) – The value to assign to the is_shown_in_list property of this CustomProperty.

  • is_service_defined (bool) – The value to assign to the is_service_defined property of this CustomProperty.

  • is_hidden_in_search (bool) – The value to assign to the is_hidden_in_search property of this CustomProperty.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CustomProperty. 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’.

  • time_created (datetime) – The value to assign to the time_created property of this CustomProperty.

  • time_updated (datetime) – The value to assign to the time_updated property of this CustomProperty.

  • created_by_id (str) – The value to assign to the created_by_id property of this CustomProperty.

  • updated_by_id (str) – The value to assign to the updated_by_id property of this CustomProperty.

  • usage_count (int) – The value to assign to the usage_count property of this CustomProperty.

  • is_event_enabled (bool) – The value to assign to the is_event_enabled property of this CustomProperty.

  • scope (list[oci.data_catalog.models.CustomPropertyTypeUsage]) – The value to assign to the scope property of this CustomProperty.

  • allowed_values (list[str]) – The value to assign to the allowed_values property of this CustomProperty.

  • events (list[oci.data_catalog.models.EventConfig]) – The value to assign to the events property of this CustomProperty.

  • properties (dict(str, dict(str, str))) – The value to assign to the properties property of this CustomProperty.

property allowed_values

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

Returns

The allowed_values of this CustomProperty.

Return type

list[str]

property created_by_id

Gets the created_by_id of this CustomProperty. OCID of the user who created the custom property.

Returns

The created_by_id of this CustomProperty.

Return type

str

property data_type

Gets the data_type of this CustomProperty. Data type of the custom property

Allowed values for this property are: “TEXT”, “RICH_TEXT”, “BOOLEAN”, “NUMBER”, “DATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The data_type of this CustomProperty.

Return type

str

property description

Gets the description of this CustomProperty. Description for the custom property

Returns

The description of this CustomProperty.

Return type

str

property display_name

Gets the display_name of this CustomProperty. Display name of the custom property

Returns

The display_name of this CustomProperty.

Return type

str

property events

Gets the events of this CustomProperty. Event configuration for this custom property, against the desired subset of object types to which the property applies.

Returns

The events of this CustomProperty.

Return type

list[oci.data_catalog.models.EventConfig]

property is_editable

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

Returns

The is_editable of this CustomProperty.

Return type

bool

property is_event_enabled

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

Returns

The is_event_enabled of this CustomProperty.

Return type

bool

property is_filterable

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

Returns

The is_filterable of this CustomProperty.

Return type

bool

property is_hidden

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

Returns

The is_hidden of this CustomProperty.

Return type

bool

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

Returns

The is_hidden_in_search of this CustomProperty.

Return type

bool

property is_list_type

Gets the is_list_type of this CustomProperty. Is this property allowed to have list of values

Returns

The is_list_type of this CustomProperty.

Return type

bool

property is_multi_valued

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

Returns

The is_multi_valued of this CustomProperty.

Return type

bool

property is_service_defined

Gets the is_service_defined of this CustomProperty. If this field is defined by service or by a user

Returns

The is_service_defined of this CustomProperty.

Return type

bool

property is_shown_in_list

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

Returns

The is_shown_in_list of this CustomProperty.

Return type

bool

property is_sortable

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

Returns

The is_sortable of this CustomProperty.

Return type

bool

property key

[Required] Gets the key of this CustomProperty. Unique data asset key that is immutable.

Returns

The key of this CustomProperty.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this CustomProperty. The current state of the custom property.

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 CustomProperty.

Return type

str

property namespace_name

Gets the namespace_name of this CustomProperty. Namespace name of the custom property

Returns

The namespace_name of this CustomProperty.

Return type

str

property properties

Gets the properties of this CustomProperty. 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 CustomProperty.

Return type

dict(str, dict(str, str))

property scope

Gets the scope of this CustomProperty. The set of object types to which the custom property applies.

Returns

The scope of this CustomProperty.

Return type

list[oci.data_catalog.models.CustomPropertyTypeUsage]

property time_created

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

Returns

The time_created of this CustomProperty.

Return type

datetime

property time_updated

Gets the time_updated of this CustomProperty. The last time that any change was made to the custom property. An RFC3339 formatted datetime string.

Returns

The time_updated of this CustomProperty.

Return type

datetime

property updated_by_id

Gets the updated_by_id of this CustomProperty. OCID of the user who last modified the custom property.

Returns

The updated_by_id of this CustomProperty.

Return type

str

property usage_count

Gets the usage_count of this CustomProperty. Total number of first class objects using this custom property

Returns

The usage_count of this CustomProperty.

Return type

int