UnifiedAgentLoggingRecordTransformerFilter¶

class oci.logging.models.UnifiedAgentLoggingRecordTransformerFilter(**kwargs)¶

Bases: oci.logging.models.unified_agent_logging_filter.UnifiedAgentLoggingFilter

Logging record transformer filter object mutates/transforms logs. Ref: https://docs.fluentd.org/filter/record_transformer

Attributes

`FILTER_TYPE_CUSTOM_FILTER`	str(object=’’) -> str
`FILTER_TYPE_GREP_FILTER`	str(object=’’) -> str
`FILTER_TYPE_PARSER_FILTER`	str(object=’’) -> str
`FILTER_TYPE_RECORD_TRANSFORMER_FILTER`	str(object=’’) -> str
`filter_type`	[Required] Gets the filter_type of this UnifiedAgentLoggingFilter.
`is_auto_typecast_enabled`	Gets the is_auto_typecast_enabled of this UnifiedAgentLoggingRecordTransformerFilter.
`is_renew_record_enabled`	Gets the is_renew_record_enabled of this UnifiedAgentLoggingRecordTransformerFilter.
`is_ruby_enabled`	Gets the is_ruby_enabled of this UnifiedAgentLoggingRecordTransformerFilter.
`keep_keys`	Gets the keep_keys of this UnifiedAgentLoggingRecordTransformerFilter.
`name`	[Required] Gets the name of this UnifiedAgentLoggingFilter.
`record_list`	[Required] Gets the record_list of this UnifiedAgentLoggingRecordTransformerFilter.
`remove_keys`	Gets the remove_keys of this UnifiedAgentLoggingRecordTransformerFilter.
`renew_time_key`	Gets the renew_time_key of this UnifiedAgentLoggingRecordTransformerFilter.

Methods

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

FILTER_TYPE_CUSTOM_FILTER = 'CUSTOM_FILTER'¶

FILTER_TYPE_GREP_FILTER = 'GREP_FILTER'¶

FILTER_TYPE_PARSER_FILTER = 'PARSER_FILTER'¶

FILTER_TYPE_RECORD_TRANSFORMER_FILTER = 'RECORD_TRANSFORMER_FILTER'¶

__init__(**kwargs)¶

Initializes a new UnifiedAgentLoggingRecordTransformerFilter object with values from keyword arguments. The default value of the filter_type attribute of this class is RECORD_TRANSFORMER_FILTER and it should not be changed. 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 UnifiedAgentLoggingRecordTransformerFilter.
filter_type (str) – The value to assign to the filter_type property of this UnifiedAgentLoggingRecordTransformerFilter. Allowed values for this property are: “PARSER_FILTER”, “GREP_FILTER”, “RECORD_TRANSFORMER_FILTER”, “CUSTOM_FILTER”
record_list (list[oci.logging.models.RecordTransformerPair]) – The value to assign to the record_list property of this UnifiedAgentLoggingRecordTransformerFilter.
is_ruby_enabled (bool) – The value to assign to the is_ruby_enabled property of this UnifiedAgentLoggingRecordTransformerFilter.
is_auto_typecast_enabled (bool) – The value to assign to the is_auto_typecast_enabled property of this UnifiedAgentLoggingRecordTransformerFilter.
is_renew_record_enabled (bool) – The value to assign to the is_renew_record_enabled property of this UnifiedAgentLoggingRecordTransformerFilter.
renew_time_key (str) – The value to assign to the renew_time_key property of this UnifiedAgentLoggingRecordTransformerFilter.
keep_keys (list[str]) – The value to assign to the keep_keys property of this UnifiedAgentLoggingRecordTransformerFilter.
remove_keys (list[str]) – The value to assign to the remove_keys property of this UnifiedAgentLoggingRecordTransformerFilter.

filter_type¶

[Required] Gets the filter_type of this UnifiedAgentLoggingFilter. Unified schema logging filter type.

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

Returns:	The filter_type of this UnifiedAgentLoggingFilter.
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.

is_auto_typecast_enabled¶

Gets the is_auto_typecast_enabled of this UnifiedAgentLoggingRecordTransformerFilter. If true, automatically casts the field types.

Returns:	The is_auto_typecast_enabled of this UnifiedAgentLoggingRecordTransformerFilter.
Return type:	bool

is_renew_record_enabled¶

Gets the is_renew_record_enabled of this UnifiedAgentLoggingRecordTransformerFilter. If true, it modifies a new empty hash

Returns:	The is_renew_record_enabled of this UnifiedAgentLoggingRecordTransformerFilter.
Return type:	bool

is_ruby_enabled¶

Gets the is_ruby_enabled of this UnifiedAgentLoggingRecordTransformerFilter. When set to true, the full Ruby syntax is enabled in the ${} expression.

Returns:	The is_ruby_enabled of this UnifiedAgentLoggingRecordTransformerFilter.
Return type:	bool

keep_keys¶

Gets the keep_keys of this UnifiedAgentLoggingRecordTransformerFilter. A list of keys to keep. Only relevant if isRenewRecordEnabled is set to true

Returns:	The keep_keys of this UnifiedAgentLoggingRecordTransformerFilter.
Return type:	list[str]

name¶

[Required] Gets the name of this UnifiedAgentLoggingFilter. Unique name for the filter.

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

record_list¶

[Required] Gets the record_list of this UnifiedAgentLoggingRecordTransformerFilter. Add new key-value pairs in logs

Returns:	The record_list of this UnifiedAgentLoggingRecordTransformerFilter.
Return type:	list[oci.logging.models.RecordTransformerPair]

remove_keys¶

Gets the remove_keys of this UnifiedAgentLoggingRecordTransformerFilter. A list of keys to delete

Returns:	The remove_keys of this UnifiedAgentLoggingRecordTransformerFilter.
Return type:	list[str]

renew_time_key¶

Gets the renew_time_key of this UnifiedAgentLoggingRecordTransformerFilter. Overwrites the time of logs with this value, this value must be a Unix timestamp.

Returns:	The renew_time_key of this UnifiedAgentLoggingRecordTransformerFilter.
Return type:	str