OpaInstance¶

class oci.opa.models.OpaInstance(**kwargs)¶

Bases: object

Description of OpaInstance.

Attributes

`CONSUMPTION_MODEL_GOV`	A constant which can be used with the consumption_model property of a OpaInstance.
`CONSUMPTION_MODEL_SAAS`	A constant which can be used with the consumption_model property of a OpaInstance.
`CONSUMPTION_MODEL_UCM`	A constant which can be used with the consumption_model property of a OpaInstance.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OpaInstance.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OpaInstance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OpaInstance.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OpaInstance.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OpaInstance.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a OpaInstance.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OpaInstance.
`METERING_TYPE_EMPLOYEE`	A constant which can be used with the metering_type property of a OpaInstance.
`METERING_TYPE_EXECUTION_PACK`	A constant which can be used with the metering_type property of a OpaInstance.
`METERING_TYPE_NAMED_USER`	A constant which can be used with the metering_type property of a OpaInstance.
`METERING_TYPE_USERS`	A constant which can be used with the metering_type property of a OpaInstance.
`SHAPE_NAME_DEVELOPMENT`	A constant which can be used with the shape_name property of a OpaInstance.
`SHAPE_NAME_PRODUCTION`	A constant which can be used with the shape_name property of a OpaInstance.
`attachments`	Gets the attachments of this OpaInstance.
`compartment_id`	[Required] Gets the compartment_id of this OpaInstance.
`consumption_model`	Gets the consumption_model of this OpaInstance.
`defined_tags`	Gets the defined_tags of this OpaInstance.
`description`	Gets the description of this OpaInstance.
`display_name`	[Required] Gets the display_name of this OpaInstance.
`freeform_tags`	Gets the freeform_tags of this OpaInstance.
`id`	[Required] Gets the id of this OpaInstance.
`identity_app_display_name`	Gets the identity_app_display_name of this OpaInstance.
`identity_app_guid`	Gets the identity_app_guid of this OpaInstance.
`identity_app_opc_service_instance_guid`	Gets the identity_app_opc_service_instance_guid of this OpaInstance.
`identity_domain_url`	Gets the identity_domain_url of this OpaInstance.
`instance_url`	Gets the instance_url of this OpaInstance.
`is_breakglass_enabled`	Gets the is_breakglass_enabled of this OpaInstance.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OpaInstance.
`metering_type`	Gets the metering_type of this OpaInstance.
`shape_name`	[Required] Gets the shape_name of this OpaInstance.
`system_tags`	Gets the system_tags of this OpaInstance.
`time_created`	[Required] Gets the time_created of this OpaInstance.
`time_updated`	Gets the time_updated of this OpaInstance.

Methods

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

CONSUMPTION_MODEL_GOV = 'GOV'¶: A constant which can be used with the consumption_model property of a OpaInstance. This constant has a value of “GOV”

CONSUMPTION_MODEL_SAAS = 'SAAS'¶: A constant which can be used with the consumption_model property of a OpaInstance. This constant has a value of “SAAS”

CONSUMPTION_MODEL_UCM = 'UCM'¶: A constant which can be used with the consumption_model property of a OpaInstance. This constant has a value of “UCM”

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

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

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

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

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

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

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

METERING_TYPE_EMPLOYEE = 'EMPLOYEE'¶: A constant which can be used with the metering_type property of a OpaInstance. This constant has a value of “EMPLOYEE”

METERING_TYPE_EXECUTION_PACK = 'EXECUTION_PACK'¶: A constant which can be used with the metering_type property of a OpaInstance. This constant has a value of “EXECUTION_PACK”

METERING_TYPE_NAMED_USER = 'NAMED_USER'¶: A constant which can be used with the metering_type property of a OpaInstance. This constant has a value of “NAMED_USER”

METERING_TYPE_USERS = 'USERS'¶: A constant which can be used with the metering_type property of a OpaInstance. This constant has a value of “USERS”

SHAPE_NAME_DEVELOPMENT = 'DEVELOPMENT'¶: A constant which can be used with the shape_name property of a OpaInstance. This constant has a value of “DEVELOPMENT”

SHAPE_NAME_PRODUCTION = 'PRODUCTION'¶: A constant which can be used with the shape_name property of a OpaInstance. This constant has a value of “PRODUCTION”

