OceInstanceSummary¶

class oci.oce.models.OceInstanceSummary(**kwargs)¶

Bases: object

Summary of the OceInstance.

Attributes

`INSTANCE_ACCESS_TYPE_PRIVATE`	A constant which can be used with the instance_access_type property of a OceInstanceSummary.
`INSTANCE_ACCESS_TYPE_PUBLIC`	A constant which can be used with the instance_access_type property of a OceInstanceSummary.
`INSTANCE_LICENSE_TYPE_BYOL`	A constant which can be used with the instance_license_type property of a OceInstanceSummary.
`INSTANCE_LICENSE_TYPE_NEW`	A constant which can be used with the instance_license_type property of a OceInstanceSummary.
`INSTANCE_LICENSE_TYPE_PREMIUM`	A constant which can be used with the instance_license_type property of a OceInstanceSummary.
`INSTANCE_LICENSE_TYPE_STARTER`	A constant which can be used with the instance_license_type property of a OceInstanceSummary.
`INSTANCE_USAGE_TYPE_NONPRIMARY`	A constant which can be used with the instance_usage_type property of a OceInstanceSummary.
`INSTANCE_USAGE_TYPE_PRIMARY`	A constant which can be used with the instance_usage_type property of a OceInstanceSummary.
`LIFECYCLE_DETAILS_DOWN`	A constant which can be used with the lifecycle_details property of a OceInstanceSummary.
`LIFECYCLE_DETAILS_FAILOVER`	A constant which can be used with the lifecycle_details property of a OceInstanceSummary.
`LIFECYCLE_DETAILS_PRIMARY`	A constant which can be used with the lifecycle_details property of a OceInstanceSummary.
`LIFECYCLE_DETAILS_STANDBY`	A constant which can be used with the lifecycle_details property of a OceInstanceSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OceInstanceSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OceInstanceSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OceInstanceSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OceInstanceSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OceInstanceSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OceInstanceSummary.
`add_on_features`	Gets the add_on_features of this OceInstanceSummary.
`admin_email`	[Required] Gets the admin_email of this OceInstanceSummary.
`compartment_id`	[Required] Gets the compartment_id of this OceInstanceSummary.
`defined_tags`	Gets the defined_tags of this OceInstanceSummary.
`description`	Gets the description of this OceInstanceSummary.
`dr_region`	Gets the dr_region of this OceInstanceSummary.
`freeform_tags`	Gets the freeform_tags of this OceInstanceSummary.
`guid`	[Required] Gets the guid of this OceInstanceSummary.
`id`	[Required] Gets the id of this OceInstanceSummary.
`idcs_tenancy`	[Required] Gets the idcs_tenancy of this OceInstanceSummary.
`instance_access_type`	Gets the instance_access_type of this OceInstanceSummary.
`instance_license_type`	Gets the instance_license_type of this OceInstanceSummary.
`instance_usage_type`	Gets the instance_usage_type of this OceInstanceSummary.
`lifecycle_details`	Gets the lifecycle_details of this OceInstanceSummary.
`lifecycle_state`	Gets the lifecycle_state of this OceInstanceSummary.
`name`	[Required] Gets the name of this OceInstanceSummary.
`object_storage_namespace`	[Required] Gets the object_storage_namespace of this OceInstanceSummary.
`service`	Gets the service of this OceInstanceSummary.
`state_message`	Gets the state_message of this OceInstanceSummary.
`system_tags`	Gets the system_tags of this OceInstanceSummary.
`tenancy_id`	[Required] Gets the tenancy_id of this OceInstanceSummary.
`tenancy_name`	[Required] Gets the tenancy_name of this OceInstanceSummary.
`time_created`	Gets the time_created of this OceInstanceSummary.
`time_updated`	Gets the time_updated of this OceInstanceSummary.
`upgrade_schedule`	Gets the upgrade_schedule of this OceInstanceSummary.
`waf_primary_domain`	Gets the waf_primary_domain of this OceInstanceSummary.

Methods

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

INSTANCE_ACCESS_TYPE_PRIVATE = 'PRIVATE'¶: A constant which can be used with the instance_access_type property of a OceInstanceSummary. This constant has a value of “PRIVATE”

