AnalyticsInstance¶

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

Bases: object

Analytics Instance metadata.

Attributes

`FEATURE_BUNDLE_EE_EMBEDDED`	A constant which can be used with the feature_bundle property of a AnalyticsInstance.
`FEATURE_BUNDLE_FAW_FREE`	A constant which can be used with the feature_bundle property of a AnalyticsInstance.
`FEATURE_BUNDLE_FAW_PAID`	A constant which can be used with the feature_bundle property of a AnalyticsInstance.
`FEATURE_BUNDLE_SE_EMBEDDED`	A constant which can be used with the feature_bundle property of a AnalyticsInstance.
`FEATURE_SET_ENTERPRISE_ANALYTICS`	A constant which can be used with the feature_set property of a AnalyticsInstance.
`FEATURE_SET_SELF_SERVICE_ANALYTICS`	A constant which can be used with the feature_set property of a AnalyticsInstance.
`LICENSE_TYPE_BRING_YOUR_OWN_LICENSE`	A constant which can be used with the license_type property of a AnalyticsInstance.
`LICENSE_TYPE_LICENSE_INCLUDED`	A constant which can be used with the license_type property of a AnalyticsInstance.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a AnalyticsInstance.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a AnalyticsInstance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a AnalyticsInstance.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a AnalyticsInstance.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a AnalyticsInstance.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a AnalyticsInstance.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a AnalyticsInstance.
`UPDATE_CHANNEL_EARLY`	A constant which can be used with the update_channel property of a AnalyticsInstance.
`UPDATE_CHANNEL_PHASE_1`	A constant which can be used with the update_channel property of a AnalyticsInstance.
`UPDATE_CHANNEL_PHASE_2`	A constant which can be used with the update_channel property of a AnalyticsInstance.
`UPDATE_CHANNEL_REGULAR`	A constant which can be used with the update_channel property of a AnalyticsInstance.
`capacity`	[Required] Gets the capacity of this AnalyticsInstance.
`compartment_id`	[Required] Gets the compartment_id of this AnalyticsInstance.
`defined_tags`	Gets the defined_tags of this AnalyticsInstance.
`description`	Gets the description of this AnalyticsInstance.
`domain_id`	Gets the domain_id of this AnalyticsInstance.
`email_notification`	Gets the email_notification of this AnalyticsInstance.
`feature_bundle`	Gets the feature_bundle of this AnalyticsInstance.
`feature_set`	[Required] Gets the feature_set of this AnalyticsInstance.
`freeform_tags`	Gets the freeform_tags of this AnalyticsInstance.
`id`	[Required] Gets the id of this AnalyticsInstance.
`kms_key_id`	Gets the kms_key_id of this AnalyticsInstance.
`license_type`	Gets the license_type of this AnalyticsInstance.
`lifecycle_state`	[Required] Gets the lifecycle_state of this AnalyticsInstance.
`name`	[Required] Gets the name of this AnalyticsInstance.
`network_endpoint_details`	[Required] Gets the network_endpoint_details of this AnalyticsInstance.
`private_access_channels`	Gets the private_access_channels of this AnalyticsInstance.
`service_url`	Gets the service_url of this AnalyticsInstance.
`system_tags`	Gets the system_tags of this AnalyticsInstance.
`time_created`	[Required] Gets the time_created of this AnalyticsInstance.
`time_updated`	Gets the time_updated of this AnalyticsInstance.
`update_channel`	Gets the update_channel of this AnalyticsInstance.
`vanity_url_details`	Gets the vanity_url_details of this AnalyticsInstance.

Methods

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

FEATURE_BUNDLE_EE_EMBEDDED = 'EE_EMBEDDED'¶: A constant which can be used with the feature_bundle property of a AnalyticsInstance. This constant has a value of “EE_EMBEDDED”

FEATURE_BUNDLE_FAW_FREE = 'FAW_FREE'¶: A constant which can be used with the feature_bundle property of a AnalyticsInstance. This constant has a value of “FAW_FREE”

FEATURE_BUNDLE_FAW_PAID = 'FAW_PAID'¶: A constant which can be used with the feature_bundle property of a AnalyticsInstance. This constant has a value of “FAW_PAID”

FEATURE_BUNDLE_SE_EMBEDDED = 'SE_EMBEDDED'¶: A constant which can be used with the feature_bundle property of a AnalyticsInstance. This constant has a value of “SE_EMBEDDED”

FEATURE_SET_ENTERPRISE_ANALYTICS = 'ENTERPRISE_ANALYTICS'¶: A constant which can be used with the feature_set property of a AnalyticsInstance. 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 AnalyticsInstance. 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 AnalyticsInstance. 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 AnalyticsInstance. 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 AnalyticsInstance. This constant has a value of “ACTIVE”

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

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

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

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

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

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

