CustomPropertyGetUsage¶
- class oci.data_catalog.models.CustomPropertyGetUsage(**kwargs)¶
Bases:
objectDetails of a single custom property
Attributes:
A constant which can be used with the data_type property of a CustomPropertyGetUsage.
A constant which can be used with the data_type property of a CustomPropertyGetUsage.
A constant which can be used with the data_type property of a CustomPropertyGetUsage.
A constant which can be used with the data_type property of a CustomPropertyGetUsage.
A constant which can be used with the data_type property of a CustomPropertyGetUsage.
Gets the allowed_values of this CustomPropertyGetUsage.
Gets the data_type of this CustomPropertyGetUsage.
Gets the description of this CustomPropertyGetUsage.
Gets the display_name of this CustomPropertyGetUsage.
Gets the is_editable of this CustomPropertyGetUsage.
Gets the is_event_enabled of this CustomPropertyGetUsage.
Gets the is_hidden of this CustomPropertyGetUsage.
Gets the is_list_type of this CustomPropertyGetUsage.
Gets the is_multi_valued of this CustomPropertyGetUsage.
Gets the is_shown_in_list of this CustomPropertyGetUsage.
Gets the key of this CustomPropertyGetUsage.
Gets the namespace_key of this CustomPropertyGetUsage.
Gets the namespace_name of this CustomPropertyGetUsage.
Gets the value of this CustomPropertyGetUsage.
Methods:
__init__(**kwargs)Initializes a new CustomPropertyGetUsage object with values from keyword arguments.
- DATA_TYPE_BOOLEAN = 'BOOLEAN'¶
A constant which can be used with the data_type property of a CustomPropertyGetUsage. This constant has a value of “BOOLEAN”
- DATA_TYPE_DATE = 'DATE'¶
A constant which can be used with the data_type property of a CustomPropertyGetUsage. This constant has a value of “DATE”
- DATA_TYPE_NUMBER = 'NUMBER'¶
A constant which can be used with the data_type property of a CustomPropertyGetUsage. 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 CustomPropertyGetUsage. 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 CustomPropertyGetUsage. This constant has a value of “TEXT”
- __init__(**kwargs)¶
Initializes a new CustomPropertyGetUsage 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 CustomPropertyGetUsage.
display_name (str) – The value to assign to the display_name property of this CustomPropertyGetUsage.
description (str) – The value to assign to the description property of this CustomPropertyGetUsage.
value (str) – The value to assign to the value property of this CustomPropertyGetUsage.
data_type (str) – The value to assign to the data_type property of this CustomPropertyGetUsage. 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 CustomPropertyGetUsage.
namespace_key (str) – The value to assign to the namespace_key property of this CustomPropertyGetUsage.
is_multi_valued (bool) – The value to assign to the is_multi_valued property of this CustomPropertyGetUsage.
is_hidden (bool) – The value to assign to the is_hidden property of this CustomPropertyGetUsage.
is_editable (bool) – The value to assign to the is_editable property of this CustomPropertyGetUsage.
is_shown_in_list (bool) – The value to assign to the is_shown_in_list property of this CustomPropertyGetUsage.
is_event_enabled (bool) – The value to assign to the is_event_enabled property of this CustomPropertyGetUsage.
is_list_type (bool) – The value to assign to the is_list_type property of this CustomPropertyGetUsage.
allowed_values (list[str]) – The value to assign to the allowed_values property of this CustomPropertyGetUsage.
- property allowed_values¶
Gets the allowed_values of this CustomPropertyGetUsage. Allowed values for the custom property if any
- Returns
The allowed_values of this CustomPropertyGetUsage.
- Return type
list[str]
- property data_type¶
Gets the data_type of this CustomPropertyGetUsage. The 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 CustomPropertyGetUsage.
- Return type
str
- property description¶
Gets the description of this CustomPropertyGetUsage. Description of the custom property
- Returns
The description of this CustomPropertyGetUsage.
- Return type
str
- property display_name¶
Gets the display_name of this CustomPropertyGetUsage. Display name of the custom property
- Returns
The display_name of this CustomPropertyGetUsage.
- Return type
str
- property is_editable¶
Gets the is_editable of this CustomPropertyGetUsage. If this field is a editable field
- Returns
The is_editable of this CustomPropertyGetUsage.
- Return type
bool
- property is_event_enabled¶
Gets the is_event_enabled of this CustomPropertyGetUsage. If an OCI Event will be emitted when the custom property is modified.
- Returns
The is_event_enabled of this CustomPropertyGetUsage.
- Return type
bool
Gets the is_hidden of this CustomPropertyGetUsage. If this field is a hidden field
- Returns
The is_hidden of this CustomPropertyGetUsage.
- Return type
bool
- property is_list_type¶
Gets the is_list_type of this CustomPropertyGetUsage. Is this property allowed to have list of values
- Returns
The is_list_type of this CustomPropertyGetUsage.
- Return type
bool
- property is_multi_valued¶
Gets the is_multi_valued of this CustomPropertyGetUsage. If this field allows multiple values to be set
- Returns
The is_multi_valued of this CustomPropertyGetUsage.
- Return type
bool
- property is_shown_in_list¶
Gets the is_shown_in_list of this CustomPropertyGetUsage. If this field is displayed in a list view of applicable objects.
- Returns
The is_shown_in_list of this CustomPropertyGetUsage.
- Return type
bool
- property key¶
Gets the key of this CustomPropertyGetUsage. Unique Identifier of the attribute which is ID
- Returns
The key of this CustomPropertyGetUsage.
- Return type
str
- property namespace_key¶
Gets the namespace_key of this CustomPropertyGetUsage. Unique namespace key that is immutable
- Returns
The namespace_key of this CustomPropertyGetUsage.
- Return type
str
- property namespace_name¶
Gets the namespace_name of this CustomPropertyGetUsage. Namespace name of the custom property
- Returns
The namespace_name of this CustomPropertyGetUsage.
- Return type
str
- property value¶
Gets the value of this CustomPropertyGetUsage. The custom property value
- Returns
The value of this CustomPropertyGetUsage.
- Return type
str