LogAnalyticsParser¶

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

Bases: object

Attributes

`TYPE_DELIMITED`	A constant which can be used with the type property of a LogAnalyticsParser.
`TYPE_JSON`	A constant which can be used with the type property of a LogAnalyticsParser.
`TYPE_ODL`	A constant which can be used with the type property of a LogAnalyticsParser.
`TYPE_REGEX`	A constant which can be used with the type property of a LogAnalyticsParser.
`TYPE_XML`	A constant which can be used with the type property of a LogAnalyticsParser.
`categories`	Gets the categories of this LogAnalyticsParser.
`content`	Gets the content of this LogAnalyticsParser.
`dependent_parsers`	Gets the dependent_parsers of this LogAnalyticsParser.
`dependent_sources`	Gets the dependent_sources of this LogAnalyticsParser.
`description`	Gets the description of this LogAnalyticsParser.
`display_name`	Gets the display_name of this LogAnalyticsParser.
`edit_version`	Gets the edit_version of this LogAnalyticsParser.
`encoding`	Gets the encoding of this LogAnalyticsParser.
`example_content`	Gets the example_content of this LogAnalyticsParser.
`field_delimiter`	Gets the field_delimiter of this LogAnalyticsParser.
`field_maps`	Gets the field_maps of this LogAnalyticsParser.
`field_qualifier`	Gets the field_qualifier of this LogAnalyticsParser.
`footer_content`	Gets the footer_content of this LogAnalyticsParser.
`header_content`	Gets the header_content of this LogAnalyticsParser.
`is_default`	Gets the is_default of this LogAnalyticsParser.
`is_hidden`	Gets the is_hidden of this LogAnalyticsParser.
`is_namespace_aware`	Gets the is_namespace_aware of this LogAnalyticsParser.
`is_parser_written_once`	Gets the is_parser_written_once of this LogAnalyticsParser.
`is_position_aware`	Gets the is_position_aware of this LogAnalyticsParser.
`is_single_line_content`	Gets the is_single_line_content of this LogAnalyticsParser.
`is_system`	Gets the is_system of this LogAnalyticsParser.
`is_user_deleted`	Gets the is_user_deleted of this LogAnalyticsParser.
`language`	Gets the language of this LogAnalyticsParser.
`log_type_test_request_version`	Gets the log_type_test_request_version of this LogAnalyticsParser.
`mapped_parsers`	Gets the mapped_parsers of this LogAnalyticsParser.
`name`	Gets the name of this LogAnalyticsParser.
`parser_filter`	Gets the parser_filter of this LogAnalyticsParser.
`parser_functions`	Gets the parser_functions of this LogAnalyticsParser.
`parser_ignoreline_characters`	Gets the parser_ignoreline_characters of this LogAnalyticsParser.
`parser_sequence`	Gets the parser_sequence of this LogAnalyticsParser.
`parser_timezone`	Gets the parser_timezone of this LogAnalyticsParser.
`should_tokenize_original_text`	Gets the should_tokenize_original_text of this LogAnalyticsParser.
`sources`	Gets the sources of this LogAnalyticsParser.
`sources_count`	Gets the sources_count of this LogAnalyticsParser.
`time_updated`	Gets the time_updated of this LogAnalyticsParser.
`type`	Gets the type of this LogAnalyticsParser.

Methods

__init__(**kwargs) Initializes a new LogAnalyticsParser object with values from keyword arguments.

TYPE_DELIMITED = 'DELIMITED'¶: A constant which can be used with the type property of a LogAnalyticsParser. This constant has a value of “DELIMITED”

TYPE_JSON = 'JSON'¶: A constant which can be used with the type property of a LogAnalyticsParser. This constant has a value of “JSON”

TYPE_ODL = 'ODL'¶: A constant which can be used with the type property of a LogAnalyticsParser. This constant has a value of “ODL”

TYPE_REGEX = 'REGEX'¶: A constant which can be used with the type property of a LogAnalyticsParser. This constant has a value of “REGEX”

TYPE_XML = 'XML'¶: A constant which can be used with the type property of a LogAnalyticsParser. This constant has a value of “XML”

__init__(**kwargs)¶

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

Parameters:

