UserAssessment

class oci.data_safe.models.UserAssessment(**kwargs)

Bases: object

The details of the user assessment, which includes statistics related to target database users.

Attributes

LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a UserAssessment.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a UserAssessment.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a UserAssessment.
LIFECYCLE_STATE_SUCCEEDED A constant which can be used with the lifecycle_state property of a UserAssessment.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a UserAssessment.
TRIGGERED_BY_SYSTEM A constant which can be used with the triggered_by property of a UserAssessment.
TRIGGERED_BY_USER A constant which can be used with the triggered_by property of a UserAssessment.
TYPE_COMPARTMENT A constant which can be used with the type property of a UserAssessment.
TYPE_LATEST A constant which can be used with the type property of a UserAssessment.
TYPE_SAVED A constant which can be used with the type property of a UserAssessment.
TYPE_SAVE_SCHEDULE A constant which can be used with the type property of a UserAssessment.
compartment_id [Required] Gets the compartment_id of this UserAssessment.
defined_tags Gets the defined_tags of this UserAssessment.
description Gets the description of this UserAssessment.
display_name [Required] Gets the display_name of this UserAssessment.
freeform_tags Gets the freeform_tags of this UserAssessment.
id [Required] Gets the id of this UserAssessment.
ignored_assessment_ids Gets the ignored_assessment_ids of this UserAssessment.
ignored_targets Gets the ignored_targets of this UserAssessment.
is_baseline Gets the is_baseline of this UserAssessment.
is_deviated_from_baseline Gets the is_deviated_from_baseline of this UserAssessment.
last_compared_baseline_id Gets the last_compared_baseline_id of this UserAssessment.
lifecycle_details Gets the lifecycle_details of this UserAssessment.
lifecycle_state [Required] Gets the lifecycle_state of this UserAssessment.
schedule Gets the schedule of this UserAssessment.
schedule_assessment_id Gets the schedule_assessment_id of this UserAssessment.
statistics Gets the statistics of this UserAssessment.
system_tags Gets the system_tags of this UserAssessment.
target_ids Gets the target_ids of this UserAssessment.
time_created [Required] Gets the time_created of this UserAssessment.
time_updated [Required] Gets the time_updated of this UserAssessment.
triggered_by Gets the triggered_by of this UserAssessment.
type [Required] Gets the type of this UserAssessment.

Methods

__init__(**kwargs) Initializes a new UserAssessment object with values from keyword arguments.
LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a UserAssessment. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a UserAssessment. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a UserAssessment. This constant has a value of “FAILED”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'

A constant which can be used with the lifecycle_state property of a UserAssessment. This constant has a value of “SUCCEEDED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a UserAssessment. This constant has a value of “UPDATING”

TRIGGERED_BY_SYSTEM = 'SYSTEM'

A constant which can be used with the triggered_by property of a UserAssessment. This constant has a value of “SYSTEM”

TRIGGERED_BY_USER = 'USER'

A constant which can be used with the triggered_by property of a UserAssessment. This constant has a value of “USER”

TYPE_COMPARTMENT = 'COMPARTMENT'

A constant which can be used with the type property of a UserAssessment. This constant has a value of “COMPARTMENT”

TYPE_LATEST = 'LATEST'

A constant which can be used with the type property of a UserAssessment. This constant has a value of “LATEST”

TYPE_SAVED = 'SAVED'

A constant which can be used with the type property of a UserAssessment. This constant has a value of “SAVED”

TYPE_SAVE_SCHEDULE = 'SAVE_SCHEDULE'

A constant which can be used with the type property of a UserAssessment. This constant has a value of “SAVE_SCHEDULE”

__init__(**kwargs)

Initializes a new UserAssessment 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 UserAssessment.
  • description (str) – The value to assign to the description property of this UserAssessment.
  • display_name (str) – The value to assign to the display_name property of this UserAssessment.
  • id (str) – The value to assign to the id property of this UserAssessment.
  • ignored_targets (list[object]) – The value to assign to the ignored_targets property of this UserAssessment.
  • ignored_assessment_ids (list[object]) – The value to assign to the ignored_assessment_ids property of this UserAssessment.
  • is_baseline (bool) – The value to assign to the is_baseline property of this UserAssessment.
  • is_deviated_from_baseline (bool) – The value to assign to the is_deviated_from_baseline property of this UserAssessment.
  • last_compared_baseline_id (str) – The value to assign to the last_compared_baseline_id property of this UserAssessment.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this UserAssessment. Allowed values for this property are: “CREATING”, “SUCCEEDED”, “UPDATING”, “DELETING”, “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 UserAssessment.
  • schedule_assessment_id (str) – The value to assign to the schedule_assessment_id property of this UserAssessment.
  • schedule (str) – The value to assign to the schedule property of this UserAssessment.
  • statistics (dict(str, dict(str, object))) – The value to assign to the statistics property of this UserAssessment.
  • target_ids (list[str]) – The value to assign to the target_ids property of this UserAssessment.
  • time_created (datetime) – The value to assign to the time_created property of this UserAssessment.
  • time_updated (datetime) – The value to assign to the time_updated property of this UserAssessment.
  • triggered_by (str) – The value to assign to the triggered_by property of this UserAssessment. 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 UserAssessment. 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 UserAssessment.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UserAssessment.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this UserAssessment.
