DetectAnomalyJob¶

class oci.ai_anomaly_detection.models.DetectAnomalyJob(**kwargs)¶

Bases: object

Anomaly Job contains information for asynchronous detection of anomalies.

Attributes

`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a DetectAnomalyJob.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a DetectAnomalyJob.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DetectAnomalyJob.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a DetectAnomalyJob.
`LIFECYCLE_STATE_PARTIALLY_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a DetectAnomalyJob.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a DetectAnomalyJob.
`are_all_estimates_required`	Gets the are_all_estimates_required of this DetectAnomalyJob.
`compartment_id`	[Required] Gets the compartment_id of this DetectAnomalyJob.
`defined_tags`	Gets the defined_tags of this DetectAnomalyJob.
`description`	Gets the description of this DetectAnomalyJob.
`display_name`	Gets the display_name of this DetectAnomalyJob.
`freeform_tags`	Gets the freeform_tags of this DetectAnomalyJob.
`id`	[Required] Gets the id of this DetectAnomalyJob.
`input_details`	[Required] Gets the input_details of this DetectAnomalyJob.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DetectAnomalyJob.
`lifecycle_state_details`	Gets the lifecycle_state_details of this DetectAnomalyJob.
`model_id`	[Required] Gets the model_id of this DetectAnomalyJob.
`output_details`	[Required] Gets the output_details of this DetectAnomalyJob.
`project_id`	Gets the project_id of this DetectAnomalyJob.
`sensitivity`	Gets the sensitivity of this DetectAnomalyJob.
`system_tags`	Gets the system_tags of this DetectAnomalyJob.
`time_accepted`	[Required] Gets the time_accepted of this DetectAnomalyJob.
`time_finished`	Gets the time_finished of this DetectAnomalyJob.
`time_started`	Gets the time_started of this DetectAnomalyJob.

Methods

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

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a DetectAnomalyJob. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a DetectAnomalyJob. This constant has a value of “CANCELED”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DetectAnomalyJob. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a DetectAnomalyJob. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_PARTIALLY_SUCCEEDED = 'PARTIALLY_SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a DetectAnomalyJob. This constant has a value of “PARTIALLY_SUCCEEDED”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a DetectAnomalyJob. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new DetectAnomalyJob 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 DetectAnomalyJob.
compartment_id (str) – The value to assign to the compartment_id property of this DetectAnomalyJob.
display_name (str) – The value to assign to the display_name property of this DetectAnomalyJob.
description (str) – The value to assign to the description property of this DetectAnomalyJob.
model_id (str) – The value to assign to the model_id property of this DetectAnomalyJob.
project_id (str) – The value to assign to the project_id property of this DetectAnomalyJob.
sensitivity (float) – The value to assign to the sensitivity property of this DetectAnomalyJob.
are_all_estimates_required (bool) – The value to assign to the are_all_estimates_required property of this DetectAnomalyJob.
input_details (oci.ai_anomaly_detection.models.InputJobDetails) – The value to assign to the input_details property of this DetectAnomalyJob.
output_details (oci.ai_anomaly_detection.models.OutputJobDetails) – The value to assign to the output_details property of this DetectAnomalyJob.
time_accepted (datetime) – The value to assign to the time_accepted property of this DetectAnomalyJob.
time_started (datetime) – The value to assign to the time_started property of this DetectAnomalyJob.
time_finished (datetime) – The value to assign to the time_finished property of this DetectAnomalyJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DetectAnomalyJob. Allowed values for this property are: “SUCCEEDED”, “PARTIALLY_SUCCEEDED”, “FAILED”, “ACCEPTED”, “CANCELED”, “IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this DetectAnomalyJob.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DetectAnomalyJob.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DetectAnomalyJob.
system_tags (dict(str, object)) – The value to assign to the system_tags property of this DetectAnomalyJob.

are_all_estimates_required¶

Gets the are_all_estimates_required of this DetectAnomalyJob. Flag to enable the service to return estimates for all data points rather than just the anomalous data points

Returns:	The are_all_estimates_required of this DetectAnomalyJob.
Return type:	bool

compartment_id¶

[Required] Gets the compartment_id of this DetectAnomalyJob. The OCID of the compartment that starts the job.

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

defined_tags¶

Gets the defined_tags of this DetectAnomalyJob. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this DetectAnomalyJob.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this DetectAnomalyJob. Detect anomaly job description.

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

display_name¶

Gets the display_name of this DetectAnomalyJob. Detect anomaly job display name.

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

freeform_tags¶

Gets the freeform_tags of this DetectAnomalyJob. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this DetectAnomalyJob.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this DetectAnomalyJob. Id of the job.

Returns:	The id of this DetectAnomalyJob.
Return type:	str

input_details¶

[Required] Gets the input_details of this DetectAnomalyJob.

Returns:	The input_details of this DetectAnomalyJob.
Return type:	oci.ai_anomaly_detection.models.InputJobDetails

lifecycle_state¶

[Required] Gets the lifecycle_state of this DetectAnomalyJob. The current state of the batch document job.

Allowed values for this property are: “SUCCEEDED”, “PARTIALLY_SUCCEEDED”, “FAILED”, “ACCEPTED”, “CANCELED”, “IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DetectAnomalyJob.
Return type:	str

lifecycle_state_details¶

Gets the lifecycle_state_details of this DetectAnomalyJob. The current state details of the batch document job.

Returns:	The lifecycle_state_details of this DetectAnomalyJob.
Return type:	str

model_id¶

[Required] Gets the model_id of this DetectAnomalyJob. The OCID of the trained model.

Returns:	The model_id of this DetectAnomalyJob.
Return type:	str

output_details¶

[Required] Gets the output_details of this DetectAnomalyJob.

Returns:	The output_details of this DetectAnomalyJob.
Return type:	oci.ai_anomaly_detection.models.OutputJobDetails

project_id¶

Gets the project_id of this DetectAnomalyJob. The OCID of the project.

Returns:	The project_id of this DetectAnomalyJob.
Return type:	str

sensitivity¶

Gets the sensitivity of this DetectAnomalyJob. The value that customer can adjust to control the sensitivity of anomaly detection

Returns:	The sensitivity of this DetectAnomalyJob.
Return type:	float

system_tags¶

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

time_accepted¶

[Required] Gets the time_accepted of this DetectAnomalyJob. Job accepted time

Returns:	The time_accepted of this DetectAnomalyJob.
Return type:	datetime

time_finished¶

Gets the time_finished of this DetectAnomalyJob. Job finished time

Returns:	The time_finished of this DetectAnomalyJob.
Return type:	datetime

time_started¶

Gets the time_started of this DetectAnomalyJob. Job started time

Returns:	The time_started of this DetectAnomalyJob.
Return type:	datetime