content (str) – The value to assign to the content property of this LogAnalyticsParser.
description (str) – The value to assign to the description property of this LogAnalyticsParser.
display_name (str) – The value to assign to the display_name property of this LogAnalyticsParser.
edit_version (int) – The value to assign to the edit_version property of this LogAnalyticsParser.
encoding (str) – The value to assign to the encoding property of this LogAnalyticsParser.
example_content (str) – The value to assign to the example_content property of this LogAnalyticsParser.
field_maps (list[oci.log_analytics.models.LogAnalyticsParserField]) – The value to assign to the field_maps property of this LogAnalyticsParser.
footer_content (str) – The value to assign to the footer_content property of this LogAnalyticsParser.
header_content (str) – The value to assign to the header_content property of this LogAnalyticsParser.
name (str) – The value to assign to the name property of this LogAnalyticsParser.
is_default (bool) – The value to assign to the is_default property of this LogAnalyticsParser.
is_single_line_content (bool) – The value to assign to the is_single_line_content property of this LogAnalyticsParser.
is_system (bool) – The value to assign to the is_system property of this LogAnalyticsParser.
language (str) – The value to assign to the language property of this LogAnalyticsParser.
time_updated (datetime) – The value to assign to the time_updated property of this LogAnalyticsParser.
log_type_test_request_version (int) – The value to assign to the log_type_test_request_version property of this LogAnalyticsParser.
mapped_parsers (list[oci.log_analytics.models.LogAnalyticsParser]) – The value to assign to the mapped_parsers property of this LogAnalyticsParser.
parser_ignoreline_characters (str) – The value to assign to the parser_ignoreline_characters property of this LogAnalyticsParser.
is_hidden (bool) – The value to assign to the is_hidden property of this LogAnalyticsParser.
parser_sequence (int) – The value to assign to the parser_sequence property of this LogAnalyticsParser.
parser_timezone (str) – The value to assign to the parser_timezone property of this LogAnalyticsParser.
parser_filter (oci.log_analytics.models.LogAnalyticsParserFilter) – The value to assign to the parser_filter property of this LogAnalyticsParser.
is_parser_written_once (bool) – The value to assign to the is_parser_written_once property of this LogAnalyticsParser.
parser_functions (list[oci.log_analytics.models.LogAnalyticsParserFunction]) – The value to assign to the parser_functions property of this LogAnalyticsParser.
sources_count (int) – The value to assign to the sources_count property of this LogAnalyticsParser.
sources (list[oci.log_analytics.models.LogAnalyticsSource]) – The value to assign to the sources property of this LogAnalyticsParser.
should_tokenize_original_text (bool) – The value to assign to the should_tokenize_original_text property of this LogAnalyticsParser.
field_delimiter (str) – The value to assign to the field_delimiter property of this LogAnalyticsParser.
field_qualifier (str) – The value to assign to the field_qualifier property of this LogAnalyticsParser.
type (str) – The value to assign to the type property of this LogAnalyticsParser. Allowed values for this property are: “XML”, “JSON”, “REGEX”, “ODL”, “DELIMITED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_user_deleted (bool) – The value to assign to the is_user_deleted property of this LogAnalyticsParser.
is_namespace_aware (bool) – The value to assign to the is_namespace_aware property of this LogAnalyticsParser.
categories (list[oci.log_analytics.models.LogAnalyticsCategory]) – The value to assign to the categories property of this LogAnalyticsParser.
is_position_aware (bool) – The value to assign to the is_position_aware property of this LogAnalyticsParser.
dependent_sources (list[oci.log_analytics.models.DependentSource]) – The value to assign to the dependent_sources property of this LogAnalyticsParser.
dependent_parsers (list[oci.log_analytics.models.DependentParser]) – The value to assign to the dependent_parsers property of this LogAnalyticsParser.

categories¶

Gets the categories of this LogAnalyticsParser. An array of categories assigned to this parser. The isSystem flag denotes if each category assignment is user-created or Oracle-defined.

Returns:	The categories of this LogAnalyticsParser.
Return type:	list[oci.log_analytics.models.LogAnalyticsCategory]

content¶

Gets the content of this LogAnalyticsParser. The content.

Returns:	The content of this LogAnalyticsParser.
Return type:	str

dependent_parsers¶

Gets the dependent_parsers of this LogAnalyticsParser. A list of sub parsers used by this parser.

Returns:	The dependent_parsers of this LogAnalyticsParser.
Return type:	list[oci.log_analytics.models.DependentParser]

dependent_sources¶

Gets the dependent_sources of this LogAnalyticsParser. A list of sources that depend on the parser, either directly or indirectly.

Returns:	The dependent_sources of this LogAnalyticsParser.
Return type:	list[oci.log_analytics.models.DependentSource]

description¶

Gets the description of this LogAnalyticsParser. The parser description.

Returns:	The description of this LogAnalyticsParser.
Return type:	str

display_name¶

Gets the display_name of this LogAnalyticsParser. The parser display name.

Returns:	The display_name of this LogAnalyticsParser.
Return type:	str

edit_version¶

Gets the edit_version of this LogAnalyticsParser. The parser edit version.

Returns:	The edit_version of this LogAnalyticsParser.
Return type:	int

encoding¶

Gets the encoding of this LogAnalyticsParser. The encoding.

Returns:	The encoding of this LogAnalyticsParser.
Return type:	str

example_content¶

Gets the example_content of this LogAnalyticsParser. The example content.

Returns:	The example_content of this LogAnalyticsParser.
Return type:	str

field_delimiter¶

Gets the field_delimiter of this LogAnalyticsParser. The parser field delimiter.

Returns:	The field_delimiter of this LogAnalyticsParser.
Return type:	str

field_maps¶

Gets the field_maps of this LogAnalyticsParser. The parser fields.

