QueryAggregation¶

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

Bases: object

Query results.

Methods:

__init__(**kwargs)

Initializes a new QueryAggregation object with values from keyword arguments.

Attributes:

`are_partial_results`	Gets the are_partial_results of this QueryAggregation.
`columns`	Gets the columns of this QueryAggregation.
`fields`	Gets the fields of this QueryAggregation.
`is_content_hidden`	Gets the is_content_hidden of this QueryAggregation.
`items`	Gets the items of this QueryAggregation.
`partial_result_reason`	Gets the partial_result_reason of this QueryAggregation.
`percent_complete`	[Required] Gets the percent_complete of this QueryAggregation.
`query_execution_time_in_ms`	Gets the query_execution_time_in_ms of this QueryAggregation.
`recalls`	Gets the recalls of this QueryAggregation.
`time_filter`	Gets the time_filter of this QueryAggregation.
`total_count`	Gets the total_count of this QueryAggregation.
`total_group_count`	Gets the total_group_count of this QueryAggregation.
`total_matched_count`	Gets the total_matched_count of this QueryAggregation.

__init__(**kwargs)¶

Initializes a new QueryAggregation object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

total_count (int) – The value to assign to the total_count property of this QueryAggregation.
total_matched_count (int) – The value to assign to the total_matched_count property of this QueryAggregation.
total_group_count (int) – The value to assign to the total_group_count property of this QueryAggregation.
time_filter (oci.log_analytics.models.TimeRange) – The value to assign to the time_filter property of this QueryAggregation.
recalls (list[oci.log_analytics.models.RecallDefinition]) – The value to assign to the recalls property of this QueryAggregation.
are_partial_results (bool) – The value to assign to the are_partial_results property of this QueryAggregation.
partial_result_reason (str) – The value to assign to the partial_result_reason property of this QueryAggregation.
is_content_hidden (bool) – The value to assign to the is_content_hidden property of this QueryAggregation.
columns (list[oci.log_analytics.models.AbstractColumn]) – The value to assign to the columns property of this QueryAggregation.
fields (list[oci.log_analytics.models.AbstractColumn]) – The value to assign to the fields property of this QueryAggregation.
items (list[dict(str, object)]) – The value to assign to the items property of this QueryAggregation.
query_execution_time_in_ms (int) – The value to assign to the query_execution_time_in_ms property of this QueryAggregation.
percent_complete (int) – The value to assign to the percent_complete property of this QueryAggregation.

property are_partial_results¶

Gets the are_partial_results of this QueryAggregation. True if query did not complete processing all data.

Returns: The are_partial_results of this QueryAggregation.
Return type: bool

property columns¶

Gets the columns of this QueryAggregation. Query result columns

Returns: The columns of this QueryAggregation.
Return type: list[oci.log_analytics.models.AbstractColumn]

property fields¶

Gets the fields of this QueryAggregation. Query result fields

Returns: The fields of this QueryAggregation.
Return type: list[oci.log_analytics.models.AbstractColumn]

property is_content_hidden¶

Gets the is_content_hidden of this QueryAggregation. True if the data returned by query is hidden.

Returns: The is_content_hidden of this QueryAggregation.
Return type: bool

property items¶

Gets the items of this QueryAggregation. Query result data

Returns: The items of this QueryAggregation.
Return type: list[dict(str, object)]

property partial_result_reason¶

Gets the partial_result_reason of this QueryAggregation. Explanation of why results may be partial. Only set if arePartialResults is true.

Returns: The partial_result_reason of this QueryAggregation.
Return type: str

property percent_complete¶

[Required] Gets the percent_complete of this QueryAggregation. Percentage progress completion of the query.

Returns: The percent_complete of this QueryAggregation.
Return type: int

property query_execution_time_in_ms¶

Gets the query_execution_time_in_ms of this QueryAggregation. Time ellapsed executing query in milli-seconds.

Returns: The query_execution_time_in_ms of this QueryAggregation.
Return type: int

property recalls¶

Gets the recalls of this QueryAggregation. List of recalls in the query.

Returns: The recalls of this QueryAggregation.
Return type: list[oci.log_analytics.models.RecallDefinition]

property time_filter¶

Gets the time_filter of this QueryAggregation.

Returns: The time_filter of this QueryAggregation.
Return type: oci.log_analytics.models.TimeRange

property total_count¶

Gets the total_count of this QueryAggregation. Number of rows query retrieved. Up to maxTotalCount limit.

Returns: The total_count of this QueryAggregation.
Return type: int

property total_group_count¶

Gets the total_group_count of this QueryAggregation. Number of groups created by query.

Returns: The total_group_count of this QueryAggregation.
Return type: int

property total_matched_count¶

Gets the total_matched_count of this QueryAggregation. Number of rows matched by query.

Returns: The total_matched_count of this QueryAggregation.
Return type: int