UPDATE_CHANNEL_EARLY = 'EARLY'¶: A constant which can be used with the update_channel property of a AnalyticsInstance. This constant has a value of “EARLY”

UPDATE_CHANNEL_PHASE_1 = 'PHASE_1'¶: A constant which can be used with the update_channel property of a AnalyticsInstance. This constant has a value of “PHASE_1”

UPDATE_CHANNEL_PHASE_2 = 'PHASE_2'¶: A constant which can be used with the update_channel property of a AnalyticsInstance. This constant has a value of “PHASE_2”

UPDATE_CHANNEL_REGULAR = 'REGULAR'¶: A constant which can be used with the update_channel property of a AnalyticsInstance. This constant has a value of “REGULAR”

__init__(**kwargs)¶

Initializes a new AnalyticsInstance 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 AnalyticsInstance.
name (str) – The value to assign to the name property of this AnalyticsInstance.
description (str) – The value to assign to the description property of this AnalyticsInstance.
compartment_id (str) – The value to assign to the compartment_id property of this AnalyticsInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AnalyticsInstance. 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 AnalyticsInstance. 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 AnalyticsInstance.
license_type (str) – The value to assign to the license_type property of this AnalyticsInstance. 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 AnalyticsInstance.
update_channel (str) – The value to assign to the update_channel property of this AnalyticsInstance. Allowed values for this property are: “REGULAR”, “EARLY”, “PHASE_2”, “PHASE_1”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
network_endpoint_details (oci.analytics.models.NetworkEndpointDetails) – The value to assign to the network_endpoint_details property of this AnalyticsInstance.
private_access_channels (dict(str, PrivateAccessChannel)) – The value to assign to the private_access_channels property of this AnalyticsInstance.
vanity_url_details (dict(str, VanityUrlDetails)) – The value to assign to the vanity_url_details property of this AnalyticsInstance.
service_url (str) – The value to assign to the service_url property of this AnalyticsInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AnalyticsInstance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AnalyticsInstance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AnalyticsInstance.
kms_key_id (str) – The value to assign to the kms_key_id property of this AnalyticsInstance.
time_created (datetime) – The value to assign to the time_created property of this AnalyticsInstance.
time_updated (datetime) – The value to assign to the time_updated property of this AnalyticsInstance.
feature_bundle (str) – The value to assign to the feature_bundle property of this AnalyticsInstance. Allowed values for this property are: “FAW_PAID”, “FAW_FREE”, “EE_EMBEDDED”, “SE_EMBEDDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
domain_id (str) – The value to assign to the domain_id property of this AnalyticsInstance.

capacity¶

[Required] Gets the capacity of this AnalyticsInstance.

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

compartment_id¶

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

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

defined_tags¶

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

description¶

Gets the description of this AnalyticsInstance. Optional description.

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

domain_id¶

Gets the domain_id of this AnalyticsInstance. Identity domain OCID.

Returns:	The domain_id of this AnalyticsInstance.
Return type:	str

email_notification¶

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

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

feature_bundle¶

Gets the feature_bundle of this AnalyticsInstance. The feature set of an Analytics instance.

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

Returns:	The feature_bundle of this AnalyticsInstance.
Return type:	str

feature_set¶

[Required] Gets the feature_set of this AnalyticsInstance. 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 AnalyticsInstance.
Return type:	str

freeform_tags¶

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

id¶

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

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

kms_key_id¶

Gets the kms_key_id of this AnalyticsInstance. OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.

Returns:	The kms_key_id of this AnalyticsInstance.
Return type:	str

license_type¶

Gets the license_type of this AnalyticsInstance. 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 AnalyticsInstance.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this AnalyticsInstance. 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 AnalyticsInstance.
Return type:	str

name¶

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

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

network_endpoint_details¶

[Required] Gets the network_endpoint_details of this AnalyticsInstance.

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

private_access_channels¶

Gets the private_access_channels of this AnalyticsInstance. Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.

Returns:	The private_access_channels of this AnalyticsInstance.
Return type:	dict(str, PrivateAccessChannel)

service_url¶

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

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

system_tags¶

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

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

time_created¶

[Required] Gets the time_created of this AnalyticsInstance. 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 AnalyticsInstance.
Return type:	datetime

time_updated¶

Gets the time_updated of this AnalyticsInstance. 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 AnalyticsInstance.
Return type:	datetime

update_channel¶

Gets the update_channel of this AnalyticsInstance. Analytics instance update channel.

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

Returns:	The update_channel of this AnalyticsInstance.
Return type:	str

vanity_url_details¶

Gets the vanity_url_details of this AnalyticsInstance. Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.

Returns:	The vanity_url_details of this AnalyticsInstance.
Return type:	dict(str, VanityUrlDetails)