PathAnalyzerTest¶
- class oci.vn_monitoring.models.PathAnalyzerTest(**kwargs)¶
Bases:
objectDefines the details saved in a PathAnalyzerTest resource. These configuration details are used to run a Network Path Analyzer analysis.
Attributes:
A constant which can be used with the lifecycle_state property of a PathAnalyzerTest.
A constant which can be used with the lifecycle_state property of a PathAnalyzerTest.
[Required] Gets the compartment_id of this PathAnalyzerTest.
Gets the defined_tags of this PathAnalyzerTest.
[Required] Gets the destination_endpoint of this PathAnalyzerTest.
[Required] Gets the display_name of this PathAnalyzerTest.
Gets the freeform_tags of this PathAnalyzerTest.
[Required] Gets the id of this PathAnalyzerTest.
[Required] Gets the lifecycle_state of this PathAnalyzerTest.
[Required] Gets the protocol of this PathAnalyzerTest.
Gets the protocol_parameters of this PathAnalyzerTest.
[Required] Gets the query_options of this PathAnalyzerTest.
[Required] Gets the source_endpoint of this PathAnalyzerTest.
Gets the system_tags of this PathAnalyzerTest.
[Required] Gets the time_created of this PathAnalyzerTest.
[Required] Gets the time_updated of this PathAnalyzerTest.
Methods:
__init__(**kwargs)Initializes a new PathAnalyzerTest object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a PathAnalyzerTest. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a PathAnalyzerTest. This constant has a value of “DELETED”
- __init__(**kwargs)¶
Initializes a new PathAnalyzerTest 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 PathAnalyzerTest.
display_name (str) – The value to assign to the display_name property of this PathAnalyzerTest.
compartment_id (str) – The value to assign to the compartment_id property of this PathAnalyzerTest.
protocol (int) – The value to assign to the protocol property of this PathAnalyzerTest.
source_endpoint (oci.vn_monitoring.models.Endpoint) – The value to assign to the source_endpoint property of this PathAnalyzerTest.
destination_endpoint (oci.vn_monitoring.models.Endpoint) – The value to assign to the destination_endpoint property of this PathAnalyzerTest.
protocol_parameters (oci.vn_monitoring.models.ProtocolParameters) – The value to assign to the protocol_parameters property of this PathAnalyzerTest.
query_options (oci.vn_monitoring.models.QueryOptions) – The value to assign to the query_options property of this PathAnalyzerTest.
time_created (datetime) – The value to assign to the time_created property of this PathAnalyzerTest.
time_updated (datetime) – The value to assign to the time_updated property of this PathAnalyzerTest.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PathAnalyzerTest. Allowed values for this property are: “ACTIVE”, “DELETED”, ‘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 PathAnalyzerTest.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PathAnalyzerTest.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PathAnalyzerTest.
- property compartment_id¶
[Required] Gets the compartment_id of this PathAnalyzerTest. The OCID of the PathAnalyzerTest resource’s compartment.
- Returns
The compartment_id of this PathAnalyzerTest.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this PathAnalyzerTest. 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 PathAnalyzerTest.
- Return type
dict(str, dict(str, object))
- property destination_endpoint¶
[Required] Gets the destination_endpoint of this PathAnalyzerTest.
- Returns
The destination_endpoint of this PathAnalyzerTest.
- Return type
- property display_name¶
[Required] Gets the display_name of this PathAnalyzerTest. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this PathAnalyzerTest.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this PathAnalyzerTest. 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 PathAnalyzerTest.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this PathAnalyzerTest. A unique identifier established when the resource is created. The identifier can’t be changed later.
- Returns
The id of this PathAnalyzerTest.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this PathAnalyzerTest. The current state of the PathAnalyzerTest resource.
Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this PathAnalyzerTest.
- Return type
str
- property protocol¶
[Required] Gets the protocol of this PathAnalyzerTest. The IP protocol to use for the PathAnalyzerTest resource.
- Returns
The protocol of this PathAnalyzerTest.
- Return type
int
- property protocol_parameters¶
Gets the protocol_parameters of this PathAnalyzerTest.
- Returns
The protocol_parameters of this PathAnalyzerTest.
- Return type
- property query_options¶
[Required] Gets the query_options of this PathAnalyzerTest.
- Returns
The query_options of this PathAnalyzerTest.
- Return type
- property source_endpoint¶
[Required] Gets the source_endpoint of this PathAnalyzerTest.
- Returns
The source_endpoint of this PathAnalyzerTest.
- Return type
- property system_tags¶
Gets the system_tags of this PathAnalyzerTest. 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 PathAnalyzerTest.
- Return type
dict(str, dict(str, object))