ResourceAnalyticsInstance¶

class oci.resource_analytics.models.ResourceAnalyticsInstance(**kwargs)¶

Bases: object

A ResourceAnalyticsInstance is an ADW housing analytics for all of a customers’ OCI resources.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance.
`adw_id`	Gets the adw_id of this ResourceAnalyticsInstance.
`compartment_id`	[Required] Gets the compartment_id of this ResourceAnalyticsInstance.
`defined_tags`	[Required] Gets the defined_tags of this ResourceAnalyticsInstance.
`description`	Gets the description of this ResourceAnalyticsInstance.
`display_name`	[Required] Gets the display_name of this ResourceAnalyticsInstance.
`freeform_tags`	[Required] Gets the freeform_tags of this ResourceAnalyticsInstance.
`id`	[Required] Gets the id of this ResourceAnalyticsInstance.
`lifecycle_details`	Gets the lifecycle_details of this ResourceAnalyticsInstance.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ResourceAnalyticsInstance.
`oac_id`	Gets the oac_id of this ResourceAnalyticsInstance.
`system_tags`	Gets the system_tags of this ResourceAnalyticsInstance.
`time_created`	[Required] Gets the time_created of this ResourceAnalyticsInstance.
`time_updated`	Gets the time_updated of this ResourceAnalyticsInstance.

Methods

__init__(**kwargs) Initializes a new ResourceAnalyticsInstance object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ResourceAnalyticsInstance. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ResourceAnalyticsInstance object with values from keyword arguments. 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 ResourceAnalyticsInstance.
display_name (str) – The value to assign to the display_name property of this ResourceAnalyticsInstance.
compartment_id (str) – The value to assign to the compartment_id property of this ResourceAnalyticsInstance.
description (str) – The value to assign to the description property of this ResourceAnalyticsInstance.
adw_id (str) – The value to assign to the adw_id property of this ResourceAnalyticsInstance.
oac_id (str) – The value to assign to the oac_id property of this ResourceAnalyticsInstance.
time_created (datetime) – The value to assign to the time_created property of this ResourceAnalyticsInstance.
time_updated (datetime) – The value to assign to the time_updated property of this ResourceAnalyticsInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ResourceAnalyticsInstance. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ResourceAnalyticsInstance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ResourceAnalyticsInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ResourceAnalyticsInstance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ResourceAnalyticsInstance.

adw_id¶

Gets the adw_id of this ResourceAnalyticsInstance. The OCID of the created ADW instance.

Returns:	The adw_id of this ResourceAnalyticsInstance.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ResourceAnalyticsInstance. The OCID of the compartment.

Returns:	The compartment_id of this ResourceAnalyticsInstance.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this ResourceAnalyticsInstance. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

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

description¶

Gets the description of this ResourceAnalyticsInstance. A description of the ResourceAnalyticsInstance instance.

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

display_name¶

[Required] Gets the display_name of this ResourceAnalyticsInstance. A user-friendly name. Does not have to be unique, and it’s changeable.

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

freeform_tags¶

[Required] Gets the freeform_tags of this ResourceAnalyticsInstance. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this ResourceAnalyticsInstance.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ResourceAnalyticsInstance. The OCID of the ResourceAnalyticsInstance.

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

lifecycle_details¶

Gets the lifecycle_details of this ResourceAnalyticsInstance. A message that describes the current state of the ResourceAnalyticsInstance in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this ResourceAnalyticsInstance.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ResourceAnalyticsInstance. The current state of the ResourceAnalyticsInstance.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “NEEDS_ATTENTION”, “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 ResourceAnalyticsInstance.
Return type:	str

oac_id¶

Gets the oac_id of this ResourceAnalyticsInstance. The OCID of the OAC enabled for the ResourceAnalyticsInstance.

Returns:	The oac_id of this ResourceAnalyticsInstance.
Return type:	str

system_tags¶

Gets the system_tags of this ResourceAnalyticsInstance. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ResourceAnalyticsInstance.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this ResourceAnalyticsInstance. The date and time the ResourceAnalyticsInstance was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

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

time_updated¶

Gets the time_updated of this ResourceAnalyticsInstance. The date and time the ResourceAnalyticsInstance was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

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