Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace EndpointSummary

Summary information for an endpoint resource.

Properties

compartmentId

compartmentId: string

The compartment OCID to create the endpoint in.

Optional contentModerationConfig

contentModerationConfig: model.ContentModerationConfig

dedicatedAiClusterId

dedicatedAiClusterId: string

The OCID of the dedicated AI cluster on which a model will be deployed to.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

An optional description of the endpoint.

Optional displayName

displayName: undefined | string

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

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

An OCID that uniquely identifies this endpoint resource.

Optional lifecycleDetails

lifecycleDetails: undefined | string

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

lifecycleState

lifecycleState: string

The current state of the endpoint.

Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED

modelId

modelId: string

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

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}

timeCreated

timeCreated: Date

The date and time that the endpoint was created in the format of an RFC3339 datetime string.

Optional timeUpdated

timeUpdated: Date

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

Functions

getDeserializedJsonObj

getJsonObj