CustomPropertySummary¶
- class oci.data_catalog.models.CustomPropertySummary(**kwargs)¶
Bases:
objectSummary of a custom property
Attributes:
A constant which can be used with the data_type property of a CustomPropertySummary.
A constant which can be used with the data_type property of a CustomPropertySummary.
A constant which can be used with the data_type property of a CustomPropertySummary.
A constant which can be used with the data_type property of a CustomPropertySummary.
A constant which can be used with the data_type property of a CustomPropertySummary.
A constant which can be used with the lifecycle_state property of a CustomPropertySummary.
A constant which can be used with the lifecycle_state property of a CustomPropertySummary.
A constant which can be used with the lifecycle_state property of a CustomPropertySummary.
A constant which can be used with the lifecycle_state property of a CustomPropertySummary.
A constant which can be used with the lifecycle_state property of a CustomPropertySummary.
A constant which can be used with the lifecycle_state property of a CustomPropertySummary.
A constant which can be used with the lifecycle_state property of a CustomPropertySummary.
A constant which can be used with the lifecycle_state property of a CustomPropertySummary.
Gets the allowed_values of this CustomPropertySummary.
Gets the created_by_id of this CustomPropertySummary.
Gets the data_type of this CustomPropertySummary.
Gets the description of this CustomPropertySummary.
Gets the display_name of this CustomPropertySummary.
Gets the events of this CustomPropertySummary.
Gets the is_editable of this CustomPropertySummary.
Gets the is_event_enabled of this CustomPropertySummary.
Gets the is_filterable of this CustomPropertySummary.
Gets the is_hidden of this CustomPropertySummary.
Gets the is_hidden_in_search of this CustomPropertySummary.
Gets the is_multi_valued of this CustomPropertySummary.
Gets the is_service_defined of this CustomPropertySummary.
Gets the is_shown_in_list of this CustomPropertySummary.
Gets the is_sortable of this CustomPropertySummary.
[Required] Gets the key of this CustomPropertySummary.
Gets the lifecycle_state of this CustomPropertySummary.
Gets the namespace_name of this CustomPropertySummary.
Gets the scope of this CustomPropertySummary.
Gets the time_created of this CustomPropertySummary.
Gets the time_updated of this CustomPropertySummary.
Gets the updated_by_id of this CustomPropertySummary.
Gets the usage_count of this CustomPropertySummary.
Methods:
__init__(**kwargs)Initializes a new CustomPropertySummary object with values from keyword arguments.
- DATA_TYPE_BOOLEAN = 'BOOLEAN'¶
A constant which can be used with the data_type property of a CustomPropertySummary. This constant has a value of “BOOLEAN”
- DATA_TYPE_DATE = 'DATE'¶
A constant which can be used with the data_type property of a CustomPropertySummary. This constant has a value of “DATE”
- DATA_TYPE_NUMBER = 'NUMBER'¶
A constant which can be used with the data_type property of a CustomPropertySummary. 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 CustomPropertySummary. 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 CustomPropertySummary. This constant has a value of “TEXT”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a CustomPropertySummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a CustomPropertySummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a CustomPropertySummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a CustomPropertySummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a CustomPropertySummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a CustomPropertySummary. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_MOVING = 'MOVING'¶
A constant which can be used with the lifecycle_state property of a CustomPropertySummary. This constant has a value of “MOVING”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a CustomPropertySummary. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new CustomPropertySummary 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 CustomPropertySummary.
display_name (str) – The value to assign to the display_name property of this CustomPropertySummary.
description (str) – The value to assign to the description property of this CustomPropertySummary.
data_type (str) – The value to assign to the data_type property of this CustomPropertySummary. 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’.
namespace_name (str) – The value to assign to the namespace_name property of this CustomPropertySummary.
is_sortable (bool) – The value to assign to the is_sortable property of this CustomPropertySummary.
is_filterable (bool) – The value to assign to the is_filterable property of this CustomPropertySummary.
is_multi_valued (bool) – The value to assign to the is_multi_valued property of this CustomPropertySummary.
is_hidden (bool) – The value to assign to the is_hidden property of this CustomPropertySummary.
is_editable (bool) – The value to assign to the is_editable property of this CustomPropertySummary.
is_shown_in_list (bool) – The value to assign to the is_shown_in_list property of this CustomPropertySummary.
is_service_defined (bool) – The value to assign to the is_service_defined property of this CustomPropertySummary.
is_hidden_in_search (bool) – The value to assign to the is_hidden_in_search property of this CustomPropertySummary.
time_created (datetime) – The value to assign to the time_created property of this CustomPropertySummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CustomPropertySummary. 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’.
usage_count (int) – The value to assign to the usage_count property of this CustomPropertySummary.
scope (list[oci.data_catalog.models.CustomPropertyTypeUsage]) – The value to assign to the scope property of this CustomPropertySummary.
allowed_values (list[str]) – The value to assign to the allowed_values property of this CustomPropertySummary.
time_updated (datetime) – The value to assign to the time_updated property of this CustomPropertySummary.
created_by_id (str) – The value to assign to the created_by_id property of this CustomPropertySummary.
updated_by_id (str) – The value to assign to the updated_by_id property of this CustomPropertySummary.
is_event_enabled (bool) – The value to assign to the is_event_enabled property of this CustomPropertySummary.
events (list[oci.data_catalog.models.EventConfig]) – The value to assign to the events property of this CustomPropertySummary.
- property allowed_values¶
Gets the allowed_values of this CustomPropertySummary. Allowed values for the custom property if any
- Returns
The allowed_values of this CustomPropertySummary.
- Return type
list[str]
- property created_by_id¶
Gets the created_by_id of this CustomPropertySummary. OCID of the user who created the custom property.
- Returns
The created_by_id of this CustomPropertySummary.
- Return type
str
- property data_type¶
Gets the data_type of this CustomPropertySummary. 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 CustomPropertySummary.
- Return type
str
- property description¶
Gets the description of this CustomPropertySummary. Description of the custom property
- Returns
The description of this CustomPropertySummary.
- Return type
str
- property display_name¶
Gets the display_name of this CustomPropertySummary. Display name of the custom property
- Returns
The display_name of this CustomPropertySummary.
- Return type
str
- property events¶
Gets the events of this CustomPropertySummary. Event configuration for this custom property, against the desired subset of object types to which the property applies.
- Returns
The events of this CustomPropertySummary.
- Return type
- property is_editable¶
Gets the is_editable of this CustomPropertySummary. If this field is a editable field
- Returns
The is_editable of this CustomPropertySummary.
- Return type
bool
- property is_event_enabled¶
Gets the is_event_enabled of this CustomPropertySummary. If an OCI Event will be emitted when the custom property is modified.
- Returns
The is_event_enabled of this CustomPropertySummary.
- Return type
bool
- property is_filterable¶
Gets the is_filterable of this CustomPropertySummary. If this field allows to filter or create facets from UI
- Returns
The is_filterable of this CustomPropertySummary.
- Return type
bool
Gets the is_hidden of this CustomPropertySummary. If this field is a hidden field
- Returns
The is_hidden of this CustomPropertySummary.
- Return type
bool
Gets the is_hidden_in_search of this CustomPropertySummary. If this field is allowed to pop in search results
- Returns
The is_hidden_in_search of this CustomPropertySummary.
- Return type
bool
- property is_multi_valued¶
Gets the is_multi_valued of this CustomPropertySummary. If this field allows multiple values to be set
- Returns
The is_multi_valued of this CustomPropertySummary.
- Return type
bool
- property is_service_defined¶
Gets the is_service_defined of this CustomPropertySummary. If this field is defined by service or by a user
- Returns
The is_service_defined of this CustomPropertySummary.
- Return type
bool
- property is_shown_in_list¶
Gets the is_shown_in_list of this CustomPropertySummary. If this field is displayed in a list view of applicable objects.
- Returns
The is_shown_in_list of this CustomPropertySummary.
- Return type
bool
- property is_sortable¶
Gets the is_sortable of this CustomPropertySummary. If this field allows to sort from UI
- Returns
The is_sortable of this CustomPropertySummary.
- Return type
bool
- property key¶
[Required] Gets the key of this CustomPropertySummary. Unique custom property key that is immutable.
- Returns
The key of this CustomPropertySummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this CustomPropertySummary. 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 CustomPropertySummary.
- Return type
str
- property namespace_name¶
Gets the namespace_name of this CustomPropertySummary. Namespace name of the custom property
- Returns
The namespace_name of this CustomPropertySummary.
- Return type
str
- property scope¶
Gets the scope of this CustomPropertySummary. Type or scope of the custom property belongs to. This will be an array of type id it will be belongs to
- Returns
The scope of this CustomPropertySummary.
- Return type
- property time_created¶
Gets the time_created of this CustomPropertySummary. 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 CustomPropertySummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this CustomPropertySummary. The last time that any change was made to the custom property. An RFC3339 formatted datetime string.
- Returns
The time_updated of this CustomPropertySummary.
- Return type
datetime
- property updated_by_id¶
Gets the updated_by_id of this CustomPropertySummary. OCID of the user who last modified the custom property.
- Returns
The updated_by_id of this CustomPropertySummary.
- Return type
str
- property usage_count¶
Gets the usage_count of this CustomPropertySummary. Total number of first class objects using this custom property
- Returns
The usage_count of this CustomPropertySummary.
- Return type
int