TimeClusterColumn¶

class oci.log_analytics.models.TimeClusterColumn(**kwargs)¶

Bases: oci.log_analytics.models.abstract_column.AbstractColumn

Column returned by querylanguage TIMECLUSTER command.

Attributes

`SUB_SYSTEM_LOG`	str(object=’’) -> str
`TYPE_CHART_COLUMN`	str(object=’’) -> str
`TYPE_CHART_DATA_COLUMN`	str(object=’’) -> str
`TYPE_CLASSIFY_COLUMN`	str(object=’’) -> str
`TYPE_COLUMN`	str(object=’’) -> str
`TYPE_TABLE_COLUMN`	str(object=’’) -> str
`TYPE_TIME_CLUSTER_COLUMN`	str(object=’’) -> str
`TYPE_TIME_CLUSTER_DATA_COLUMN`	str(object=’’) -> str
`TYPE_TIME_COLUMN`	str(object=’’) -> str
`TYPE_TIME_STATS_COLUMN`	str(object=’’) -> str
`TYPE_TIME_STATS_DATA_COLUMN`	str(object=’’) -> str
`TYPE_TREND_COLUMN`	str(object=’’) -> str
`VALUE_TYPE_BOOLEAN`	str(object=’’) -> str
`VALUE_TYPE_DOUBLE`	str(object=’’) -> str
`VALUE_TYPE_FACET`	str(object=’’) -> str
`VALUE_TYPE_FLOAT`	str(object=’’) -> str
`VALUE_TYPE_INTEGER`	str(object=’’) -> str
`VALUE_TYPE_LONG`	str(object=’’) -> str
`VALUE_TYPE_STRING`	str(object=’’) -> str
`VALUE_TYPE_TABLE`	str(object=’’) -> str
`VALUE_TYPE_TIMESTAMP`	str(object=’’) -> str
`clusters`	Gets the clusters of this TimeClusterColumn.
`display_name`	Gets the display_name of this AbstractColumn.
`group_by_columns`	Gets the group_by_columns of this TimeClusterColumn.
`internal_name`	Gets the internal_name of this AbstractColumn.
`interval_gap`	Gets the interval_gap of this TimeClusterColumn.
`intervals`	Gets the intervals of this TimeClusterColumn.
`is_case_sensitive`	Gets the is_case_sensitive of this AbstractColumn.
`is_evaluable`	Gets the is_evaluable of this AbstractColumn.
`is_groupable`	Gets the is_groupable of this AbstractColumn.
`is_hidden`	Gets the is_hidden of this AbstractColumn.
`is_list_of_values`	Gets the is_list_of_values of this AbstractColumn.
`is_multi_valued`	Gets the is_multi_valued of this AbstractColumn.
`original_display_name`	Gets the original_display_name of this AbstractColumn.
`series`	Gets the series of this TimeClusterColumn.
`sub_system`	Gets the sub_system of this AbstractColumn.
`type`	[Required] Gets the type of this AbstractColumn.
`value_type`	Gets the value_type of this AbstractColumn.
`values`	Gets the values of this AbstractColumn.

Methods

`__init__`(**kwargs)	Initializes a new TimeClusterColumn 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.

SUB_SYSTEM_LOG = 'LOG'¶

TYPE_CHART_COLUMN = 'CHART_COLUMN'¶

TYPE_CHART_DATA_COLUMN = 'CHART_DATA_COLUMN'¶

TYPE_CLASSIFY_COLUMN = 'CLASSIFY_COLUMN'¶

TYPE_COLUMN = 'COLUMN'¶

TYPE_TABLE_COLUMN = 'TABLE_COLUMN'¶

TYPE_TIME_CLUSTER_COLUMN = 'TIME_CLUSTER_COLUMN'¶

TYPE_TIME_CLUSTER_DATA_COLUMN = 'TIME_CLUSTER_DATA_COLUMN'¶

TYPE_TIME_COLUMN = 'TIME_COLUMN'¶

TYPE_TIME_STATS_COLUMN = 'TIME_STATS_COLUMN'¶

TYPE_TIME_STATS_DATA_COLUMN = 'TIME_STATS_DATA_COLUMN'¶

TYPE_TREND_COLUMN = 'TREND_COLUMN'¶

VALUE_TYPE_BOOLEAN = 'BOOLEAN'¶

VALUE_TYPE_DOUBLE = 'DOUBLE'¶

VALUE_TYPE_FACET = 'FACET'¶

VALUE_TYPE_FLOAT = 'FLOAT'¶

VALUE_TYPE_INTEGER = 'INTEGER'¶

VALUE_TYPE_LONG = 'LONG'¶

VALUE_TYPE_STRING = 'STRING'¶

VALUE_TYPE_TABLE = 'TABLE'¶

VALUE_TYPE_TIMESTAMP = 'TIMESTAMP'¶

__init__(**kwargs)¶

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

Parameters:

