CreateUserAssessmentDetails¶

class oci.data_safe.models.CreateUserAssessmentDetails(**kwargs)¶

Bases: object

The details required to save a user assessment.

Attributes

`TARGET_TYPE_TARGET_DATABASE`	A constant which can be used with the target_type property of a CreateUserAssessmentDetails.
`TARGET_TYPE_TARGET_DATABASE_GROUP`	A constant which can be used with the target_type property of a CreateUserAssessmentDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateUserAssessmentDetails.
`defined_tags`	Gets the defined_tags of this CreateUserAssessmentDetails.
`description`	Gets the description of this CreateUserAssessmentDetails.
`display_name`	Gets the display_name of this CreateUserAssessmentDetails.
`freeform_tags`	Gets the freeform_tags of this CreateUserAssessmentDetails.
`is_assessment_scheduled`	Gets the is_assessment_scheduled of this CreateUserAssessmentDetails.
`schedule`	Gets the schedule of this CreateUserAssessmentDetails.
`target_id`	[Required] Gets the target_id of this CreateUserAssessmentDetails.
`target_type`	Gets the target_type of this CreateUserAssessmentDetails.

Methods

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

TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'¶: A constant which can be used with the target_type property of a CreateUserAssessmentDetails. 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 CreateUserAssessmentDetails. This constant has a value of “TARGET_DATABASE_GROUP”

__init__(**kwargs)¶

Initializes a new CreateUserAssessmentDetails 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 CreateUserAssessmentDetails.
description (str) – The value to assign to the description property of this CreateUserAssessmentDetails.
display_name (str) – The value to assign to the display_name property of this CreateUserAssessmentDetails.
is_assessment_scheduled (bool) – The value to assign to the is_assessment_scheduled property of this CreateUserAssessmentDetails.
schedule (str) – The value to assign to the schedule property of this CreateUserAssessmentDetails.
target_id (str) – The value to assign to the target_id property of this CreateUserAssessmentDetails.
target_type (str) – The value to assign to the target_type property of this CreateUserAssessmentDetails. Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateUserAssessmentDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateUserAssessmentDetails.

compartment_id¶

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

Returns:	The compartment_id of this CreateUserAssessmentDetails.
Return type:	str

defined_tags¶

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

description¶

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

Returns:	The description of this CreateUserAssessmentDetails.
Return type:	str

display_name¶

Gets the display_name of this CreateUserAssessmentDetails. The display name of the user assessment.

Returns:	The display_name of this CreateUserAssessmentDetails.
Return type:	str

freeform_tags¶

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

is_assessment_scheduled¶

Gets the is_assessment_scheduled of this CreateUserAssessmentDetails. Indicates whether the assessment is scheduled to run.

Returns:	The is_assessment_scheduled of this CreateUserAssessmentDetails.
Return type:	bool

schedule¶

Gets the schedule of this CreateUserAssessmentDetails. To schedule the assessment for saving periodically, specify the schedule in this attribute. Create or schedule one assessment per compartment. If not defined, the assessment runs immediately.

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 CreateUserAssessmentDetails.
Return type:	str

target_id¶

[Required] Gets the target_id of this CreateUserAssessmentDetails. The OCID of the target database or target database group on which user assessment is to be run.

Returns:	The target_id of this CreateUserAssessmentDetails.
Return type:	str

target_type¶

Gets the target_type of this CreateUserAssessmentDetails. The type of user assessment resource whether it is individual or group resource. For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value.

Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”

Returns:	The target_type of this CreateUserAssessmentDetails.
Return type:	str