Class EndpointSummary

Summary information for an endpoint resource.

Inheritance

object

EndpointSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaiService.Models

Assembly: OCI.DotNetSDK.Generativeai.dll

Syntax

public class EndpointSummary

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The compartment OCID to create the endpoint in.

Remarks

Required

ContentModerationConfig

Declaration

[JsonProperty(PropertyName = "contentModerationConfig")]
public ContentModerationConfig ContentModerationConfig { get; set; }

Property Value

Type	Description
ContentModerationConfig

DedicatedAiClusterId

Declaration

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

Property Value

Type	Description
string	The OCID of the dedicated AI cluster on which a model will be deployed 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>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

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

Property Value

Type	Description
string	An optional description of the endpoint.

DisplayName

Declaration

[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.

FreeformTags

Declaration

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

Id

Declaration

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

Property Value

Type	Description
string	An OCID that uniquely identifies this endpoint resource.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message describing the current state with detail that can provide actionable information.

LifecycleState

Declaration

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

Property Value

Type	Description
Endpoint.LifecycleStateEnum?	The current state of the endpoint. Allowed values are: ACTIVE CREATING UPDATING DELETING DELETED FAILED

Type

Description

Endpoint.LifecycleStateEnum?

The current state of the endpoint.
Allowed values are:

ACTIVE
CREATING
UPDATING
DELETING
DELETED
FAILED

Remarks

Required

ModelId

Declaration

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

Property Value

Type	Description
string	The OCID of the model that's used to create this endpoint.

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 that the endpoint was created in the format of an RFC3339 datetime string.

Remarks

Required

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the endpoint was updated in the format of n RFC3339 datetime string.