__init__(**kwargs)¶

Initializes a new OpaInstance 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 OpaInstance.
display_name (str) – The value to assign to the display_name property of this OpaInstance.
description (str) – The value to assign to the description property of this OpaInstance.
compartment_id (str) – The value to assign to the compartment_id property of this OpaInstance.
instance_url (str) – The value to assign to the instance_url property of this OpaInstance.
consumption_model (str) – The value to assign to the consumption_model property of this OpaInstance. Allowed values for this property are: “UCM”, “GOV”, “SAAS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
shape_name (str) – The value to assign to the shape_name property of this OpaInstance. Allowed values for this property are: “DEVELOPMENT”, “PRODUCTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
metering_type (str) – The value to assign to the metering_type property of this OpaInstance. Allowed values for this property are: “EXECUTION_PACK”, “USERS”, “EMPLOYEE”, “NAMED_USER”, ‘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 OpaInstance.
time_updated (datetime) – The value to assign to the time_updated property of this OpaInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OpaInstance. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
identity_app_guid (str) – The value to assign to the identity_app_guid property of this OpaInstance.
identity_app_display_name (str) – The value to assign to the identity_app_display_name property of this OpaInstance.
identity_domain_url (str) – The value to assign to the identity_domain_url property of this OpaInstance.
identity_app_opc_service_instance_guid (str) – The value to assign to the identity_app_opc_service_instance_guid property of this OpaInstance.
is_breakglass_enabled (bool) – The value to assign to the is_breakglass_enabled property of this OpaInstance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OpaInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OpaInstance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OpaInstance.
attachments (list[oci.opa.models.AttachmentDetails]) – The value to assign to the attachments property of this OpaInstance.

attachments¶

Gets the attachments of this OpaInstance. A list of associated attachments to other services

Returns:	The attachments of this OpaInstance.
Return type:	list[oci.opa.models.AttachmentDetails]

compartment_id¶

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

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

consumption_model¶

Gets the consumption_model of this OpaInstance. The entitlement used for billing purposes

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

Returns:	The consumption_model of this OpaInstance.
Return type:	str

defined_tags¶

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

description¶

Gets the description of this OpaInstance. Description of the Process Automation instance.

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

display_name¶

[Required] Gets the display_name of this OpaInstance. OpaInstance Identifier, can be renamed

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

freeform_tags¶

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

id¶

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

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

identity_app_display_name¶

Gets the identity_app_display_name of this OpaInstance. This property specifies the name of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain.

Returns:	The identity_app_display_name of this OpaInstance.
Return type:	str

identity_app_guid¶

Gets the identity_app_guid of this OpaInstance. This property specifies the GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user role mappings to grant access to this OPA instance for users within the identity domain.

Returns:	The identity_app_guid of this OpaInstance.
Return type:	str

identity_app_opc_service_instance_guid¶

Gets the identity_app_opc_service_instance_guid of this OpaInstance. This property specifies the OPC Service Instance GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain.

Returns:	The identity_app_opc_service_instance_guid of this OpaInstance.
Return type:	str

identity_domain_url¶

Gets the identity_domain_url of this OpaInstance. This property specifies the domain url of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain.

Returns:	The identity_domain_url of this OpaInstance.
Return type:	str

instance_url¶

Gets the instance_url of this OpaInstance. OPA Instance URL

Returns:	The instance_url of this OpaInstance.
Return type:	str

is_breakglass_enabled¶

Gets the is_breakglass_enabled of this OpaInstance. indicates if breakGlass is enabled for the opa instance.

Returns:	The is_breakglass_enabled of this OpaInstance.
Return type:	bool

lifecycle_state¶

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

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

metering_type¶

Gets the metering_type of this OpaInstance. MeteringType Identifier

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

Returns:	The metering_type of this OpaInstance.
Return type:	str

shape_name¶

[Required] Gets the shape_name of this OpaInstance. Shape of the instance.

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

Returns:	The shape_name of this OpaInstance.
Return type:	str

system_tags¶

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

time_created¶

[Required] Gets the time_created of this OpaInstance. The time when OpaInstance was created. An RFC3339 formatted datetime string

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

time_updated¶

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

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