compartment_id

[Required] Gets the compartment_id of this UserAssessment. The OCID of the compartment that contains the user assessment.

Returns:The compartment_id of this UserAssessment.
Return type:str
defined_tags

Gets the defined_tags of this UserAssessment. 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 UserAssessment.
Return type:dict(str, dict(str, object))
description

Gets the description of this UserAssessment. The description of the user assessment.

Returns:The description of this UserAssessment.
Return type:str
display_name

[Required] Gets the display_name of this UserAssessment. The display name of the user assessment.

Returns:The display_name of this UserAssessment.
Return type:str
freeform_tags

Gets the freeform_tags of this UserAssessment. 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 UserAssessment.
Return type:dict(str, str)
id

[Required] Gets the id of this UserAssessment. The OCID of the user assessment.

Returns:The id of this UserAssessment.
Return type:str
ignored_assessment_ids

Gets the ignored_assessment_ids of this UserAssessment. List containing maps as values. Example: {“Operations”: [ {“CostCenter”: “42”} ] }

Returns:The ignored_assessment_ids of this UserAssessment.
Return type:list[object]
ignored_targets

Gets the ignored_targets of this UserAssessment. List containing maps as values. Example: {“Operations”: [ {“CostCenter”: “42”} ] }

Returns:The ignored_targets of this UserAssessment.
Return type:list[object]
is_baseline

Gets the is_baseline of this UserAssessment. Indicates if the user assessment is set as a baseline. This is applicable only to saved user assessments.

Returns:The is_baseline of this UserAssessment.
Return type:bool
is_deviated_from_baseline

Gets the is_deviated_from_baseline of this UserAssessment. Indicates if the user assessment deviates from the baseline.

Returns:The is_deviated_from_baseline of this UserAssessment.
Return type:bool
last_compared_baseline_id

Gets the last_compared_baseline_id of this UserAssessment. The OCID of the last user assessment baseline against which the latest assessment was compared.

Returns:The last_compared_baseline_id of this UserAssessment.
Return type:str
lifecycle_details

Gets the lifecycle_details of this UserAssessment. Details about the current state of the user assessment.

Returns:The lifecycle_details of this UserAssessment.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this UserAssessment. The current state of the user assessment.

Allowed values for this property are: “CREATING”, “SUCCEEDED”, “UPDATING”, “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 UserAssessment.
Return type:str
schedule

Gets the schedule of this UserAssessment. Schedule of the assessment that runs periodically in this 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 UserAssessment.
Return type:str
schedule_assessment_id

Gets the schedule_assessment_id of this UserAssessment. The OCID of the user assessment that is responsible for creating this scheduled save assessment.

Returns:The schedule_assessment_id of this UserAssessment.
Return type:str
statistics

Gets the statistics of this UserAssessment. Map that contains maps of values.

Example: {“Operations”: {“CostCenter”: “42”}}
Returns:The statistics of this UserAssessment.
Return type:dict(str, dict(str, object))
system_tags

Gets the system_tags of this UserAssessment. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:The system_tags of this UserAssessment.
Return type:dict(str, dict(str, object))
target_ids

Gets the target_ids of this UserAssessment. Array of database target OCIDs.

Returns:The target_ids of this UserAssessment.
Return type:list[str]
time_created

[Required] Gets the time_created of this UserAssessment. The date and time the user assessment was created, in the format defined by RFC3339.

Returns:The time_created of this UserAssessment.
Return type:datetime
time_updated

[Required] Gets the time_updated of this UserAssessment. The date and time the user assessment was last updated, in the format defined by RFC3339.

Returns:The time_updated of this UserAssessment.
Return type:datetime
triggered_by

Gets the triggered_by of this UserAssessment. Indicates whether the user assessment was created by system or 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 UserAssessment.
Return type:str
type

[Required] Gets the type of this UserAssessment. Type of user assessment. Type can be:

LATEST: The most up-to-date assessment that is running automatically for a target. It is system generated. SAVED: A saved user assessment. LATEST assessments will always be saved to maintain the history of runs. A SAVED assessment is also generated by a ‘refresh’ action (triggered by the user). SAVE_SCHEDULE: A schedule to periodically save LATEST assessments. COMPARTMENT: An automatic managed assessment type that stores all details of targets in one compartment. This will keep an up-to-date status of all database risks in one compartment.

It is automatically updated once the latest assessment or refresh action is executed, as well as when a target is deleted or move 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 UserAssessment.
Return type:str