INSTANCE_ACCESS_TYPE_PUBLIC = 'PUBLIC'¶: A constant which can be used with the instance_access_type property of a OceInstanceSummary. This constant has a value of “PUBLIC”

INSTANCE_LICENSE_TYPE_BYOL = 'BYOL'¶: A constant which can be used with the instance_license_type property of a OceInstanceSummary. This constant has a value of “BYOL”

INSTANCE_LICENSE_TYPE_NEW = 'NEW'¶: A constant which can be used with the instance_license_type property of a OceInstanceSummary. This constant has a value of “NEW”

INSTANCE_LICENSE_TYPE_PREMIUM = 'PREMIUM'¶: A constant which can be used with the instance_license_type property of a OceInstanceSummary. This constant has a value of “PREMIUM”

INSTANCE_LICENSE_TYPE_STARTER = 'STARTER'¶: A constant which can be used with the instance_license_type property of a OceInstanceSummary. This constant has a value of “STARTER”

INSTANCE_USAGE_TYPE_NONPRIMARY = 'NONPRIMARY'¶: A constant which can be used with the instance_usage_type property of a OceInstanceSummary. This constant has a value of “NONPRIMARY”

INSTANCE_USAGE_TYPE_PRIMARY = 'PRIMARY'¶: A constant which can be used with the instance_usage_type property of a OceInstanceSummary. This constant has a value of “PRIMARY”

LIFECYCLE_DETAILS_DOWN = 'DOWN'¶: A constant which can be used with the lifecycle_details property of a OceInstanceSummary. This constant has a value of “DOWN”

LIFECYCLE_DETAILS_FAILOVER = 'FAILOVER'¶: A constant which can be used with the lifecycle_details property of a OceInstanceSummary. This constant has a value of “FAILOVER”

LIFECYCLE_DETAILS_PRIMARY = 'PRIMARY'¶: A constant which can be used with the lifecycle_details property of a OceInstanceSummary. This constant has a value of “PRIMARY”

LIFECYCLE_DETAILS_STANDBY = 'STANDBY'¶: A constant which can be used with the lifecycle_details property of a OceInstanceSummary. This constant has a value of “STANDBY”

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new OceInstanceSummary 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 OceInstanceSummary.
guid (str) – The value to assign to the guid property of this OceInstanceSummary.
description (str) – The value to assign to the description property of this OceInstanceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this OceInstanceSummary.
name (str) – The value to assign to the name property of this OceInstanceSummary.
tenancy_id (str) – The value to assign to the tenancy_id property of this OceInstanceSummary.
idcs_tenancy (str) – The value to assign to the idcs_tenancy property of this OceInstanceSummary.
tenancy_name (str) – The value to assign to the tenancy_name property of this OceInstanceSummary.
instance_usage_type (str) – The value to assign to the instance_usage_type property of this OceInstanceSummary. Allowed values for this property are: “PRIMARY”, “NONPRIMARY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
add_on_features (list[str]) – The value to assign to the add_on_features property of this OceInstanceSummary.
object_storage_namespace (str) – The value to assign to the object_storage_namespace property of this OceInstanceSummary.
admin_email (str) – The value to assign to the admin_email property of this OceInstanceSummary.
upgrade_schedule (str) – The value to assign to the upgrade_schedule property of this OceInstanceSummary.
waf_primary_domain (str) – The value to assign to the waf_primary_domain property of this OceInstanceSummary.
instance_access_type (str) – The value to assign to the instance_access_type property of this OceInstanceSummary. Allowed values for this property are: “PUBLIC”, “PRIVATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
instance_license_type (str) – The value to assign to the instance_license_type property of this OceInstanceSummary. Allowed values for this property are: “NEW”, “BYOL”, “PREMIUM”, “STARTER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this OceInstanceSummary.
time_updated (datetime) – The value to assign to the time_updated property of this OceInstanceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OceInstanceSummary. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this OceInstanceSummary. Allowed values for this property are: “STANDBY”, “FAILOVER”, “DOWN”, “PRIMARY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
dr_region (str) – The value to assign to the dr_region property of this OceInstanceSummary.
state_message (str) – The value to assign to the state_message property of this OceInstanceSummary.
service (dict(str, object)) – The value to assign to the service property of this OceInstanceSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OceInstanceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OceInstanceSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OceInstanceSummary.

