DiscoveryJob¶
- class oci.stack_monitoring.models.DiscoveryJob(**kwargs)¶
Bases:
objectThe DiscoveryJob details.
Attributes:
A constant which can be used with the discovery_type property of a DiscoveryJob.
A constant which can be used with the discovery_type property of a DiscoveryJob.
A constant which can be used with the discovery_type property of a DiscoveryJob.
A constant which can be used with the lifecycle_state property of a DiscoveryJob.
A constant which can be used with the lifecycle_state property of a DiscoveryJob.
A constant which can be used with the lifecycle_state property of a DiscoveryJob.
A constant which can be used with the lifecycle_state property of a DiscoveryJob.
A constant which can be used with the lifecycle_state property of a DiscoveryJob.
A constant which can be used with the lifecycle_state property of a DiscoveryJob.
A constant which can be used with the status property of a DiscoveryJob.
A constant which can be used with the status property of a DiscoveryJob.
A constant which can be used with the status property of a DiscoveryJob.
A constant which can be used with the status property of a DiscoveryJob.
A constant which can be used with the status property of a DiscoveryJob.
A constant which can be used with the status property of a DiscoveryJob.
Gets the compartment_id of this DiscoveryJob.
Gets the defined_tags of this DiscoveryJob.
Gets the discovery_client of this DiscoveryJob.
Gets the discovery_details of this DiscoveryJob.
Gets the discovery_type of this DiscoveryJob.
Gets the freeform_tags of this DiscoveryJob.
[Required] Gets the id of this DiscoveryJob.
Gets the lifecycle_state of this DiscoveryJob.
Gets the status of this DiscoveryJob.
Gets the status_message of this DiscoveryJob.
Gets the system_tags of this DiscoveryJob.
Gets the tenant_id of this DiscoveryJob.
Gets the time_updated of this DiscoveryJob.
Gets the user_id of this DiscoveryJob.
Methods:
__init__(**kwargs)Initializes a new DiscoveryJob object with values from keyword arguments.
- DISCOVERY_TYPE_ADD = 'ADD'¶
A constant which can be used with the discovery_type property of a DiscoveryJob. This constant has a value of “ADD”
- DISCOVERY_TYPE_ADD_WITH_RETRY = 'ADD_WITH_RETRY'¶
A constant which can be used with the discovery_type property of a DiscoveryJob. This constant has a value of “ADD_WITH_RETRY”
- DISCOVERY_TYPE_REFRESH = 'REFRESH'¶
A constant which can be used with the discovery_type property of a DiscoveryJob. This constant has a value of “REFRESH”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “UPDATING”
- STATUS_CREATED = 'CREATED'¶
A constant which can be used with the status property of a DiscoveryJob. This constant has a value of “CREATED”
- STATUS_DELETED = 'DELETED'¶
A constant which can be used with the status property of a DiscoveryJob. This constant has a value of “DELETED”
- STATUS_FAILURE = 'FAILURE'¶
A constant which can be used with the status property of a DiscoveryJob. This constant has a value of “FAILURE”
- STATUS_INACTIVE = 'INACTIVE'¶
A constant which can be used with the status property of a DiscoveryJob. This constant has a value of “INACTIVE”
- STATUS_INPROGRESS = 'INPROGRESS'¶
A constant which can be used with the status property of a DiscoveryJob. This constant has a value of “INPROGRESS”
- STATUS_SUCCESS = 'SUCCESS'¶
A constant which can be used with the status property of a DiscoveryJob. This constant has a value of “SUCCESS”
- __init__(**kwargs)¶
Initializes a new DiscoveryJob 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 DiscoveryJob.
compartment_id (str) – The value to assign to the compartment_id property of this DiscoveryJob.
discovery_type (str) – The value to assign to the discovery_type property of this DiscoveryJob. Allowed values for this property are: “ADD”, “ADD_WITH_RETRY”, “REFRESH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
status (str) – The value to assign to the status property of this DiscoveryJob. Allowed values for this property are: “SUCCESS”, “FAILURE”, “INPROGRESS”, “INACTIVE”, “CREATED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
status_message (str) – The value to assign to the status_message property of this DiscoveryJob.
tenant_id (str) – The value to assign to the tenant_id property of this DiscoveryJob.
user_id (str) – The value to assign to the user_id property of this DiscoveryJob.
discovery_client (str) – The value to assign to the discovery_client property of this DiscoveryJob.
discovery_details (oci.stack_monitoring.models.DiscoveryDetails) – The value to assign to the discovery_details property of this DiscoveryJob.
time_updated (datetime) – The value to assign to the time_updated property of this DiscoveryJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DiscoveryJob. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘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 DiscoveryJob.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DiscoveryJob.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DiscoveryJob.
- property compartment_id¶
Gets the compartment_id of this DiscoveryJob. The OCID of the Compartment
- Returns
The compartment_id of this DiscoveryJob.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this DiscoveryJob. 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 DiscoveryJob.
- Return type
dict(str, dict(str, object))
- property discovery_client¶
Gets the discovery_client of this DiscoveryJob. Client who submits discovery job.
- Returns
The discovery_client of this DiscoveryJob.
- Return type
str
- property discovery_details¶
Gets the discovery_details of this DiscoveryJob.
- Returns
The discovery_details of this DiscoveryJob.
- Return type
- property discovery_type¶
Gets the discovery_type of this DiscoveryJob. Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.
Allowed values for this property are: “ADD”, “ADD_WITH_RETRY”, “REFRESH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The discovery_type of this DiscoveryJob.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DiscoveryJob. 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 DiscoveryJob.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DiscoveryJob. The OCID of Discovery job
- Returns
The id of this DiscoveryJob.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this DiscoveryJob. The current state of the DiscoveryJob Resource.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 DiscoveryJob.
- Return type
str
- property status¶
Gets the status of this DiscoveryJob. Specifies the status of the discovery job
Allowed values for this property are: “SUCCESS”, “FAILURE”, “INPROGRESS”, “INACTIVE”, “CREATED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this DiscoveryJob.
- Return type
str
- property status_message¶
Gets the status_message of this DiscoveryJob. The short summary of the status of the discovery job
- Returns
The status_message of this DiscoveryJob.
- Return type
str
- property system_tags¶
Gets the system_tags of this DiscoveryJob. 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 DiscoveryJob.
- Return type
dict(str, dict(str, object))
- property tenant_id¶
Gets the tenant_id of this DiscoveryJob. The OCID of Tenant
- Returns
The tenant_id of this DiscoveryJob.
- Return type
str
- property time_updated¶
Gets the time_updated of this DiscoveryJob. The time the discovery Job was updated.
- Returns
The time_updated of this DiscoveryJob.
- Return type
datetime
- property user_id¶
Gets the user_id of this DiscoveryJob. The OCID of user in which the job is submitted
- Returns
The user_id of this DiscoveryJob.
- Return type
str