Class OdaInstanceSummary

Summary of the Digital Assistant instance.

Inheritance

object

OdaInstanceSummary

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 OdaInstanceSummary

Properties

AttachmentTypes

Declaration

[JsonProperty(PropertyName = "attachmentTypes")]
public List<string> AttachmentTypes { get; set; }

Property Value

Type	Description
List<string>	A list of attachment types for this instance (if any).

CompartmentId

Declaration

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

Property Value

Type	Description
string	Identifier of the compartment that the instance belongs to.

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-defined name for the Digital Assistant instance. You can change this value.

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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	Unique identifier of the Digital Assistant instance.

Remarks

Required

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.

ImportedPackageNames

Declaration

[JsonProperty(PropertyName = "importedPackageNames")]
public List<string> ImportedPackageNames { get; set; }

Property Value

Type	Description
List<string>	A list of package names imported into this instance (if any).

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)

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OdaInstanceSummary.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
OdaInstanceSummary.LifecycleStateEnum?	The current state of the instance.

Remarks

Required

LifecycleSubState

Declaration

[JsonProperty(PropertyName = "lifecycleSubState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OdaInstanceSummary.LifecycleSubStateEnum? LifecycleSubState { get; set; }

Property Value

Type	Description
OdaInstanceSummary.LifecycleSubStateEnum?	The current sub-state of the Digital Assistant instance.

ShapeName

Declaration

[JsonProperty(PropertyName = "shapeName")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OdaInstanceSummary.ShapeNameEnum? ShapeName { get; set; }

Property Value

Type	Description
OdaInstanceSummary.ShapeNameEnum?	Shape or size of the instance.

StateMessage

Declaration

[JsonProperty(PropertyName = "stateMessage")]
public string StateMessage { get; set; }

Property Value

Type	Description
string	A message describing the current state in more detail. For example, actionable information about an instance that's in the FAILED state.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	When the Digital Assistant instance was last updated. A date-time string as described in RFC 3339, section 14.29.