ExportDetails¶
-
class
oci.log_analytics.models.
ExportDetails
(**kwargs)¶ Bases:
object
Input arguments for running a query synchronosly and streaming the results as soon as they become available.
Attributes
OUTPUT_FORMAT_CSV
A constant which can be used with the output_format property of a ExportDetails. OUTPUT_FORMAT_JSON
A constant which can be used with the output_format property of a ExportDetails. SUB_SYSTEM_LOG
A constant which can be used with the sub_system property of a ExportDetails. compartment_id
[Required] Gets the compartment_id of this ExportDetails. compartment_id_in_subtree
Gets the compartment_id_in_subtree of this ExportDetails. max_total_count
Gets the max_total_count of this ExportDetails. output_format
Gets the output_format of this ExportDetails. query_string
[Required] Gets the query_string of this ExportDetails. query_timeout_in_seconds
Gets the query_timeout_in_seconds of this ExportDetails. scope_filters
Gets the scope_filters of this ExportDetails. should_include_columns
Gets the should_include_columns of this ExportDetails. should_localize
Gets the should_localize of this ExportDetails. should_use_acceleration
Gets the should_use_acceleration of this ExportDetails. sub_system
[Required] Gets the sub_system of this ExportDetails. time_filter
Gets the time_filter of this ExportDetails. Methods
__init__
(**kwargs)Initializes a new ExportDetails object with values from keyword arguments. -
OUTPUT_FORMAT_CSV
= 'CSV'¶ A constant which can be used with the output_format property of a ExportDetails. This constant has a value of “CSV”
-
OUTPUT_FORMAT_JSON
= 'JSON'¶ A constant which can be used with the output_format property of a ExportDetails. This constant has a value of “JSON”
-
SUB_SYSTEM_LOG
= 'LOG'¶ A constant which can be used with the sub_system property of a ExportDetails. This constant has a value of “LOG”
-
__init__
(**kwargs)¶ Initializes a new ExportDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - compartment_id (str) – The value to assign to the compartment_id property of this ExportDetails.
- compartment_id_in_subtree (bool) – The value to assign to the compartment_id_in_subtree property of this ExportDetails.
- query_string (str) – The value to assign to the query_string property of this ExportDetails.
- sub_system (str) – The value to assign to the sub_system property of this ExportDetails. Allowed values for this property are: “LOG”
- scope_filters (list[oci.log_analytics.models.ScopeFilter]) – The value to assign to the scope_filters property of this ExportDetails.
- max_total_count (int) – The value to assign to the max_total_count property of this ExportDetails.
- time_filter (oci.log_analytics.models.TimeRange) – The value to assign to the time_filter property of this ExportDetails.
- query_timeout_in_seconds (int) – The value to assign to the query_timeout_in_seconds property of this ExportDetails.
- should_include_columns (bool) – The value to assign to the should_include_columns property of this ExportDetails.
- output_format (str) – The value to assign to the output_format property of this ExportDetails. Allowed values for this property are: “CSV”, “JSON”
- should_localize (bool) – The value to assign to the should_localize property of this ExportDetails.
- should_use_acceleration (bool) – The value to assign to the should_use_acceleration property of this ExportDetails.
-
compartment_id
¶ [Required] Gets the compartment_id of this ExportDetails. Compartment Identifier OCID].
Returns: The compartment_id of this ExportDetails. Return type: str
-
compartment_id_in_subtree
¶ Gets the compartment_id_in_subtree of this ExportDetails. Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
Returns: The compartment_id_in_subtree of this ExportDetails. Return type: bool
-
max_total_count
¶ Gets the max_total_count of this ExportDetails. Maximum number of results retrieved from data source. Note a maximum value will be enforced; if the export results can be streamed, the maximum will be 50000000, otherwise 10000; that is, if not streamed, actualMaxTotalCountUsed = Math.min(maxTotalCount, 10000).
Export will incrementally stream results depending on the queryString.
- Some commands including head/tail are not compatible with streaming result delivery and therefore enforce a reduced limit on overall maxtotalcount.
- no sort command or sort by id, e.g. ‘ | sort id ‘ - is streaming compatible sort by time and id, e.g. ‘ | sort -time, id ‘ - is streaming compatible
all other cases, e.g. ‘ | sort -time, id, mtgtguid ‘ - is not streaming compatible due to the additional sort field
Returns: The max_total_count of this ExportDetails. Return type: int
-
output_format
¶ Gets the output_format of this ExportDetails. Specifies the format for the returned results.
Allowed values for this property are: “CSV”, “JSON”
Returns: The output_format of this ExportDetails. Return type: str
-
query_string
¶ [Required] Gets the query_string of this ExportDetails. Query to perform.
Returns: The query_string of this ExportDetails. Return type: str
-
query_timeout_in_seconds
¶ Gets the query_timeout_in_seconds of this ExportDetails. Amount of time, in seconds, allowed for a query to execute. If this time expires before the query is complete, any partial results will be returned.
Returns: The query_timeout_in_seconds of this ExportDetails. Return type: int
-
scope_filters
¶ Gets the scope_filters of this ExportDetails. List of filters to be applied when the query executes. More than one filter per field is not permitted.
Returns: The scope_filters of this ExportDetails. Return type: list[oci.log_analytics.models.ScopeFilter]
-
should_include_columns
¶ Gets the should_include_columns of this ExportDetails. Include columns in response
Returns: The should_include_columns of this ExportDetails. Return type: bool
-
should_localize
¶ Gets the should_localize of this ExportDetails. Localize results, including header columns, List-Of-Values and timestamp values.
Returns: The should_localize of this ExportDetails. Return type: bool
-
should_use_acceleration
¶ Gets the should_use_acceleration of this ExportDetails. Controls if query should ignore pre-calculated results if available and only use raw data.
Returns: The should_use_acceleration of this ExportDetails. Return type: bool
-
sub_system
¶ [Required] Gets the sub_system of this ExportDetails. Default subsystem to qualify fields with in the queryString if not specified.
Allowed values for this property are: “LOG”
Returns: The sub_system of this ExportDetails. Return type: str
-
time_filter
¶ Gets the time_filter of this ExportDetails.
Returns: The time_filter of this ExportDetails. Return type: oci.log_analytics.models.TimeRange
-