OsCommandQueryProperties

class oci.stack_monitoring.models.OsCommandQueryProperties(**kwargs)

Bases: oci.stack_monitoring.models.metric_extension_query_properties.MetricExtensionQueryProperties

Query Properties applicable to OS_COMMAND type of collection method

Attributes

COLLECTION_METHOD_JMX str(object=’’) -> str
COLLECTION_METHOD_OS_COMMAND str(object=’’) -> str
COLLECTION_METHOD_SQL str(object=’’) -> str
arguments Gets the arguments of this OsCommandQueryProperties.
collection_method [Required] Gets the collection_method of this MetricExtensionQueryProperties.
command [Required] Gets the command of this OsCommandQueryProperties.
delimiter [Required] Gets the delimiter of this OsCommandQueryProperties.
script_details Gets the script_details of this OsCommandQueryProperties.
starts_with Gets the starts_with of this OsCommandQueryProperties.

Methods

__init__(**kwargs) Initializes a new OsCommandQueryProperties object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
COLLECTION_METHOD_JMX = 'JMX'
COLLECTION_METHOD_OS_COMMAND = 'OS_COMMAND'
COLLECTION_METHOD_SQL = 'SQL'
__init__(**kwargs)

Initializes a new OsCommandQueryProperties object with values from keyword arguments. The default value of the collection_method attribute of this class is OS_COMMAND and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • collection_method (str) – The value to assign to the collection_method property of this OsCommandQueryProperties. Allowed values for this property are: “OS_COMMAND”, “SQL”, “JMX”
  • command (str) – The value to assign to the command property of this OsCommandQueryProperties.
  • delimiter (str) – The value to assign to the delimiter property of this OsCommandQueryProperties.
  • script_details (oci.stack_monitoring.models.ScriptFileDetails) – The value to assign to the script_details property of this OsCommandQueryProperties.
  • arguments (str) – The value to assign to the arguments property of this OsCommandQueryProperties.
  • starts_with (str) – The value to assign to the starts_with property of this OsCommandQueryProperties.
arguments

Gets the arguments of this OsCommandQueryProperties. Arguments required by either command or script

Returns:The arguments of this OsCommandQueryProperties.
Return type:str
collection_method

[Required] Gets the collection_method of this MetricExtensionQueryProperties. Type of possible collection methods.

Allowed values for this property are: “OS_COMMAND”, “SQL”, “JMX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The collection_method of this MetricExtensionQueryProperties.
Return type:str
command

[Required] Gets the command of this OsCommandQueryProperties. OS command to execute without arguments

Returns:The command of this OsCommandQueryProperties.
Return type:str
delimiter

[Required] Gets the delimiter of this OsCommandQueryProperties. Character used to delimit multiple metric values in single line of output

Returns:The delimiter of this OsCommandQueryProperties.
Return type:str
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

script_details

Gets the script_details of this OsCommandQueryProperties.

Returns:The script_details of this OsCommandQueryProperties.
Return type:oci.stack_monitoring.models.ScriptFileDetails
starts_with

Gets the starts_with of this OsCommandQueryProperties. String prefix used to identify metric output of the OS Command

Returns:The starts_with of this OsCommandQueryProperties.
Return type:str