CreateOdaInstanceDetails¶
- class oci.oda.models.CreateOdaInstanceDetails(**kwargs)¶
Bases:
objectProperties that are required to create a Digital Assistant instance.
Attributes:
A constant which can be used with the shape_name property of a CreateOdaInstanceDetails.
A constant which can be used with the shape_name property of a CreateOdaInstanceDetails.
[Required] Gets the compartment_id of this CreateOdaInstanceDetails.
Gets the defined_tags of this CreateOdaInstanceDetails.
Gets the description of this CreateOdaInstanceDetails.
Gets the display_name of this CreateOdaInstanceDetails.
Gets the freeform_tags of this CreateOdaInstanceDetails.
Gets the identity_domain of this CreateOdaInstanceDetails.
Gets the is_role_based_access of this CreateOdaInstanceDetails.
[Required] Gets the shape_name of this CreateOdaInstanceDetails.
Methods:
__init__(**kwargs)Initializes a new CreateOdaInstanceDetails object with values from keyword arguments.
- SHAPE_NAME_DEVELOPMENT = 'DEVELOPMENT'¶
A constant which can be used with the shape_name property of a CreateOdaInstanceDetails. This constant has a value of “DEVELOPMENT”
- SHAPE_NAME_PRODUCTION = 'PRODUCTION'¶
A constant which can be used with the shape_name property of a CreateOdaInstanceDetails. This constant has a value of “PRODUCTION”
- __init__(**kwargs)¶
Initializes a new CreateOdaInstanceDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
display_name (str) – The value to assign to the display_name property of this CreateOdaInstanceDetails.
description (str) – The value to assign to the description property of this CreateOdaInstanceDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateOdaInstanceDetails.
shape_name (str) – The value to assign to the shape_name property of this CreateOdaInstanceDetails. Allowed values for this property are: “DEVELOPMENT”, “PRODUCTION”
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOdaInstanceDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOdaInstanceDetails.
is_role_based_access (bool) – The value to assign to the is_role_based_access property of this CreateOdaInstanceDetails.
identity_domain (str) – The value to assign to the identity_domain property of this CreateOdaInstanceDetails.
- property compartment_id¶
[Required] Gets the compartment_id of this CreateOdaInstanceDetails. Identifier of the compartment.
- Returns
The compartment_id of this CreateOdaInstanceDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateOdaInstanceDetails. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this CreateOdaInstanceDetails.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CreateOdaInstanceDetails. Description of the Digital Assistant instance.
- Returns
The description of this CreateOdaInstanceDetails.
- Return type
str
- property display_name¶
Gets the display_name of this CreateOdaInstanceDetails. User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
- Returns
The display_name of this CreateOdaInstanceDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateOdaInstanceDetails. Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this CreateOdaInstanceDetails.
- Return type
dict(str, str)
- property identity_domain¶
Gets the identity_domain of this CreateOdaInstanceDetails. If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
- Returns
The identity_domain of this CreateOdaInstanceDetails.
- Return type
str
- property is_role_based_access¶
Gets the is_role_based_access of this CreateOdaInstanceDetails. Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
- Returns
The is_role_based_access of this CreateOdaInstanceDetails.
- Return type
bool
- property shape_name¶
[Required] Gets the shape_name of this CreateOdaInstanceDetails. Shape or size of the instance.
Allowed values for this property are: “DEVELOPMENT”, “PRODUCTION”
- Returns
The shape_name of this CreateOdaInstanceDetails.
- Return type
str