OsCommandQueryProperties¶

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

Bases: MetricExtensionQueryProperties

Query Properties applicable to OS_COMMAND type of collection method

Attributes:

`COLLECTION_METHOD_HTTP`	A constant which can be used with the collection_method property of a MetricExtensionQueryProperties.
`COLLECTION_METHOD_JMX`	A constant which can be used with the collection_method property of a MetricExtensionQueryProperties.
`COLLECTION_METHOD_OS_COMMAND`	A constant which can be used with the collection_method property of a MetricExtensionQueryProperties.
`COLLECTION_METHOD_SQL`	A constant which can be used with the collection_method property of a MetricExtensionQueryProperties.
`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_HTTP = 'HTTP'¶: A constant which can be used with the collection_method property of a MetricExtensionQueryProperties. This constant has a value of “HTTP”

COLLECTION_METHOD_JMX = 'JMX'¶: A constant which can be used with the collection_method property of a MetricExtensionQueryProperties. This constant has a value of “JMX”

COLLECTION_METHOD_OS_COMMAND = 'OS_COMMAND'¶: A constant which can be used with the collection_method property of a MetricExtensionQueryProperties. This constant has a value of “OS_COMMAND”

COLLECTION_METHOD_SQL = 'SQL'¶: A constant which can be used with the collection_method property of a MetricExtensionQueryProperties. This constant has a value of “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”, “HTTP”
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.

property arguments¶

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

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

property 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”, “HTTP”, ‘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

property command¶

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

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

property 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.

property script_details¶

Gets the script_details of this OsCommandQueryProperties.

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

property 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