JmsPluginSummary¶
- class oci.jms.models.JmsPluginSummary(**kwargs)¶
Bases:
objectSummary of the JmsPlugin.
Attributes:
A constant which can be used with the agent_type property of a JmsPluginSummary.
A constant which can be used with the agent_type property of a JmsPluginSummary.
A constant which can be used with the agent_type property of a JmsPluginSummary.
A constant which can be used with the availability_status property of a JmsPluginSummary.
A constant which can be used with the availability_status property of a JmsPluginSummary.
A constant which can be used with the availability_status property of a JmsPluginSummary.
A constant which can be used with the lifecycle_state property of a JmsPluginSummary.
A constant which can be used with the lifecycle_state property of a JmsPluginSummary.
A constant which can be used with the lifecycle_state property of a JmsPluginSummary.
A constant which can be used with the lifecycle_state property of a JmsPluginSummary.
A constant which can be used with the os_family property of a JmsPluginSummary.
A constant which can be used with the os_family property of a JmsPluginSummary.
A constant which can be used with the os_family property of a JmsPluginSummary.
A constant which can be used with the os_family property of a JmsPluginSummary.
[Required] Gets the agent_id of this JmsPluginSummary.
[Required] Gets the agent_type of this JmsPluginSummary.
[Required] Gets the availability_status of this JmsPluginSummary.
Gets the compartment_id of this JmsPluginSummary.
Gets the defined_tags of this JmsPluginSummary.
Gets the fleet_id of this JmsPluginSummary.
Gets the freeform_tags of this JmsPluginSummary.
Gets the hostname of this JmsPluginSummary.
[Required] Gets the id of this JmsPluginSummary.
[Required] Gets the lifecycle_state of this JmsPluginSummary.
Gets the os_architecture of this JmsPluginSummary.
Gets the os_distribution of this JmsPluginSummary.
Gets the os_family of this JmsPluginSummary.
Gets the plugin_version of this JmsPluginSummary.
Gets the system_tags of this JmsPluginSummary.
Gets the time_last_seen of this JmsPluginSummary.
[Required] Gets the time_registered of this JmsPluginSummary.
Methods:
__init__(**kwargs)Initializes a new JmsPluginSummary object with values from keyword arguments.
- AGENT_TYPE_OCA = 'OCA'¶
A constant which can be used with the agent_type property of a JmsPluginSummary. This constant has a value of “OCA”
- AGENT_TYPE_OCMA = 'OCMA'¶
A constant which can be used with the agent_type property of a JmsPluginSummary. This constant has a value of “OCMA”
- AGENT_TYPE_OMA = 'OMA'¶
A constant which can be used with the agent_type property of a JmsPluginSummary. This constant has a value of “OMA”
- AVAILABILITY_STATUS_ACTIVE = 'ACTIVE'¶
A constant which can be used with the availability_status property of a JmsPluginSummary. This constant has a value of “ACTIVE”
- AVAILABILITY_STATUS_NOT_AVAILABLE = 'NOT_AVAILABLE'¶
A constant which can be used with the availability_status property of a JmsPluginSummary. This constant has a value of “NOT_AVAILABLE”
- AVAILABILITY_STATUS_SILENT = 'SILENT'¶
A constant which can be used with the availability_status property of a JmsPluginSummary. This constant has a value of “SILENT”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a JmsPluginSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a JmsPluginSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a JmsPluginSummary. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a JmsPluginSummary. This constant has a value of “NEEDS_ATTENTION”
- OS_FAMILY_LINUX = 'LINUX'¶
A constant which can be used with the os_family property of a JmsPluginSummary. This constant has a value of “LINUX”
- OS_FAMILY_MACOS = 'MACOS'¶
A constant which can be used with the os_family property of a JmsPluginSummary. This constant has a value of “MACOS”
- OS_FAMILY_UNKNOWN = 'UNKNOWN'¶
A constant which can be used with the os_family property of a JmsPluginSummary. This constant has a value of “UNKNOWN”
- OS_FAMILY_WINDOWS = 'WINDOWS'¶
A constant which can be used with the os_family property of a JmsPluginSummary. This constant has a value of “WINDOWS”
- __init__(**kwargs)¶
Initializes a new JmsPluginSummary 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 JmsPluginSummary.
agent_id (str) – The value to assign to the agent_id property of this JmsPluginSummary.
agent_type (str) – The value to assign to the agent_type property of this JmsPluginSummary. Allowed values for this property are: “OMA”, “OCA”, “OCMA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this JmsPluginSummary. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “NEEDS_ATTENTION”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
availability_status (str) – The value to assign to the availability_status property of this JmsPluginSummary. Allowed values for this property are: “ACTIVE”, “SILENT”, “NOT_AVAILABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
fleet_id (str) – The value to assign to the fleet_id property of this JmsPluginSummary.
compartment_id (str) – The value to assign to the compartment_id property of this JmsPluginSummary.
hostname (str) – The value to assign to the hostname property of this JmsPluginSummary.
os_family (str) – The value to assign to the os_family property of this JmsPluginSummary. Allowed values for this property are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
os_architecture (str) – The value to assign to the os_architecture property of this JmsPluginSummary.
os_distribution (str) – The value to assign to the os_distribution property of this JmsPluginSummary.
plugin_version (str) – The value to assign to the plugin_version property of this JmsPluginSummary.
time_registered (datetime) – The value to assign to the time_registered property of this JmsPluginSummary.
time_last_seen (datetime) – The value to assign to the time_last_seen property of this JmsPluginSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this JmsPluginSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this JmsPluginSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this JmsPluginSummary.
- property agent_id¶
[Required] Gets the agent_id of this JmsPluginSummary. The OCID of the Management Agent (OMA), the Oracle Cloud Agent (OCA), or the Oracle Container Management Agent (OCMA) instance where the JMS plugin is deployed.
- Returns
The agent_id of this JmsPluginSummary.
- Return type
str
- property agent_type¶
[Required] Gets the agent_type of this JmsPluginSummary. The agent type.
Allowed values for this property are: “OMA”, “OCA”, “OCMA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The agent_type of this JmsPluginSummary.
- Return type
str
- property availability_status¶
[Required] Gets the availability_status of this JmsPluginSummary. The availability status.
Allowed values for this property are: “ACTIVE”, “SILENT”, “NOT_AVAILABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The availability_status of this JmsPluginSummary.
- Return type
str
- property compartment_id¶
Gets the compartment_id of this JmsPluginSummary. The OMA/OCA/OCMA agent’s compartment OCID.
- Returns
The compartment_id of this JmsPluginSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this JmsPluginSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}. (See Understanding Free-form Tags).
- Returns
The defined_tags of this JmsPluginSummary.
- Return type
dict(str, dict(str, object))
- property fleet_id¶
Gets the fleet_id of this JmsPluginSummary. The OCID of the fleet.
- Returns
The fleet_id of this JmsPluginSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this JmsPluginSummary. Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}. (See Managing Tags and Tag Namespaces.)
- Returns
The freeform_tags of this JmsPluginSummary.
- Return type
dict(str, str)
- property hostname¶
Gets the hostname of this JmsPluginSummary. The hostname of the agent.
- Returns
The hostname of this JmsPluginSummary.
- Return type
str
- property id¶
[Required] Gets the id of this JmsPluginSummary. The OCID to identify this JmsPlugin.
- Returns
The id of this JmsPluginSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this JmsPluginSummary. The lifecycle state.
Allowed values for this property are: “ACTIVE”, “INACTIVE”, “NEEDS_ATTENTION”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this JmsPluginSummary.
- Return type
str
- property os_architecture¶
Gets the os_architecture of this JmsPluginSummary. The architecture of the operating system of the plugin.
- Returns
The os_architecture of this JmsPluginSummary.
- Return type
str
- property os_distribution¶
Gets the os_distribution of this JmsPluginSummary. The distribution of the operating system of the plugin.
- Returns
The os_distribution of this JmsPluginSummary.
- Return type
str
- property os_family¶
Gets the os_family of this JmsPluginSummary. The operating system family for the plugin.
Allowed values for this property are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The os_family of this JmsPluginSummary.
- Return type
str
- property plugin_version¶
Gets the plugin_version of this JmsPluginSummary. The version of the plugin.
- Returns
The plugin_version of this JmsPluginSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this JmsPluginSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this JmsPluginSummary.
- Return type
dict(str, dict(str, object))
- property time_last_seen¶
Gets the time_last_seen of this JmsPluginSummary. The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period.
- Returns
The time_last_seen of this JmsPluginSummary.
- Return type
datetime
- property time_registered¶
[Required] Gets the time_registered of this JmsPluginSummary. The date and time the plugin was registered.
- Returns
The time_registered of this JmsPluginSummary.
- Return type
datetime