AnalyticsInstanceSummary¶

class oci.analytics.models.AnalyticsInstanceSummary(**kwargs)¶

Bases: object

Analytics Instance metadata (summary view).

Attributes

`FEATURE_SET_ENTERPRISE_ANALYTICS`	A constant which can be used with the feature_set property of a AnalyticsInstanceSummary.
`FEATURE_SET_SELF_SERVICE_ANALYTICS`	A constant which can be used with the feature_set property of a AnalyticsInstanceSummary.
`LICENSE_TYPE_BRING_YOUR_OWN_LICENSE`	A constant which can be used with the license_type property of a AnalyticsInstanceSummary.
`LICENSE_TYPE_LICENSE_INCLUDED`	A constant which can be used with the license_type property of a AnalyticsInstanceSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a AnalyticsInstanceSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a AnalyticsInstanceSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a AnalyticsInstanceSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a AnalyticsInstanceSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a AnalyticsInstanceSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a AnalyticsInstanceSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a AnalyticsInstanceSummary.
`capacity`	[Required] Gets the capacity of this AnalyticsInstanceSummary.
`compartment_id`	[Required] Gets the compartment_id of this AnalyticsInstanceSummary.
`defined_tags`	Gets the defined_tags of this AnalyticsInstanceSummary.
`description`	Gets the description of this AnalyticsInstanceSummary.
`email_notification`	Gets the email_notification of this AnalyticsInstanceSummary.
`feature_set`	[Required] Gets the feature_set of this AnalyticsInstanceSummary.
`freeform_tags`	Gets the freeform_tags of this AnalyticsInstanceSummary.
`id`	[Required] Gets the id of this AnalyticsInstanceSummary.
`license_type`	Gets the license_type of this AnalyticsInstanceSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this AnalyticsInstanceSummary.
`name`	[Required] Gets the name of this AnalyticsInstanceSummary.
`network_endpoint_details`	[Required] Gets the network_endpoint_details of this AnalyticsInstanceSummary.
`service_url`	Gets the service_url of this AnalyticsInstanceSummary.
`system_tags`	Gets the system_tags of this AnalyticsInstanceSummary.
`time_created`	[Required] Gets the time_created of this AnalyticsInstanceSummary.
`time_updated`	Gets the time_updated of this AnalyticsInstanceSummary.

Methods

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

FEATURE_SET_ENTERPRISE_ANALYTICS = 'ENTERPRISE_ANALYTICS'¶: A constant which can be used with the feature_set property of a AnalyticsInstanceSummary. This constant has a value of “ENTERPRISE_ANALYTICS”

FEATURE_SET_SELF_SERVICE_ANALYTICS = 'SELF_SERVICE_ANALYTICS'¶: A constant which can be used with the feature_set property of a AnalyticsInstanceSummary. This constant has a value of “SELF_SERVICE_ANALYTICS”

LICENSE_TYPE_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'¶: A constant which can be used with the license_type property of a AnalyticsInstanceSummary. This constant has a value of “BRING_YOUR_OWN_LICENSE”

LICENSE_TYPE_LICENSE_INCLUDED = 'LICENSE_INCLUDED'¶: A constant which can be used with the license_type property of a AnalyticsInstanceSummary. This constant has a value of “LICENSE_INCLUDED”

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a AnalyticsInstanceSummary. This constant has a value of “INACTIVE”

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

__init__(**kwargs)¶

Initializes a new AnalyticsInstanceSummary 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 AnalyticsInstanceSummary.
name (str) – The value to assign to the name property of this AnalyticsInstanceSummary.
description (str) – The value to assign to the description property of this AnalyticsInstanceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this AnalyticsInstanceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AnalyticsInstanceSummary. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “INACTIVE”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
feature_set (str) – The value to assign to the feature_set property of this AnalyticsInstanceSummary. Allowed values for this property are: “SELF_SERVICE_ANALYTICS”, “ENTERPRISE_ANALYTICS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
capacity (oci.analytics.models.Capacity) – The value to assign to the capacity property of this AnalyticsInstanceSummary.
license_type (str) – The value to assign to the license_type property of this AnalyticsInstanceSummary. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
email_notification (str) – The value to assign to the email_notification property of this AnalyticsInstanceSummary.
network_endpoint_details (oci.analytics.models.NetworkEndpointDetails) – The value to assign to the network_endpoint_details property of this AnalyticsInstanceSummary.
service_url (str) – The value to assign to the service_url property of this AnalyticsInstanceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AnalyticsInstanceSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AnalyticsInstanceSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AnalyticsInstanceSummary.
time_created (datetime) – The value to assign to the time_created property of this AnalyticsInstanceSummary.
time_updated (datetime) – The value to assign to the time_updated property of this AnalyticsInstanceSummary.

capacity¶

[Required] Gets the capacity of this AnalyticsInstanceSummary.

Returns:	The capacity of this AnalyticsInstanceSummary.
Return type:	oci.analytics.models.Capacity

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this AnalyticsInstanceSummary. 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 AnalyticsInstanceSummary.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this AnalyticsInstanceSummary. Optional description.

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

email_notification¶

Gets the email_notification of this AnalyticsInstanceSummary. Email address receiving notifications.

Returns:	The email_notification of this AnalyticsInstanceSummary.
Return type:	str

feature_set¶

[Required] Gets the feature_set of this AnalyticsInstanceSummary. Analytics feature set.

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

Returns:	The feature_set of this AnalyticsInstanceSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this AnalyticsInstanceSummary. 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 AnalyticsInstanceSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this AnalyticsInstanceSummary. The resource OCID.

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

license_type¶

Gets the license_type of this AnalyticsInstanceSummary. The license used for the service.

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

Returns:	The license_type of this AnalyticsInstanceSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this AnalyticsInstanceSummary. The current state of an instance.

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

Returns:	The lifecycle_state of this AnalyticsInstanceSummary.
Return type:	str

name¶

[Required] Gets the name of this AnalyticsInstanceSummary. The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

Returns:	The name of this AnalyticsInstanceSummary.
Return type:	str

network_endpoint_details¶

[Required] Gets the network_endpoint_details of this AnalyticsInstanceSummary.

Returns:	The network_endpoint_details of this AnalyticsInstanceSummary.
Return type:	oci.analytics.models.NetworkEndpointDetails

service_url¶

Gets the service_url of this AnalyticsInstanceSummary. URL of the Analytics service.

Returns:	The service_url of this AnalyticsInstanceSummary.
Return type:	str

system_tags¶

Gets the system_tags of this AnalyticsInstanceSummary. System tags for this resource. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“key”: “value”}}

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

time_created¶

[Required] Gets the time_created of this AnalyticsInstanceSummary. The date and time the instance was created, in the format defined by RFC3339.

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

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

time_updated¶

Gets the time_updated of this AnalyticsInstanceSummary. The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.

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