UserAssessmentSummary¶
- class oci.data_safe.models.UserAssessmentSummary(**kwargs)¶
Bases:
objectThe summary of the user assessment.
Attributes:
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary.
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary.
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary.
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary.
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary.
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary.
A constant which can be used with the target_type property of a UserAssessmentSummary.
A constant which can be used with the target_type property of a UserAssessmentSummary.
A constant which can be used with the triggered_by property of a UserAssessmentSummary.
A constant which can be used with the triggered_by property of a UserAssessmentSummary.
A constant which can be used with the type property of a UserAssessmentSummary.
A constant which can be used with the type property of a UserAssessmentSummary.
A constant which can be used with the type property of a UserAssessmentSummary.
A constant which can be used with the type property of a UserAssessmentSummary.
[Required] Gets the compartment_id of this UserAssessmentSummary.
Gets the defined_tags of this UserAssessmentSummary.
Gets the description of this UserAssessmentSummary.
[Required] Gets the display_name of this UserAssessmentSummary.
Gets the freeform_tags of this UserAssessmentSummary.
[Required] Gets the id of this UserAssessmentSummary.
Gets the ignored_assessment_ids of this UserAssessmentSummary.
Gets the ignored_targets of this UserAssessmentSummary.
Gets the is_assessment_scheduled of this UserAssessmentSummary.
Gets the is_baseline of this UserAssessmentSummary.
Gets the is_deviated_from_baseline of this UserAssessmentSummary.
Gets the last_compared_baseline_id of this UserAssessmentSummary.
Gets the lifecycle_details of this UserAssessmentSummary.
[Required] Gets the lifecycle_state of this UserAssessmentSummary.
Gets the schedule of this UserAssessmentSummary.
Gets the schedule_assessment_id of this UserAssessmentSummary.
Gets the statistics of this UserAssessmentSummary. Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}.
Gets the target_database_group_id of this UserAssessmentSummary.
Gets the target_ids of this UserAssessmentSummary.
Gets the target_type of this UserAssessmentSummary.
[Required] Gets the time_created of this UserAssessmentSummary.
Gets the time_last_assessed of this UserAssessmentSummary.
[Required] Gets the time_updated of this UserAssessmentSummary.
Gets the triggered_by of this UserAssessmentSummary.
[Required] Gets the type of this UserAssessmentSummary.
Methods:
__init__(**kwargs)Initializes a new UserAssessmentSummary object with values from keyword arguments.
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary. This constant has a value of “SUCCEEDED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a UserAssessmentSummary. This constant has a value of “UPDATING”
- TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'¶
A constant which can be used with the target_type property of a UserAssessmentSummary. This constant has a value of “TARGET_DATABASE”
- TARGET_TYPE_TARGET_DATABASE_GROUP = 'TARGET_DATABASE_GROUP'¶
A constant which can be used with the target_type property of a UserAssessmentSummary. This constant has a value of “TARGET_DATABASE_GROUP”
- TRIGGERED_BY_SYSTEM = 'SYSTEM'¶
A constant which can be used with the triggered_by property of a UserAssessmentSummary. This constant has a value of “SYSTEM”
- TRIGGERED_BY_USER = 'USER'¶
A constant which can be used with the triggered_by property of a UserAssessmentSummary. This constant has a value of “USER”
- TYPE_COMPARTMENT = 'COMPARTMENT'¶
A constant which can be used with the type property of a UserAssessmentSummary. This constant has a value of “COMPARTMENT”
- TYPE_LATEST = 'LATEST'¶
A constant which can be used with the type property of a UserAssessmentSummary. This constant has a value of “LATEST”
- TYPE_SAVED = 'SAVED'¶
A constant which can be used with the type property of a UserAssessmentSummary. This constant has a value of “SAVED”
- TYPE_SAVE_SCHEDULE = 'SAVE_SCHEDULE'¶
A constant which can be used with the type property of a UserAssessmentSummary. This constant has a value of “SAVE_SCHEDULE”
- __init__(**kwargs)¶
Initializes a new UserAssessmentSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this UserAssessmentSummary.
description (str) – The value to assign to the description property of this UserAssessmentSummary.
display_name (str) – The value to assign to the display_name property of this UserAssessmentSummary.
id (str) – The value to assign to the id property of this UserAssessmentSummary.
ignored_targets (list[object]) – The value to assign to the ignored_targets property of this UserAssessmentSummary.
ignored_assessment_ids (list[object]) – The value to assign to the ignored_assessment_ids property of this UserAssessmentSummary.
is_baseline (bool) – The value to assign to the is_baseline property of this UserAssessmentSummary.
is_deviated_from_baseline (bool) – The value to assign to the is_deviated_from_baseline property of this UserAssessmentSummary.
last_compared_baseline_id (str) – The value to assign to the last_compared_baseline_id property of this UserAssessmentSummary.
target_database_group_id (str) – The value to assign to the target_database_group_id property of this UserAssessmentSummary.
target_type (str) – The value to assign to the target_type property of this UserAssessmentSummary. Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this UserAssessmentSummary. Allowed values for this property are: “CREATING”, “SUCCEEDED”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this UserAssessmentSummary.
schedule_assessment_id (str) – The value to assign to the schedule_assessment_id property of this UserAssessmentSummary.
is_assessment_scheduled (bool) – The value to assign to the is_assessment_scheduled property of this UserAssessmentSummary.
schedule (str) – The value to assign to the schedule property of this UserAssessmentSummary.
statistics (dict(str, dict(str, object))) – The value to assign to the statistics property of this UserAssessmentSummary.
target_ids (list[str]) – The value to assign to the target_ids property of this UserAssessmentSummary.
time_created (datetime) – The value to assign to the time_created property of this UserAssessmentSummary.
time_updated (datetime) – The value to assign to the time_updated property of this UserAssessmentSummary.
time_last_assessed (datetime) – The value to assign to the time_last_assessed property of this UserAssessmentSummary.
triggered_by (str) – The value to assign to the triggered_by property of this UserAssessmentSummary. Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
type (str) – The value to assign to the type property of this UserAssessmentSummary. Allowed values for this property are: “LATEST”, “SAVED”, “SAVE_SCHEDULE”, “COMPARTMENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UserAssessmentSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UserAssessmentSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this UserAssessmentSummary. The OCID of the compartment that contains the user assessment.
- Returns
The compartment_id of this UserAssessmentSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this UserAssessmentSummary. 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 UserAssessmentSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this UserAssessmentSummary. The description of the user assessment.
- Returns
The description of this UserAssessmentSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this UserAssessmentSummary. The display name of the user assessment.
- Returns
The display_name of this UserAssessmentSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this UserAssessmentSummary. 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 UserAssessmentSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this UserAssessmentSummary. The OCID of the user assessment.
- Returns
The id of this UserAssessmentSummary.
- Return type
str
- property ignored_assessment_ids¶
Gets the ignored_assessment_ids of this UserAssessmentSummary. List containing maps as values. Example: {“Operations”: [ {“CostCenter”: “42”} ] }
- Returns
The ignored_assessment_ids of this UserAssessmentSummary.
- Return type
list[object]
- property ignored_targets¶
Gets the ignored_targets of this UserAssessmentSummary. List containing maps as values. Example: {“Operations”: [ {“CostCenter”: “42”} ] }
- Returns
The ignored_targets of this UserAssessmentSummary.
- Return type
list[object]
- property is_assessment_scheduled¶
Gets the is_assessment_scheduled of this UserAssessmentSummary. Indicates whether the assessment is scheduled to run.
- Returns
The is_assessment_scheduled of this UserAssessmentSummary.
- Return type
bool
- property is_baseline¶
Gets the is_baseline of this UserAssessmentSummary. Indicates if the assessment is a baseline assessment. This applies to saved user assessments only.
- Returns
The is_baseline of this UserAssessmentSummary.
- Return type
bool
- property is_deviated_from_baseline¶
Gets the is_deviated_from_baseline of this UserAssessmentSummary. Indicates if the assessment has deviated from the baseline.
- Returns
The is_deviated_from_baseline of this UserAssessmentSummary.
- Return type
bool
- property last_compared_baseline_id¶
Gets the last_compared_baseline_id of this UserAssessmentSummary. The OCID of the last user assessment baseline against which the latest assessment was compared.
- Returns
The last_compared_baseline_id of this UserAssessmentSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this UserAssessmentSummary. Details about the current state of the user assessment.
- Returns
The lifecycle_details of this UserAssessmentSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this UserAssessmentSummary. The current state of the user assessment.
Allowed values for this property are: “CREATING”, “SUCCEEDED”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this UserAssessmentSummary.
- Return type
str
- property schedule¶
Gets the schedule of this UserAssessmentSummary. Schedule to save the assessment periodically in the specified format: <version-string>;<version-specific-schedule>
Allowed version strings - “v1” v1’s version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month> Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = <ss> (So, the allowed range for <ss> is [0, 59]) 2. minutes = <mm> (So, the allowed range for <mm> is [0, 59]) 3. hours = <hh> (So, the allowed range for <hh> is [0, 23]) <day-of-week> can be either ‘*’ (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is ‘*’. When not, day of week must equal the given value <day-of-month> can be either ‘*’ (without quotes or a number between 1 and 28) 5. No constraint introduced when it is ‘*’. When not, day of month must equal the given value
- Returns
The schedule of this UserAssessmentSummary.
- Return type
str
- property schedule_assessment_id¶
Gets the schedule_assessment_id of this UserAssessmentSummary. The OCID of the user assessment that created this scheduled save assessment.
- Returns
The schedule_assessment_id of this UserAssessmentSummary.
- Return type
str
- property statistics¶
Gets the statistics of this UserAssessmentSummary. Map that contains maps of values.
Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The statistics of this UserAssessmentSummary.
- Return type
dict(str, dict(str, object))
- property target_database_group_id¶
Gets the target_database_group_id of this UserAssessmentSummary. The OCID of target database group.
- Returns
The target_database_group_id of this UserAssessmentSummary.
- Return type
str
- property target_ids¶
Gets the target_ids of this UserAssessmentSummary. Array of database target OCIDs.
- Returns
The target_ids of this UserAssessmentSummary.
- Return type
list[str]
- property target_type¶
Gets the target_type of this UserAssessmentSummary. Indicates whether the user assessment is for a target database or a target database group.
Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The target_type of this UserAssessmentSummary.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this UserAssessmentSummary. The date and time the user assessment was created, in the format defined by RFC3339.
- Returns
The time_created of this UserAssessmentSummary.
- Return type
datetime
- property time_last_assessed¶
Gets the time_last_assessed of this UserAssessmentSummary. The date and time the user assessment was last executed, in the format defined by RFC3339.
- Returns
The time_last_assessed of this UserAssessmentSummary.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this UserAssessmentSummary. The last date and time the user assessment was updated, in the format defined by RFC3339.
- Returns
The time_updated of this UserAssessmentSummary.
- Return type
datetime
- property triggered_by¶
Gets the triggered_by of this UserAssessmentSummary. Indicates whether the user assessment was created by the system or the user.
Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The triggered_by of this UserAssessmentSummary.
- Return type
str
- property type¶
[Required] Gets the type of this UserAssessmentSummary. The type of the user assessment. The possible types are:
LATEST: The latest assessment that was executed for a target. It can either be system generated as part of the scheduled assessments or user driven by refreshing the latest assessment. SAVED: A saved user assessment. All user assessments are saved in the user assessment history. SAVE_SCHEDULE: The schedule to periodically save the LATEST assessment of a target database. COMPARTMENT: An automatic managed assessment type that stores all details of the targets in one compartment. This will keep an up-to-date status of all potential risks identified in the compartment.
It is automatically updated once the latest assessment or refresh action is executed, as well as when a target is deleted or moved to a different compartment.
Allowed values for this property are: “LATEST”, “SAVED”, “SAVE_SCHEDULE”, “COMPARTMENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this UserAssessmentSummary.
- Return type
str