AgentConfig¶

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

Bases: oci.apm_config.models.config.Config

Agent configuration for any Agent complying with the OpAMP specification.

Attributes

`CONFIG_TYPE_AGENT`	str(object=’’) -> str
`CONFIG_TYPE_APDEX`	str(object=’’) -> str
`CONFIG_TYPE_MACS_APM_EXTENSION`	str(object=’’) -> str
`CONFIG_TYPE_METRIC_GROUP`	str(object=’’) -> str
`CONFIG_TYPE_OPTIONS`	str(object=’’) -> str
`CONFIG_TYPE_SPAN_FILTER`	str(object=’’) -> str
`config`	Gets the config of this AgentConfig.
`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.
`etag`	Gets the etag of this Config.
`freeform_tags`	Gets the freeform_tags of this Config.
`id`	Gets the id of this Config.
`match_agents_with_attribute_key`	Gets the match_agents_with_attribute_key of this AgentConfig.
`match_agents_with_attribute_value`	Gets the match_agents_with_attribute_value of this AgentConfig.
`overrides`	Gets the overrides of this AgentConfig.
`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 AgentConfig 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_AGENT = 'AGENT'¶

CONFIG_TYPE_APDEX = 'APDEX'¶

CONFIG_TYPE_MACS_APM_EXTENSION = 'MACS_APM_EXTENSION'¶

CONFIG_TYPE_METRIC_GROUP = 'METRIC_GROUP'¶

CONFIG_TYPE_OPTIONS = 'OPTIONS'¶

CONFIG_TYPE_SPAN_FILTER = 'SPAN_FILTER'¶

__init__(**kwargs)¶

Initializes a new AgentConfig object with values from keyword arguments. The default value of the config_type attribute of this class is AGENT 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 AgentConfig.
config_type (str) – The value to assign to the config_type property of this AgentConfig. Allowed values for this property are: “SPAN_FILTER”, “METRIC_GROUP”, “APDEX”, “OPTIONS”, “AGENT”, “MACS_APM_EXTENSION”
time_created (datetime) – The value to assign to the time_created property of this AgentConfig.
time_updated (datetime) – The value to assign to the time_updated property of this AgentConfig.
created_by (str) – The value to assign to the created_by property of this AgentConfig.
updated_by (str) – The value to assign to the updated_by property of this AgentConfig.
etag (str) – The value to assign to the etag property of this AgentConfig.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AgentConfig.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AgentConfig.
match_agents_with_attribute_key (list[str]) – The value to assign to the match_agents_with_attribute_key property of this AgentConfig.
match_agents_with_attribute_value (str) – The value to assign to the match_agents_with_attribute_value property of this AgentConfig.
config (oci.apm_config.models.AgentConfigMap) – The value to assign to the config property of this AgentConfig.
overrides (oci.apm_config.models.AgentConfigOverrides) – The value to assign to the overrides property of this AgentConfig.

config¶

Gets the config of this AgentConfig.

Returns:	The config of this AgentConfig.
Return type:	oci.apm_config.models.AgentConfigMap

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”, “AGENT”, “MACS_APM_EXTENSION”, ‘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))

etag¶

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

Returns:	The etag of this Config.
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

match_agents_with_attribute_key¶

Gets the match_agents_with_attribute_key of this AgentConfig. The agent attribute KEY by which an Agent configuration is matched to an agent. All agent configuration objects share the same key. It is [ServiceName, service.name] by default. The attribute VALUE corresponding to this KEY is in the matchAgentsWithAttributeValue field.

Returns:	The match_agents_with_attribute_key of this AgentConfig.
Return type:	list[str]

match_agents_with_attribute_value¶

Gets the match_agents_with_attribute_value of this AgentConfig. The agent attribute VALUE by which an agent configuration is matched to an agent. Each agent configuration object must specify a different value. The attribute KEY corresponding to this VALUE is in the matchAgentsWithAttributeKey field.

Returns:	The match_agents_with_attribute_value of this AgentConfig.
Return type:	str

overrides¶

Gets the overrides of this AgentConfig.

Returns:	The overrides of this AgentConfig.
Return type:	oci.apm_config.models.AgentConfigOverrides

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