add_on_features¶

Gets the add_on_features of this OceInstanceSummary. a list of add-on features for the ocm instance

Returns:	The add_on_features of this OceInstanceSummary.
Return type:	list[str]

admin_email¶

[Required] Gets the admin_email of this OceInstanceSummary. Admin Email for Notification

Returns:	The admin_email of this OceInstanceSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this OceInstanceSummary. Compartment Identifier

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

defined_tags¶

Gets the defined_tags of this OceInstanceSummary. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

description¶

Gets the description of this OceInstanceSummary. OceInstance description, can be updated

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

dr_region¶

Gets the dr_region of this OceInstanceSummary. disaster recovery paired ragion name

Returns:	The dr_region of this OceInstanceSummary.
Return type:	str

freeform_tags¶

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

guid¶

[Required] Gets the guid of this OceInstanceSummary. Unique GUID identifier that is immutable on creation

Returns:	The guid of this OceInstanceSummary.
Return type:	str

id¶

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

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

idcs_tenancy¶

[Required] Gets the idcs_tenancy of this OceInstanceSummary. IDCS Tenancy Identifier

Returns:	The idcs_tenancy of this OceInstanceSummary.
Return type:	str

instance_access_type¶

Gets the instance_access_type of this OceInstanceSummary. Flag indicating whether the instance access is private or public

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

Returns:	The instance_access_type of this OceInstanceSummary.
Return type:	str

instance_license_type¶

Gets the instance_license_type of this OceInstanceSummary. Flag indicating whether the instance license is new cloud or bring your own license

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

Returns:	The instance_license_type of this OceInstanceSummary.
Return type:	str

instance_usage_type¶

Gets the instance_usage_type of this OceInstanceSummary. Instance type based on its usage

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

Returns:	The instance_usage_type of this OceInstanceSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this OceInstanceSummary. Details of the current state of the instance lifecycle

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

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

lifecycle_state¶

Gets the lifecycle_state of this OceInstanceSummary. The current state of the instance lifecycle.

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 OceInstanceSummary.
Return type:	str

name¶

[Required] Gets the name of this OceInstanceSummary. OceInstance Name

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

object_storage_namespace¶

[Required] Gets the object_storage_namespace of this OceInstanceSummary. Object Storage Namespace of tenancy

Returns:	The object_storage_namespace of this OceInstanceSummary.
Return type:	str

service¶

Gets the service of this OceInstanceSummary. SERVICE data. Example: {“service”: {“IDCS”: “value”}}

Returns:	The service of this OceInstanceSummary.
Return type:	dict(str, object)

state_message¶

Gets the state_message of this OceInstanceSummary. An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:	The state_message of this OceInstanceSummary.
Return type:	str

system_tags¶

Gets the system_tags of this OceInstanceSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

tenancy_id¶

[Required] Gets the tenancy_id of this OceInstanceSummary. Tenancy Identifier

Returns:	The tenancy_id of this OceInstanceSummary.
Return type:	str

tenancy_name¶

[Required] Gets the tenancy_name of this OceInstanceSummary. Tenancy Name

Returns:	The tenancy_name of this OceInstanceSummary.
Return type:	str

time_created¶

Gets the time_created of this OceInstanceSummary. The time the the OceInstance was created. An RFC3339 formatted datetime string

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

time_updated¶

Gets the time_updated of this OceInstanceSummary. The time the OceInstance was updated. An RFC3339 formatted datetime string

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

upgrade_schedule¶

Gets the upgrade_schedule of this OceInstanceSummary. Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version

Returns:	The upgrade_schedule of this OceInstanceSummary.
Return type:	str

waf_primary_domain¶

Gets the waf_primary_domain of this OceInstanceSummary. Web Application Firewall(WAF) primary domain

Returns:	The waf_primary_domain of this OceInstanceSummary.
Return type:	str