VariableDefinition¶
- class oci.log_analytics.models.VariableDefinition(**kwargs)¶
Bases:
objectDefines a variable used in a macro or the initization section of a query.
Attributes:
A constant which can be used with the type property of a VariableDefinition.
A constant which can be used with the type property of a VariableDefinition.
A constant which can be used with the type property of a VariableDefinition.
Gets the default_value of this VariableDefinition.
Gets the description of this VariableDefinition.
Gets the map_keys of this VariableDefinition.
[Required] Gets the name of this VariableDefinition.
Gets the properties of this VariableDefinition.
Gets the type of this VariableDefinition.
Methods:
__init__(**kwargs)Initializes a new VariableDefinition object with values from keyword arguments.
- TYPE_NUMBER = 'NUMBER'¶
A constant which can be used with the type property of a VariableDefinition. This constant has a value of “NUMBER”
- TYPE_STRING = 'STRING'¶
A constant which can be used with the type property of a VariableDefinition. This constant has a value of “STRING”
- TYPE_TIMESTAMP = 'TIMESTAMP'¶
A constant which can be used with the type property of a VariableDefinition. This constant has a value of “TIMESTAMP”
- __init__(**kwargs)¶
Initializes a new VariableDefinition object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
name (str) – The value to assign to the name property of this VariableDefinition.
description (str) – The value to assign to the description property of this VariableDefinition.
type (str) – The value to assign to the type property of this VariableDefinition. Allowed values for this property are: “NUMBER”, “STRING”, “TIMESTAMP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
map_keys (list[oci.log_analytics.models.VariableDefinition]) – The value to assign to the map_keys property of this VariableDefinition.
default_value (str) – The value to assign to the default_value property of this VariableDefinition.
properties (list[oci.log_analytics.models.PropertyDefinition]) – The value to assign to the properties property of this VariableDefinition.
- property default_value¶
Gets the default_value of this VariableDefinition. Default value of the variable is not already set.
- Returns
The default_value of this VariableDefinition.
- Return type
str
- property description¶
Gets the description of this VariableDefinition. Descripion of the variable to show the user.
- Returns
The description of this VariableDefinition.
- Return type
str
- property map_keys¶
Gets the map_keys of this VariableDefinition. List of variables if this variable is a map.
- Returns
The map_keys of this VariableDefinition.
- Return type
- property name¶
[Required] Gets the name of this VariableDefinition. Name of the variable preceded by a $.
- Returns
The name of this VariableDefinition.
- Return type
str
- property properties¶
Gets the properties of this VariableDefinition. Optional list of properties for the variable.
- Returns
The properties of this VariableDefinition.
- Return type
- property type¶
Gets the type of this VariableDefinition. Type of the variable to show the user.
Allowed values for this property are: “NUMBER”, “STRING”, “TIMESTAMP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this VariableDefinition.
- Return type
str