Show / Hide Table of Contents

Class CreateOdaInstanceDetails

Properties that are required to create a Digital Assistant instance.

Inheritance
object
CreateOdaInstanceDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.OdaService.Models
Assembly: OCI.DotNetSDK.Oda.dll
Syntax
public class CreateOdaInstanceDetails

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

Identifier of the compartment.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Description of the Digital Assistant instance.

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}

IdentityDomain

Declaration
[JsonProperty(PropertyName = "identityDomain")]
public string IdentityDomain { get; set; }
Property Value
Type Description
string

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.

IsRoleBasedAccess

Declaration
[JsonProperty(PropertyName = "isRoleBasedAccess")]
public bool? IsRoleBasedAccess { get; set; }
Property Value
Type Description
bool?

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)

ShapeName

Declaration
[Required(ErrorMessage = "ShapeName is required.")]
[JsonProperty(PropertyName = "shapeName")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateOdaInstanceDetails.ShapeNameEnum? ShapeName { get; set; }
Property Value
Type Description
CreateOdaInstanceDetails.ShapeNameEnum?

Shape or size of the instance.

Remarks

Required

In this article
Back to top