type (str) – The value to assign to the type property of this TimeClusterColumn. Allowed values for this property are: “COLUMN”, “CHART_COLUMN”, “CHART_DATA_COLUMN”, “TIME_STATS_COLUMN”, “TIME_STATS_DATA_COLUMN”, “TIME_CLUSTER_COLUMN”, “TIME_CLUSTER_DATA_COLUMN”, “TABLE_COLUMN”, “TIME_COLUMN”, “TREND_COLUMN”, “CLASSIFY_COLUMN”
display_name (str) – The value to assign to the display_name property of this TimeClusterColumn.
sub_system (str) – The value to assign to the sub_system property of this TimeClusterColumn. Allowed values for this property are: “LOG”
values (list[oci.log_analytics.models.FieldValue]) – The value to assign to the values property of this TimeClusterColumn.
is_list_of_values (bool) – The value to assign to the is_list_of_values property of this TimeClusterColumn.
is_multi_valued (bool) – The value to assign to the is_multi_valued property of this TimeClusterColumn.
is_case_sensitive (bool) – The value to assign to the is_case_sensitive property of this TimeClusterColumn.
is_groupable (bool) – The value to assign to the is_groupable property of this TimeClusterColumn.
is_evaluable (bool) – The value to assign to the is_evaluable property of this TimeClusterColumn.
is_hidden (bool) – The value to assign to the is_hidden property of this TimeClusterColumn.
value_type (str) – The value to assign to the value_type property of this TimeClusterColumn. Allowed values for this property are: “BOOLEAN”, “STRING”, “DOUBLE”, “FLOAT”, “LONG”, “INTEGER”, “TIMESTAMP”, “FACET”, “TABLE”
original_display_name (str) – The value to assign to the original_display_name property of this TimeClusterColumn.
internal_name (str) – The value to assign to the internal_name property of this TimeClusterColumn.
interval_gap (str) – The value to assign to the interval_gap property of this TimeClusterColumn.
intervals (list[int]) – The value to assign to the intervals property of this TimeClusterColumn.
group_by_columns (list[oci.log_analytics.models.AbstractColumn]) – The value to assign to the group_by_columns property of this TimeClusterColumn.
clusters (dict(str, TimeStatsCluster)) – The value to assign to the clusters property of this TimeClusterColumn.
series (list[oci.log_analytics.models.TimeClusterDataColumn]) – The value to assign to the series property of this TimeClusterColumn.

clusters¶

Gets the clusters of this TimeClusterColumn. Timeseries clusters identified by the command.

Returns:	The clusters of this TimeClusterColumn.
Return type:	dict(str, TimeStatsCluster)

display_name¶

Gets the display_name of this AbstractColumn. Column display name - will be alias if column is renamed by queryStrng.

Returns:	The display_name of this AbstractColumn.
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.

group_by_columns¶

Gets the group_by_columns of this TimeClusterColumn. Group by columns specified in the command.

Returns:	The group_by_columns of this TimeClusterColumn.
Return type:	list[oci.log_analytics.models.AbstractColumn]

internal_name¶

Gets the internal_name of this AbstractColumn. Internal identifier for the column.

Returns:	The internal_name of this AbstractColumn.
Return type:	str

interval_gap¶

Gets the interval_gap of this TimeClusterColumn. Time span between each timestamp in the timeseries datapoints.

Returns:	The interval_gap of this TimeClusterColumn.
Return type:	str

intervals¶

Gets the intervals of this TimeClusterColumn. List of timestamps making up the timeseries datapoints.

Returns:	The intervals of this TimeClusterColumn.
Return type:	list[int]

is_case_sensitive¶

Gets the is_case_sensitive of this AbstractColumn. A flag indicating whether or not the field is a case sensitive field. Only applies to string fields.

Returns:	The is_case_sensitive of this AbstractColumn.
Return type:	bool

is_evaluable¶

Gets the is_evaluable of this AbstractColumn. Identifies if this column can be used as an expression parameter in any command that accepts querylanguage expressions.

Returns:	The is_evaluable of this AbstractColumn.
Return type:	bool

is_groupable¶

Gets the is_groupable of this AbstractColumn. Identifies if this column can be used as a grouping field in any grouping command.

Returns:	The is_groupable of this AbstractColumn.
Return type:	bool

is_hidden¶

Gets the is_hidden of this AbstractColumn. Identifies if this column should be hidden by default but can be displayed in the UI on demand.

Returns:	The is_hidden of this AbstractColumn.
Return type:	bool

is_list_of_values¶

Gets the is_list_of_values of this AbstractColumn. Identifies if all values in this column come from a pre-defined list of values.

Returns:	The is_list_of_values of this AbstractColumn.
Return type:	bool

is_multi_valued¶

Gets the is_multi_valued of this AbstractColumn. Identifies if this column allows multiple values to exist in a single row.

Returns:	The is_multi_valued of this AbstractColumn.
Return type:	bool

original_display_name¶

Gets the original_display_name of this AbstractColumn. Same as displayName unless column renamed in which case this will hold the original display name for the column.

Returns:	The original_display_name of this AbstractColumn.
Return type:	str

series¶

Gets the series of this TimeClusterColumn. List of series data sets for each statistical function specified in the command.

Returns:	The series of this TimeClusterColumn.
Return type:	list[oci.log_analytics.models.TimeClusterDataColumn]

sub_system¶

Gets the sub_system of this AbstractColumn. Subsystem column belongs to.

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

Returns:	The sub_system of this AbstractColumn.
Return type:	str

type¶

[Required] Gets the type of this AbstractColumn. Column classification when column requires special designation.

Allowed values for this property are: “COLUMN”, “CHART_COLUMN”, “CHART_DATA_COLUMN”, “TIME_STATS_COLUMN”, “TIME_STATS_DATA_COLUMN”, “TIME_CLUSTER_COLUMN”, “TIME_CLUSTER_DATA_COLUMN”, “TABLE_COLUMN”, “TIME_COLUMN”, “TREND_COLUMN”, “CLASSIFY_COLUMN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this AbstractColumn.
Return type:	str

value_type¶

Gets the value_type of this AbstractColumn. Field denoting column data type.

Allowed values for this property are: “BOOLEAN”, “STRING”, “DOUBLE”, “FLOAT”, “LONG”, “INTEGER”, “TIMESTAMP”, “FACET”, “TABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The value_type of this AbstractColumn.
Return type:	str

values¶

Gets the values of this AbstractColumn. If the column is a ‘List of Values’ column, this array contains the field values that are applicable to query results or all if no filters applied.

Returns:	The values of this AbstractColumn.
Return type:	list[oci.log_analytics.models.FieldValue]