EntityAttribute¶

class oci.oda.models.EntityAttribute(**kwargs)¶

Bases: object

Attribute of an entity

Attributes

`TEMPORAL_PREFERENCE_FUTURE`	A constant which can be used with the temporal_preference property of a EntityAttribute.
`TEMPORAL_PREFERENCE_NEAREST`	A constant which can be used with the temporal_preference property of a EntityAttribute.
`TEMPORAL_PREFERENCE_PAST`	A constant which can be used with the temporal_preference property of a EntityAttribute.
`TYPE_ATTRIBUTE_REFERENCE`	A constant which can be used with the type property of a EntityAttribute.
`TYPE_BOOLEAN`	A constant which can be used with the type property of a EntityAttribute.
`TYPE_COMPOSITE_ENTITY`	A constant which can be used with the type property of a EntityAttribute.
`TYPE_DATE`	A constant which can be used with the type property of a EntityAttribute.
`TYPE_DATE_TIME`	A constant which can be used with the type property of a EntityAttribute.
`TYPE_ENTITY`	A constant which can be used with the type property of a EntityAttribute.
`TYPE_NUMBER`	A constant which can be used with the type property of a EntityAttribute.
`TYPE_TEXT`	A constant which can be used with the type property of a EntityAttribute.
`entity_name`	Gets the entity_name of this EntityAttribute.
`is_fuzzy_match`	Gets the is_fuzzy_match of this EntityAttribute.
`is_invert_comparisons`	Gets the is_invert_comparisons of this EntityAttribute.
`is_multi_value`	Gets the is_multi_value of this EntityAttribute.
`name`	[Required] Gets the name of this EntityAttribute.
`natural_language_mapping`	Gets the natural_language_mapping of this EntityAttribute.
`temporal_preference`	Gets the temporal_preference of this EntityAttribute.
`type`	[Required] Gets the type of this EntityAttribute.

Methods

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

TEMPORAL_PREFERENCE_FUTURE = 'FUTURE'¶: A constant which can be used with the temporal_preference property of a EntityAttribute. This constant has a value of “FUTURE”

TEMPORAL_PREFERENCE_NEAREST = 'NEAREST'¶: A constant which can be used with the temporal_preference property of a EntityAttribute. This constant has a value of “NEAREST”

TEMPORAL_PREFERENCE_PAST = 'PAST'¶: A constant which can be used with the temporal_preference property of a EntityAttribute. This constant has a value of “PAST”

TYPE_ATTRIBUTE_REFERENCE = 'ATTRIBUTE_REFERENCE'¶: A constant which can be used with the type property of a EntityAttribute. This constant has a value of “ATTRIBUTE_REFERENCE”

TYPE_BOOLEAN = 'BOOLEAN'¶: A constant which can be used with the type property of a EntityAttribute. This constant has a value of “BOOLEAN”

TYPE_COMPOSITE_ENTITY = 'COMPOSITE_ENTITY'¶: A constant which can be used with the type property of a EntityAttribute. This constant has a value of “COMPOSITE_ENTITY”

TYPE_DATE = 'DATE'¶: A constant which can be used with the type property of a EntityAttribute. This constant has a value of “DATE”

TYPE_DATE_TIME = 'DATE_TIME'¶: A constant which can be used with the type property of a EntityAttribute. This constant has a value of “DATE_TIME”

TYPE_ENTITY = 'ENTITY'¶: A constant which can be used with the type property of a EntityAttribute. This constant has a value of “ENTITY”

TYPE_NUMBER = 'NUMBER'¶: A constant which can be used with the type property of a EntityAttribute. This constant has a value of “NUMBER”

TYPE_TEXT = 'TEXT'¶: A constant which can be used with the type property of a EntityAttribute. This constant has a value of “TEXT”

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this EntityAttribute.
type (str) – The value to assign to the type property of this EntityAttribute. Allowed values for this property are: “TEXT”, “NUMBER”, “DATE_TIME”, “DATE”, “ENTITY”, “COMPOSITE_ENTITY”, “ATTRIBUTE_REFERENCE”, “BOOLEAN”
natural_language_mapping (oci.oda.models.EntityAttributeNaturalLanguageMapping) – The value to assign to the natural_language_mapping property of this EntityAttribute.
is_multi_value (bool) – The value to assign to the is_multi_value property of this EntityAttribute.
is_fuzzy_match (bool) – The value to assign to the is_fuzzy_match property of this EntityAttribute.
is_invert_comparisons (bool) – The value to assign to the is_invert_comparisons property of this EntityAttribute.
temporal_preference (str) – The value to assign to the temporal_preference property of this EntityAttribute. Allowed values for this property are: “PAST”, “FUTURE”, “NEAREST”
entity_name (str) – The value to assign to the entity_name property of this EntityAttribute.

entity_name¶

Gets the entity_name of this EntityAttribute. Name of referenced entity.

Returns:	The entity_name of this EntityAttribute.
Return type:	str

is_fuzzy_match¶

Gets the is_fuzzy_match of this EntityAttribute. Is the entity attribute a fuzzy match

Returns:	The is_fuzzy_match of this EntityAttribute.
Return type:	bool

is_invert_comparisons¶

Gets the is_invert_comparisons of this EntityAttribute. Are comparisons inverted in the entity attribute

Returns:	The is_invert_comparisons of this EntityAttribute.
Return type:	bool

is_multi_value¶

Gets the is_multi_value of this EntityAttribute. Is the entity attribute multi-value

Returns:	The is_multi_value of this EntityAttribute.
Return type:	bool

name¶

[Required] Gets the name of this EntityAttribute. The name of an entity attribute

Returns:	The name of this EntityAttribute.
Return type:	str

natural_language_mapping¶

Gets the natural_language_mapping of this EntityAttribute.

Returns:	The natural_language_mapping of this EntityAttribute.
Return type:	oci.oda.models.EntityAttributeNaturalLanguageMapping

temporal_preference¶

Gets the temporal_preference of this EntityAttribute. Temporal preference of an attribute

Allowed values for this property are: “PAST”, “FUTURE”, “NEAREST”

Returns:	The temporal_preference of this EntityAttribute.
Return type:	str

type¶

[Required] Gets the type of this EntityAttribute. The type of an entity attribute

Allowed values for this property are: “TEXT”, “NUMBER”, “DATE_TIME”, “DATE”, “ENTITY”, “COMPOSITE_ENTITY”, “ATTRIBUTE_REFERENCE”, “BOOLEAN”

Returns:	The type of this EntityAttribute.
Return type:	str