ApmDomain

class oci.apm_control_plane.models.ApmDomain(**kwargs)

Bases: object

Details of an APM domain.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a ApmDomain.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a ApmDomain.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a ApmDomain.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a ApmDomain.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a ApmDomain.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a ApmDomain.

compartment_id

[Required] Gets the compartment_id of this ApmDomain.

data_upload_endpoint

Gets the data_upload_endpoint of this ApmDomain.

defined_tags

Gets the defined_tags of this ApmDomain.

description

Gets the description of this ApmDomain.

display_name

[Required] Gets the display_name of this ApmDomain.

freeform_tags

Gets the freeform_tags of this ApmDomain.

id

[Required] Gets the id of this ApmDomain.

is_free_tier

Gets the is_free_tier of this ApmDomain.

lifecycle_state

Gets the lifecycle_state of this ApmDomain.

log_group_id

Gets the log_group_id of this ApmDomain.

time_created

Gets the time_created of this ApmDomain.

time_updated

Gets the time_updated of this ApmDomain.

Methods:

__init__(**kwargs)

Initializes a new ApmDomain object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ApmDomain. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a ApmDomain. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a ApmDomain. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a ApmDomain. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a ApmDomain. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a ApmDomain. This constant has a value of “UPDATING”

__init__(**kwargs)

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

Parameters
  • data_upload_endpoint (str) – The value to assign to the data_upload_endpoint property of this ApmDomain.

  • id (str) – The value to assign to the id property of this ApmDomain.

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

  • description (str) – The value to assign to the description property of this ApmDomain.

  • compartment_id (str) – The value to assign to the compartment_id property of this ApmDomain.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ApmDomain. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • is_free_tier (bool) – The value to assign to the is_free_tier property of this ApmDomain.

  • log_group_id (str) – The value to assign to the log_group_id property of this ApmDomain.

  • time_created (datetime) – The value to assign to the time_created property of this ApmDomain.

  • time_updated (datetime) – The value to assign to the time_updated property of this ApmDomain.

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

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

property compartment_id

[Required] Gets the compartment_id of this ApmDomain. The OCID of the compartment corresponding to the APM domain.

Returns

The compartment_id of this ApmDomain.

Return type

str

property data_upload_endpoint

Gets the data_upload_endpoint of this ApmDomain. The endpoint where the APM agents upload their observations and metrics.

Returns

The data_upload_endpoint of this ApmDomain.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this ApmDomain. Description of the APM domain.

Returns

The description of this ApmDomain.

Return type

str

property display_name

[Required] Gets the display_name of this ApmDomain. Display name of the APM domain, which can be updated.

Returns

The display_name of this ApmDomain.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this ApmDomain. Unique identifier that is immutable on creation.

Returns

The id of this ApmDomain.

Return type

str

property is_free_tier

Gets the is_free_tier of this ApmDomain. Indicates if this is an Always Free resource.

Returns

The is_free_tier of this ApmDomain.

Return type

bool

property lifecycle_state

Gets the lifecycle_state of this ApmDomain. The current lifecycle state of the APM domain.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this ApmDomain.

Return type

str

property log_group_id

Gets the log_group_id of this ApmDomain. The OCID of the Log Analytics log group to which the data uploaded to this APM domain will be mapped to.

Returns

The log_group_id of this ApmDomain.

Return type

str

property time_created

Gets the time_created of this ApmDomain. The time the APM domain was created, expressed in RFC 3339 timestamp format.

Returns

The time_created of this ApmDomain.

Return type

datetime

property time_updated

Gets the time_updated of this ApmDomain. The time the APM domain was updated, expressed in RFC 3339 timestamp format.

Returns

The time_updated of this ApmDomain.

Return type

datetime