LogSummary¶
- class oci.logging.models.LogSummary(**kwargs)¶
Bases:
objectLog object configuration summary.
Attributes:
A constant which can be used with the lifecycle_state property of a LogSummary.
A constant which can be used with the lifecycle_state property of a LogSummary.
A constant which can be used with the lifecycle_state property of a LogSummary.
A constant which can be used with the lifecycle_state property of a LogSummary.
A constant which can be used with the lifecycle_state property of a LogSummary.
A constant which can be used with the lifecycle_state property of a LogSummary.
A constant which can be used with the log_type property of a LogSummary.
A constant which can be used with the log_type property of a LogSummary.
Gets the compartment_id of this LogSummary.
Gets the configuration of this LogSummary.
Gets the defined_tags of this LogSummary.
[Required] Gets the display_name of this LogSummary.
Gets the freeform_tags of this LogSummary.
[Required] Gets the id of this LogSummary.
Gets the is_enabled of this LogSummary.
[Required] Gets the lifecycle_state of this LogSummary.
[Required] Gets the log_group_id of this LogSummary.
[Required] Gets the log_type of this LogSummary.
Gets the retention_duration of this LogSummary.
Gets the system_tags of this LogSummary.
Gets the time_created of this LogSummary.
Gets the time_last_modified of this LogSummary.
Methods:
__init__(**kwargs)Initializes a new LogSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a LogSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a LogSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a LogSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a LogSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a LogSummary. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a LogSummary. This constant has a value of “UPDATING”
- LOG_TYPE_CUSTOM = 'CUSTOM'¶
A constant which can be used with the log_type property of a LogSummary. This constant has a value of “CUSTOM”
- LOG_TYPE_SERVICE = 'SERVICE'¶
A constant which can be used with the log_type property of a LogSummary. This constant has a value of “SERVICE”
- __init__(**kwargs)¶
Initializes a new LogSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this LogSummary.
log_group_id (str) – The value to assign to the log_group_id property of this LogSummary.
display_name (str) – The value to assign to the display_name property of this LogSummary.
is_enabled (bool) – The value to assign to the is_enabled property of this LogSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LogSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “INACTIVE”, “DELETING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
log_type (str) – The value to assign to the log_type property of this LogSummary. Allowed values for this property are: “CUSTOM”, “SERVICE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
configuration (oci.logging.models.Configuration) – The value to assign to the configuration property of this LogSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LogSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LogSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this LogSummary.
time_created (datetime) – The value to assign to the time_created property of this LogSummary.
time_last_modified (datetime) – The value to assign to the time_last_modified property of this LogSummary.
retention_duration (int) – The value to assign to the retention_duration property of this LogSummary.
compartment_id (str) – The value to assign to the compartment_id property of this LogSummary.
- property compartment_id¶
Gets the compartment_id of this LogSummary. The OCID of the compartment that the resource belongs to.
- Returns
The compartment_id of this LogSummary.
- Return type
str
- property configuration¶
Gets the configuration of this LogSummary.
- Returns
The configuration of this LogSummary.
- Return type
- property defined_tags¶
Gets the defined_tags of this LogSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this LogSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this LogSummary. The user-friendly display name. This must be unique within the enclosing resource, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this LogSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this LogSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}
- Returns
The freeform_tags of this LogSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this LogSummary. The OCID of the resource.
- Returns
The id of this LogSummary.
- Return type
str
- property is_enabled¶
Gets the is_enabled of this LogSummary. Whether or not this resource is currently enabled.
- Returns
The is_enabled of this LogSummary.
- Return type
bool
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this LogSummary. The pipeline state.
Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “INACTIVE”, “DELETING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this LogSummary.
- Return type
str
- property log_group_id¶
[Required] Gets the log_group_id of this LogSummary. Log group OCID.
- Returns
The log_group_id of this LogSummary.
- Return type
str
- property log_type¶
[Required] Gets the log_type of this LogSummary. The logType that the log object is for, whether custom or service.
Allowed values for this property are: “CUSTOM”, “SERVICE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The log_type of this LogSummary.
- Return type
str
- property retention_duration¶
Gets the retention_duration of this LogSummary. Log retention duration in 30-day increments (30, 60, 90 and so on until 180).
- Returns
The retention_duration of this LogSummary.
- Return type
int
- property system_tags¶
Gets the system_tags of this LogSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this LogSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this LogSummary. Time the resource was created.
- Returns
The time_created of this LogSummary.
- Return type
datetime
- property time_last_modified¶
Gets the time_last_modified of this LogSummary. Time the resource was last modified.
- Returns
The time_last_modified of this LogSummary.
- Return type
datetime