Show / Hide Table of Contents

Class AiDataPlatform

An AiDataPlatform is a unified platform for lifecycle management and governance of data and AI objects.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

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

Properties

AiDataPlatformType

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

The AiDataPlatform type.

Remarks

Required

AliasKey

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

The alias Id of the AiDataPlatform which is the short form of OCID.

CompartmentId

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

The OCID of the compartment.

Remarks

Required

CreatedBy

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

The OCID of the IAM user.

DefinedTags

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

DisplayName

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

A user-friendly name. Does not have to be unique, and it's changeable.

Remarks

Required

FreeformTags

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

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}

Remarks

Required

Id

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

The OCID of the AiDataPlatform.

Remarks

Required

LifecycleDetails

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

A message that describes the current state of the AiDataPlatform in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AiDataPlatform.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
AiDataPlatform.LifecycleStateEnum?

The current state of the AiDataPlatform.

Remarks

Required

SystemTags

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

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the AiDataPlatform was created, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the AiDataPlatform was updated, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z

WebSocketEndpoint

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

The WebSocket URL of the AiDataPlatform.

In this article
Back to top