Class OdaInstance

Description of OdaServiceInstance object.

Inheritance

object

OdaInstance

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 OdaInstance

Properties

AttachmentIds

Declaration

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

Property Value

Type	Description
List<string>	A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.

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). Use attachmentIds to get the details of the attachments.

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

ConnectorUrl

Declaration

[JsonProperty(PropertyName = "connectorUrl")]
public string ConnectorUrl { get; set; }

Property Value

Type	Description
string	URL for the connector's endpoint.

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. Avoid entering confidential information. 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 immutable identifier that was assigned when the instance was created.

Remarks

Required

IdentityAppConsoleUrl

Declaration

[JsonProperty(PropertyName = "identityAppConsoleUrl")]
public string IdentityAppConsoleUrl { get; set; }

Property Value

Type	Description
string	If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.

IdentityAppGuid

Declaration

[JsonProperty(PropertyName = "identityAppGuid")]
public string IdentityAppGuid { get; set; }

Property Value

Type	Description
string	If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant 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 Digital Assistant instance for users within the identity domain.

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.

ImportedPackageIds

Declaration

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

Property Value

Type	Description
List<string>	A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.

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). Use importedPackageIds field to get the details of the imported packages.

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

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OdaInstance.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
OdaInstance.LifecycleStateEnum?	The current state of the Digital Assistant instance.

LifecycleSubState

Declaration

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

Property Value

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

RestrictedOperations

Declaration

[JsonProperty(PropertyName = "restrictedOperations")]
public List<RestrictedOperation> RestrictedOperations { get; set; }

Property Value

Type	Description
List<RestrictedOperation>	A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.

ShapeName

Declaration

[Required(ErrorMessage = "ShapeName is required.")]
[JsonProperty(PropertyName = "shapeName")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OdaInstance.ShapeNameEnum? ShapeName { get; set; }

Property Value

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

Remarks

Required

StateMessage

Declaration

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

Property Value

Type	Description
string	A message that describes 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 Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.

WebAppUrl

Declaration

[JsonProperty(PropertyName = "webAppUrl")]
public string WebAppUrl { get; set; }

Property Value

Type	Description
string	URL for the Digital Assistant web application that's associated with the instance.