CreateMacsApmExtensionDetails

class oci.apm_config.models.CreateMacsApmExtensionDetails(**kwargs)

Bases: CreateConfigDetails

An object that represents APM Agent provisioning via a Management Agent.

Attributes:

CONFIG_TYPE_AGENT

A constant which can be used with the config_type property of a CreateConfigDetails.

CONFIG_TYPE_APDEX

A constant which can be used with the config_type property of a CreateConfigDetails.

CONFIG_TYPE_MACS_APM_EXTENSION

A constant which can be used with the config_type property of a CreateConfigDetails.

CONFIG_TYPE_METRIC_GROUP

A constant which can be used with the config_type property of a CreateConfigDetails.

CONFIG_TYPE_OPTIONS

A constant which can be used with the config_type property of a CreateConfigDetails.

CONFIG_TYPE_SPAN_FILTER

A constant which can be used with the config_type property of a CreateConfigDetails.

agent_version

[Required] Gets the agent_version of this CreateMacsApmExtensionDetails.

attach_install_dir

[Required] Gets the attach_install_dir of this CreateMacsApmExtensionDetails.

config_type

[Required] Gets the config_type of this CreateConfigDetails.

defined_tags

Gets the defined_tags of this CreateConfigDetails.

display_name

Gets the display_name of this CreateMacsApmExtensionDetails.

freeform_tags

Gets the freeform_tags of this CreateConfigDetails.

management_agent_id

[Required] Gets the management_agent_id of this CreateMacsApmExtensionDetails.

process_filter

[Required] Gets the process_filter of this CreateMacsApmExtensionDetails.

run_as_user

[Required] Gets the run_as_user of this CreateMacsApmExtensionDetails.

service_name

[Required] Gets the service_name of this CreateMacsApmExtensionDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateMacsApmExtensionDetails 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'

A constant which can be used with the config_type property of a CreateConfigDetails. This constant has a value of “AGENT”

CONFIG_TYPE_APDEX = 'APDEX'

A constant which can be used with the config_type property of a CreateConfigDetails. This constant has a value of “APDEX”

CONFIG_TYPE_MACS_APM_EXTENSION = 'MACS_APM_EXTENSION'

A constant which can be used with the config_type property of a CreateConfigDetails. This constant has a value of “MACS_APM_EXTENSION”

CONFIG_TYPE_METRIC_GROUP = 'METRIC_GROUP'

A constant which can be used with the config_type property of a CreateConfigDetails. This constant has a value of “METRIC_GROUP”

CONFIG_TYPE_OPTIONS = 'OPTIONS'

A constant which can be used with the config_type property of a CreateConfigDetails. This constant has a value of “OPTIONS”

CONFIG_TYPE_SPAN_FILTER = 'SPAN_FILTER'

A constant which can be used with the config_type property of a CreateConfigDetails. This constant has a value of “SPAN_FILTER”

__init__(**kwargs)

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

Parameters
  • config_type (str) – The value to assign to the config_type property of this CreateMacsApmExtensionDetails. Allowed values for this property are: “SPAN_FILTER”, “METRIC_GROUP”, “APDEX”, “OPTIONS”, “AGENT”, “MACS_APM_EXTENSION”

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateMacsApmExtensionDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateMacsApmExtensionDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateMacsApmExtensionDetails.

  • management_agent_id (str) – The value to assign to the management_agent_id property of this CreateMacsApmExtensionDetails.

  • process_filter (list[str]) – The value to assign to the process_filter property of this CreateMacsApmExtensionDetails.

  • run_as_user (str) – The value to assign to the run_as_user property of this CreateMacsApmExtensionDetails.

  • service_name (str) – The value to assign to the service_name property of this CreateMacsApmExtensionDetails.

  • agent_version (str) – The value to assign to the agent_version property of this CreateMacsApmExtensionDetails.

  • attach_install_dir (str) – The value to assign to the attach_install_dir property of this CreateMacsApmExtensionDetails.

property agent_version

[Required] Gets the agent_version of this CreateMacsApmExtensionDetails. The version of the referenced agent bundle.

Returns

The agent_version of this CreateMacsApmExtensionDetails.

Return type

str

property attach_install_dir

[Required] Gets the attach_install_dir of this CreateMacsApmExtensionDetails. The directory owned by runAsUser.

Returns

The attach_install_dir of this CreateMacsApmExtensionDetails.

Return type

str

property config_type

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

Allowed values for this property are: “SPAN_FILTER”, “METRIC_GROUP”, “APDEX”, “OPTIONS”, “AGENT”, “MACS_APM_EXTENSION”

Returns

The config_type of this CreateConfigDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateConfigDetails. 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 CreateConfigDetails.

Return type

dict(str, dict(str, object))

property display_name

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

Returns

The display_name of this CreateMacsApmExtensionDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateConfigDetails. 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 CreateConfigDetails.

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.

property management_agent_id

[Required] Gets the management_agent_id of this CreateMacsApmExtensionDetails. The OCID of the Management Agent that will provision the APM Agent.

Returns

The management_agent_id of this CreateMacsApmExtensionDetails.

Return type

str

property process_filter

[Required] Gets the process_filter of this CreateMacsApmExtensionDetails. Filter patterns used to discover active Java processes for provisioning the APM Agent.

Returns

The process_filter of this CreateMacsApmExtensionDetails.

Return type

list[str]

property run_as_user

[Required] Gets the run_as_user of this CreateMacsApmExtensionDetails. The OS user that should be used to discover Java processes.

Returns

The run_as_user of this CreateMacsApmExtensionDetails.

Return type

str

property service_name

[Required] Gets the service_name of this CreateMacsApmExtensionDetails. The name of the service being monitored. This argument enables you to filter by service and view traces and other signals in the APM Explorer user interface.

Returns

The service_name of this CreateMacsApmExtensionDetails.

Return type

str