SpanFilter¶

class oci.apm_config.models.SpanFilter(**kwargs)¶

Bases: oci.apm_config.models.config.Config

A named setting that specifies the filter criteria to match a subset of the spans.

Attributes

`CONFIG_TYPE_APDEX`	str(object=’’) -> str
`CONFIG_TYPE_METRIC_GROUP`	str(object=’’) -> str
`CONFIG_TYPE_OPTIONS`	str(object=’’) -> str
`CONFIG_TYPE_SPAN_FILTER`	str(object=’’) -> str
`config_type`	[Required] Gets the config_type of this Config.
`created_by`	Gets the created_by of this Config.
`defined_tags`	Gets the defined_tags of this Config.
`description`	Gets the description of this SpanFilter.
`display_name`	Gets the display_name of this SpanFilter.
`etag`	Gets the etag of this Config.
`filter_text`	Gets the filter_text of this SpanFilter.
`freeform_tags`	Gets the freeform_tags of this Config.
`id`	Gets the id of this Config.
`in_use_by`	Gets the in_use_by of this SpanFilter.
`time_created`	Gets the time_created of this Config.
`time_updated`	Gets the time_updated of this Config.
`updated_by`	Gets the updated_by of this Config.

Methods

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

CONFIG_TYPE_APDEX = 'APDEX'¶

CONFIG_TYPE_METRIC_GROUP = 'METRIC_GROUP'¶

CONFIG_TYPE_OPTIONS = 'OPTIONS'¶

CONFIG_TYPE_SPAN_FILTER = 'SPAN_FILTER'¶

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this SpanFilter.
config_type (str) – The value to assign to the config_type property of this SpanFilter. Allowed values for this property are: “SPAN_FILTER”, “METRIC_GROUP”, “APDEX”, “OPTIONS”
time_created (datetime) – The value to assign to the time_created property of this SpanFilter.
time_updated (datetime) – The value to assign to the time_updated property of this SpanFilter.
created_by (str) – The value to assign to the created_by property of this SpanFilter.
updated_by (str) – The value to assign to the updated_by property of this SpanFilter.
etag (str) – The value to assign to the etag property of this SpanFilter.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SpanFilter.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SpanFilter.
display_name (str) – The value to assign to the display_name property of this SpanFilter.
filter_text (str) – The value to assign to the filter_text property of this SpanFilter.
in_use_by (list[oci.apm_config.models.SpanFilterReference]) – The value to assign to the in_use_by property of this SpanFilter.
description (str) – The value to assign to the description property of this SpanFilter.

config_type¶

[Required] Gets the config_type of this Config. The type of configuration item.

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

Returns:	The config_type of this Config.
Return type:	str

created_by¶

Gets the created_by of this Config. The OCID of a user.

Returns:	The created_by of this Config.
Return type:	str

defined_tags¶

Gets the defined_tags of this Config. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this Config.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this SpanFilter. An optional string that describes what the span filter is intended or used for.

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

display_name¶

Gets the display_name of this SpanFilter. The name by which a configuration entity is displayed to the end user.

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

etag¶

Gets the etag of this Config. For optimistic concurrency control. See if-match.

Returns:	The etag of this Config.
Return type:	str

filter_text¶

Gets the filter_text of this SpanFilter. The string that defines the Span Filter expression.

Returns:	The filter_text of this SpanFilter.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this Config. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this Config.
Return type:	dict(str, 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.

id¶

Gets the id of this Config. The OCID of the configuration item. An OCID is generated when the item is created.

Returns:	The id of this Config.
Return type:	str

in_use_by¶

Gets the in_use_by of this SpanFilter. The list of configuration items that reference the span filter.

Returns:	The in_use_by of this SpanFilter.
Return type:	list[oci.apm_config.models.SpanFilterReference]

time_created¶

Gets the time_created of this Config. The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

Returns:	The time_created of this Config.
Return type:	datetime

time_updated¶

Gets the time_updated of this Config. The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

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

updated_by¶

Gets the updated_by of this Config. The OCID of a user.

Returns:	The updated_by of this Config.
Return type:	str