EntitiesMapping¶
- class oci.cloud_guard.models.EntitiesMapping(**kwargs)¶
Bases:
objectParameters for entities mapping to data source.
Attributes:
A constant which can be used with the entity_type property of a EntitiesMapping.
A constant which can be used with the entity_type property of a EntitiesMapping.
A constant which can be used with the entity_type property of a EntitiesMapping.
A constant which can be used with the entity_type property of a EntitiesMapping.
Gets the display_name of this EntitiesMapping.
Gets the entity_type of this EntitiesMapping.
[Required] Gets the query_field of this EntitiesMapping.
Methods:
__init__(**kwargs)Initializes a new EntitiesMapping object with values from keyword arguments.
- ENTITY_TYPE_EXTERNAL_IP = 'EXTERNAL_IP'¶
A constant which can be used with the entity_type property of a EntitiesMapping. This constant has a value of “EXTERNAL_IP”
- ENTITY_TYPE_INTERNAL_IP = 'INTERNAL_IP'¶
A constant which can be used with the entity_type property of a EntitiesMapping. This constant has a value of “INTERNAL_IP”
- ENTITY_TYPE_JSON_LIST = 'JSON_LIST'¶
A constant which can be used with the entity_type property of a EntitiesMapping. This constant has a value of “JSON_LIST”
- ENTITY_TYPE_TEXT = 'TEXT'¶
A constant which can be used with the entity_type property of a EntitiesMapping. This constant has a value of “TEXT”
- __init__(**kwargs)¶
Initializes a new EntitiesMapping 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 EntitiesMapping.
query_field (str) – The value to assign to the query_field property of this EntitiesMapping.
entity_type (str) – The value to assign to the entity_type property of this EntitiesMapping. Allowed values for this property are: “EXTERNAL_IP”, “INTERNAL_IP”, “TEXT”, “JSON_LIST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property display_name¶
Gets the display_name of this EntitiesMapping. Display name of the entity
- Returns
The display_name of this EntitiesMapping.
- Return type
str
- property entity_type¶
Gets the entity_type of this EntitiesMapping. Type of entity
Allowed values for this property are: “EXTERNAL_IP”, “INTERNAL_IP”, “TEXT”, “JSON_LIST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The entity_type of this EntitiesMapping.
- Return type
str
- property query_field¶
[Required] Gets the query_field of this EntitiesMapping. The entity value mapped to a data source query
- Returns
The query_field of this EntitiesMapping.
- Return type
str