Returns:	The field_maps of this LogAnalyticsParser.
Return type:	list[oci.log_analytics.models.LogAnalyticsParserField]

field_qualifier¶

Gets the field_qualifier of this LogAnalyticsParser. The parser field qualifier.

Returns:	The field_qualifier of this LogAnalyticsParser.
Return type:	str

footer_content¶

Gets the footer_content of this LogAnalyticsParser. The footer regular expression.

Returns:	The footer_content of this LogAnalyticsParser.
Return type:	str

header_content¶

Gets the header_content of this LogAnalyticsParser. The header content.

Returns:	The header_content of this LogAnalyticsParser.
Return type:	str

is_default¶

Gets the is_default of this LogAnalyticsParser. A flag indicating if this is a default parser.

Returns:	The is_default of this LogAnalyticsParser.
Return type:	bool

is_hidden¶

Gets the is_hidden of this LogAnalyticsParser. A flag indicating if the parser is hidden or not.

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

is_namespace_aware¶

Gets the is_namespace_aware of this LogAnalyticsParser. A flag indicating whether the XML parser should consider the namespace(s) while processing the log data.

Returns:	The is_namespace_aware of this LogAnalyticsParser.
Return type:	bool

is_parser_written_once¶

Gets the is_parser_written_once of this LogAnalyticsParser. A flag indicating whther or not the parser is write once.

Returns:	The is_parser_written_once of this LogAnalyticsParser.
Return type:	bool

is_position_aware¶

Gets the is_position_aware of this LogAnalyticsParser. A flag indicating whether the parser is positionally aware.

Returns:	The is_position_aware of this LogAnalyticsParser.
Return type:	bool

is_single_line_content¶

Gets the is_single_line_content of this LogAnalyticsParser. A flag indicating if this is a single line content parser.

Returns:	The is_single_line_content of this LogAnalyticsParser.
Return type:	bool

is_system¶

Gets the is_system of this LogAnalyticsParser. The system flag. A value of false denotes a custom, or user defined object. A value of true denotes a built in object.

Returns:	The is_system of this LogAnalyticsParser.
Return type:	bool

is_user_deleted¶

Gets the is_user_deleted of this LogAnalyticsParser. A flag indicating whether or not the parser has been deleted.

Returns:	The is_user_deleted of this LogAnalyticsParser.
Return type:	bool

language¶

Gets the language of this LogAnalyticsParser. The language.

Returns:	The language of this LogAnalyticsParser.
Return type:	str

log_type_test_request_version¶

Gets the log_type_test_request_version of this LogAnalyticsParser. The log type test request .

Returns:	The log_type_test_request_version of this LogAnalyticsParser.
Return type:	int

mapped_parsers¶

Gets the mapped_parsers of this LogAnalyticsParser. The mapped parser list.

Returns:	The mapped_parsers of this LogAnalyticsParser.
Return type:	list[oci.log_analytics.models.LogAnalyticsParser]

name¶

Gets the name of this LogAnalyticsParser. The parser name.

Returns:	The name of this LogAnalyticsParser.
Return type:	str

parser_filter¶

Gets the parser_filter of this LogAnalyticsParser.

Returns:	The parser_filter of this LogAnalyticsParser.
Return type:	oci.log_analytics.models.LogAnalyticsParserFilter

parser_functions¶

Gets the parser_functions of this LogAnalyticsParser. The parser function list.

Returns:	The parser_functions of this LogAnalyticsParser.
Return type:	list[oci.log_analytics.models.LogAnalyticsParserFunction]

parser_ignoreline_characters¶

Gets the parser_ignoreline_characters of this LogAnalyticsParser. The line characters for the parser to ignore.

Returns:	The parser_ignoreline_characters of this LogAnalyticsParser.
Return type:	str

parser_sequence¶

Gets the parser_sequence of this LogAnalyticsParser. The parser sequence.

Returns:	The parser_sequence of this LogAnalyticsParser.
Return type:	int

parser_timezone¶

Gets the parser_timezone of this LogAnalyticsParser. The time zone.

Returns:	The parser_timezone of this LogAnalyticsParser.
Return type:	str

should_tokenize_original_text¶

Gets the should_tokenize_original_text of this LogAnalyticsParser. A flag indicating whether or not to tokenize the original text.

Returns:	The should_tokenize_original_text of this LogAnalyticsParser.
Return type:	bool

sources¶

Gets the sources of this LogAnalyticsParser. The list of sources using this parser.

Returns:	The sources of this LogAnalyticsParser.
Return type:	list[oci.log_analytics.models.LogAnalyticsSource]

sources_count¶

Gets the sources_count of this LogAnalyticsParser. The number of sources using this parser

Returns:	The sources_count of this LogAnalyticsParser.
Return type:	int

time_updated¶

Gets the time_updated of this LogAnalyticsParser. The last updated date.

Returns:	The time_updated of this LogAnalyticsParser.
Return type:	datetime

type¶

Gets the type of this LogAnalyticsParser. The parser type. Default value is REGEX.

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

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